API reference#

Use this reference for signatures, parameters, units, and return types. Start with the Quick start for working examples or the User guide for the models and their validation.

Core#

The curated records, their vocabulary and materials, states and wavelengths, and model identity. See Foundations for conventions and The data for the data records.

optmat.conditions

States (pressure and temperature) and air-to-vacuum wavelengths.

optmat.constants

Physical constants and unit conversions, SI throughout.

optmat.datasets

Curated datasets: literature values with their provenance and conditions.

optmat.exceptions

The package's exception and warning hierarchy.

optmat.identity

The identity of a model: a digest of what it evaluates, and its status.

optmat.materials

The materials the curated records name.

optmat.vocabulary

The vocabulary of the curated data: quantities, abscissae, parts, conventions.

Gases#

The user guide covers gas dispersion and absorption, nonlinear and Raman response, and ionisation.

optmat.gas

The gases: curated data and models of their optical response.

Solids#

See Solids for the common interface and the material-specific models and their sources.

optmat.solid

Solids: glasses, crystals and metals (TC-318).