Skip to main content

Python 3 + Pandas wrapper for the refractiveindex.info database

Project description

RII_Pandas (refractiveindex.info-pandas)

PyPI version Anaconda Version Lint and Test

Python 3 + Pandas wrapper for the refractiveindex.info database developed by Mikhail Polyanskiy.

Pandas DataFrame creation was made with modified versions of dboperations.py from refractiveindex.info-sqlite package developed by Hugo Guillén.

Features

  • Create Pandas DataFrame by parsing database files cloned from Polyanskiy's GitHub repository.
  • Drude-Lorentz model (formula 21) and Brendel-Bormann model (formula 22) are available to describe metallic dielectric function.

Install

Install and update using pip

$ pip install -U riip

Install using conda

$ conda install -c mnishida riip

Usage

>>> import riip
>>> ri = riip.RiiDataFrame()

Polyanskiy's 'refractiveindex.info database' is cloned from GitHub repository, and three csv files, 'catalog.csv', 'raw_data.csv' and 'grid_data.csv' are created. They are located in 'data' folder under the installation directory. This process may take a few minutes, but it will happen only the first time you start it after installation.

>>> ri.search("Al")                      # search material contains the string
>>> ri.select(
      "2.5 < n < 3 and 0.4 < wl < 0.8"
    )                                    # select materials that fullfill the condition
>>> print(ri.show([23, 118]))            # show catalog
>>> print(ri.read(23))                   # read the data book
>>> ri.references(23)                    # see references
>>> ri.plot(23, "n")                     # plot wavelength dependence of refractive index

>>> Al = ri.material(
  {"book": "Al", "page": "Mathewson"})   # create material with book and page
>>> Al = ri.material({"id": 23})         # create material with id number

It may not be safe to use "id" in your application importing this package. The id number may be changed when an update is done on your local database.

>>> import numpy as np
>>> wls = np.linspace(0.5, 1.6)          # wavelength from 0.5 μm to 1.6 μm
>>> Al.n(wls)                            # refractive index
>>> Al.k(wls)                            # extinction coefficient
>>> Al.eps(wls)                          # complex permittivity

For more information, see RII_Pandas User's Guide.

Update database

If refractiveindex.info database is updated, you can pull it to the local database by

>>> import riip
>>> ri = riip.RiiDataFrame()
>>> ri.update_db()

Uninstall

$ pip uninstall riip

or

$ conda uninstall riip

Dependencies

  • python 3
  • numpy
  • scipy
  • pandas
  • pyyaml
  • gitpython

Version

0.8.1

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

riip-0.8.1.tar.gz (592.9 kB view details)

Uploaded Source

File details

Details for the file riip-0.8.1.tar.gz.

File metadata

  • Download URL: riip-0.8.1.tar.gz
  • Upload date:
  • Size: 592.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for riip-0.8.1.tar.gz
Algorithm Hash digest
SHA256 468b7740d8e1889fd175ced94d27779305dadc0b6a38745d16ff2ce448f063b3
MD5 d2c67573296d448adfd7d57f0eac151f
BLAKE2b-256 d207446dea6c049ab9f0c67459805cae452a5bfe5067644b112174ee801230c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page