refractiveindex


Namerefractiveindex JSON
Version 0.0.6 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2025-01-14 03:48:26
maintainerNone
docs_urlNone
authorIvan Toftul
requires_python<4.0,>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Easy Python interface to RefractiveIndex database

The original database<br>
https://github.com/polyanskiy/refractiveindex.info-database

Database files parsing was made with a modified version of `refractiveIndex.py` from [PyTMM project](https://github.com/kitchenknif/PyTMM) by [Pavel Dmitriev](https://github.com/kitchenknif).

## Installation

```
pip install refractiveindex
```

## Usage


```python
from refractiveindex import RefractiveIndexMaterial

SiO = RefractiveIndexMaterial(shelf='main', book='SiO', page='Hass')

wavelength_nm = 600  # [nm]

SiO.get_epsilon(wavelength_nm)
# (3.8633404437869827+0.003931076923076923j)

SiO.get_refractive_index(wavelength_nm)
# (1.96553846)

SiO.get_extinction_coefficient(wavelength_nm)
# (0.001)
```

Notes: 
- here the time dependence is assumed to be $\mathrm{e}^{-\mathrm{i} \omega t}$, so $\mathrm{Im}(\varepsilon) > 0$ is responsible for the losses.
- if there is a space in the name, one should write underscore instead of it, i.e. not `page='Rodriguez-de Marcos'` but `page='Rodriguez-de_Marcos'`.


## How to get material page names

You can find the proper “page” name by hovering your cursor on the link in the Data section

![How to get page name](./fig/link.png)

Or you can look up folders in this repository<br>
https://github.com/polyanskiy/refractiveindex.info-database

## Simular projects for Julia

Julia interface to refractiveindex.info database<br>
https://github.com/stillyslalom/RefractiveIndex.jl

## Possible problems

Refractive index changed naming in its database, please upgrade the package
```shell
pip install --upgrade refractiveindex
```
and remove database folder at `~/.refractiveindex.info-database`.

The database is currently limited to dispersion and extinction ('n-k') data.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "refractiveindex",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Ivan Toftul",
    "author_email": "toftul.ivan@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d7/5d/25cb4832ccdb5a403a5d9304792543c14d9f706ddd6c7758fe4071d6146b/refractiveindex-0.0.6.tar.gz",
    "platform": null,
    "description": "# Easy Python interface to RefractiveIndex database\n\nThe original database<br>\nhttps://github.com/polyanskiy/refractiveindex.info-database\n\nDatabase files parsing was made with a modified version of `refractiveIndex.py` from [PyTMM project](https://github.com/kitchenknif/PyTMM) by [Pavel Dmitriev](https://github.com/kitchenknif).\n\n## Installation\n\n```\npip install refractiveindex\n```\n\n## Usage\n\n\n```python\nfrom refractiveindex import RefractiveIndexMaterial\n\nSiO = RefractiveIndexMaterial(shelf='main', book='SiO', page='Hass')\n\nwavelength_nm = 600  # [nm]\n\nSiO.get_epsilon(wavelength_nm)\n# (3.8633404437869827+0.003931076923076923j)\n\nSiO.get_refractive_index(wavelength_nm)\n# (1.96553846)\n\nSiO.get_extinction_coefficient(wavelength_nm)\n# (0.001)\n```\n\nNotes: \n- here the time dependence is assumed to be $\\mathrm{e}^{-\\mathrm{i} \\omega t}$, so $\\mathrm{Im}(\\varepsilon) > 0$ is responsible for the losses.\n- if there is a space in the name, one should write underscore instead of it, i.e. not `page='Rodriguez-de Marcos'` but `page='Rodriguez-de_Marcos'`.\n\n\n## How to get material page names\n\nYou can find the proper \u201cpage\u201d name by hovering your cursor on the link in the Data section\n\n![How to get page name](./fig/link.png)\n\nOr you can look up folders in this repository<br>\nhttps://github.com/polyanskiy/refractiveindex.info-database\n\n## Simular projects for Julia\n\nJulia interface to refractiveindex.info database<br>\nhttps://github.com/stillyslalom/RefractiveIndex.jl\n\n## Possible problems\n\nRefractive index changed naming in its database, please upgrade the package\n```shell\npip install --upgrade refractiveindex\n```\nand remove database folder at `~/.refractiveindex.info-database`.\n\nThe database is currently limited to dispersion and extinction ('n-k') data.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.0.6",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e6957d07e53167807ee7cba697e96c2676821a7081d7bb0534721e15190c273d",
                "md5": "9a0b3dde16bbef1f0c9e9c1a47d612d6",
                "sha256": "baadb15a80dff7c5a3dd8f79a262f1e03dc5b7899b8b80ba51e8e27c85faea02"
            },
            "downloads": -1,
            "filename": "refractiveindex-0.0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9a0b3dde16bbef1f0c9e9c1a47d612d6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 6402,
            "upload_time": "2025-01-14T03:48:23",
            "upload_time_iso_8601": "2025-01-14T03:48:23.822960Z",
            "url": "https://files.pythonhosted.org/packages/e6/95/7d07e53167807ee7cba697e96c2676821a7081d7bb0534721e15190c273d/refractiveindex-0.0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d75d25cb4832ccdb5a403a5d9304792543c14d9f706ddd6c7758fe4071d6146b",
                "md5": "23636ff50aa44a7d93ae6ed5b45f45cf",
                "sha256": "20f064cbc7f53c5322fd300302754d61929a0cc4bd3e0f5fd1d864c6ebb5e1ee"
            },
            "downloads": -1,
            "filename": "refractiveindex-0.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "23636ff50aa44a7d93ae6ed5b45f45cf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 5457,
            "upload_time": "2025-01-14T03:48:26",
            "upload_time_iso_8601": "2025-01-14T03:48:26.625299Z",
            "url": "https://files.pythonhosted.org/packages/d7/5d/25cb4832ccdb5a403a5d9304792543c14d9f706ddd6c7758fe4071d6146b/refractiveindex-0.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-14 03:48:26",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "refractiveindex"
}
        
Elapsed time: 0.61882s