https://github.com/jtambasco/opticalmaterialspy
Python library with optical material properties.
https://github.com/jtambasco/opticalmaterialspy
Last synced: 29 days ago
JSON representation
Python library with optical material properties.
- Host: GitHub
- URL: https://github.com/jtambasco/opticalmaterialspy
- Owner: jtambasco
- License: mit
- Created: 2016-12-26T00:08:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-14T17:48:31.000Z (over 1 year ago)
- Last Synced: 2025-04-14T07:54:51.949Z (about 2 months ago)
- Language: Python
- Size: 40 KB
- Stars: 28
- Watchers: 4
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# opticalmaterialspy
Python library with optical material properties.
The documentation can be found [here](http://opticalmaterialspy.readthedocs.io/).
This library provides a common interface to access the optical properties of materials. The main optical properties include:
* permittivity (and derivatives with respect to wavelength),
* refractive index (and derivatives with respect to wavelength),
* group velocity and group velocity refractive index,
* group velocity refractive index, and
* group velocity dispersion.
All properties are calculate from the Sellmeier equation of the material. In order to access all the above properties, minimally, the Sellmeier equation of the desired material should be added (if it isn't already). Many materials already exist as an example. The library can also use any material from [refractiveindex.info](https://refractiveindex.info/) by simply using the weblink of the desired material.
## Installation
There are two main ways to install `opticalmaterialspy`.
* pip: `pip3 install opticalmaterialspy` or `pip2 install opticalmaterialspy`
* Arch Linux: `yaourt -S python-opticalmaterialspy`
### Dependencies
If installing using the [Arch Linux AUR package](https://aur.archlinux.org/packages/python-opticalmaterialspy/) or via `pip`, dependencies will be automatically downloaded and installed; otherwise, one should ensure the following dependencies are installed:
* [setuptools](https://pypi.python.org/pypi/setuptools),
* [numpy](http://www.numpy.org/), and
* [scipy](https://www.scipy.org/).
## Features
The main reasons to consider this library include:
* generic and simple interface for all materials,
* interfaces easily with [refractiveindex.info](https://refractiveindex.info/),
* adding a new material only requires implementing one function,
* there is already a class written to generically accept a material from a text file, and
* intelligently works out what units the wavelengths being used are (see example).
## Examples
### Example 1: Optical parameters for SiO2
#### Python Script
```python
import opticalmaterialspy as mat
m = mat.SiO2()
# Or to use SiO2 from refractiveindex.info...
# m = mat.RefractiveIndexWeb('https://refractiveindex.info/?shelf=main&book=SiO2&page=Malitson')
# Refractive index @ 1550nm.
print('n(1.55e-6m):', m.n(1.55e-6)) # Knows 1.55e-6 must be [m].
print('n(1.55um):', m.n(1.55)) # Knows 1.55 must be [um].
print('n(1550nm):', m.n(1550)) # Knows 1550 must be [nm].
# Group velocity refractive index @ 900nm.
print('n_gv(900nm):', m.ng(900))
# Group velocity dispersion @ 808nm.
print('GVD(0.808um):', m.gvd(0.808))
```
#### Output
```
n(1.55e-6m): 1.4440236217
n(1.55um): 1.4440236217
n(1550nm): 1.4440236217
n_gv(900nm): 1.46462460402
GVD(0.808um): 3.59254440673e-26
```
## Contributions
If you add functionality, especially new materials, I'd appreciate you send me a pull request, or email the code to me so we can all benefit.