Skip to main content

Python interface for data on refractiveindex.info

Project description

PyPI - Version PyPI - Python Version GitHub Actions Workflow Status GitHub Actions Workflow Status Coverage Status

PyIndexRepo

This package gives access to the refractive index data from RefractiveIndex.info.

The focus of this package is to provide a convenient interface to the data, and be efficient in the calculation of (temperature-dependent) refractive indices.

Usage

Basics

from pyindexrepo import RefractiveIndexLibrary

db = RefractiveIndexLibrary(auto_upgrade=True)
bk7 = db.search_material_by_page_name('N-BK7')[0]  # returns a list of different BK7 glasses
print(bk7.get_n(0.5875618))

When executed for the first time, the database from the RefractiveIndex Github Repo will be downloaded and converted to a python object. This process takes a few minutes. Consecutive calls will load the database object from a local file (almost instantaneously).

Auto-upgrade of the library is supported, but switched off by default.

There are two main classes that allow interacting with the data: the RefractiveIndexLibrary class and the Material class.

Temperature data

When temperature data is available, the refractive index of a material can be queried at any temperature within the valid temperature range:

import numpy as np
from pyindexrepo import RefractiveIndexLibrary

db = RefractiveIndexLibrary(auto_upgrade=True)
bk7 = db.search_material_by_page_name('N-BK7')[0]  # returns a list of different BK7 glasses
wl = np.linspace(0.4, 0.7, 10000)
print(bk7.get_n_at_temperature(wl, temperature=30))
[1.53088657 1.53088257 1.53087857 ... 1.51309187 1.51309107 1.51309027]

Installation

pip install pyindexrepo

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

pyindexrepo-0.1.6.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyindexrepo-0.1.6-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file pyindexrepo-0.1.6.tar.gz.

File metadata

  • Download URL: pyindexrepo-0.1.6.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for pyindexrepo-0.1.6.tar.gz
Algorithm Hash digest
SHA256 a9e7e234dd9002ce328083043f45a8116f387eafdaccc3cfba49be419a84126a
MD5 4273bc3e175b9c2c2521dc7bed056fb6
BLAKE2b-256 34c4f403fa847b626bd29ea1f780617e728210ec8a9fdbeeb9926b3ab6b5bcee

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyindexrepo-0.1.6.tar.gz:

Publisher: release.yaml on Stuermer/PyIndexRepo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyindexrepo-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: pyindexrepo-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for pyindexrepo-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f25241f7faab893201e80b02a0a85da2c757ce9d1bd4ba9aa9ab67138c92defe
MD5 483d478efe0816b11510e5ed6c10e47c
BLAKE2b-256 845c0d116929a9976e35fb58f47f9886271f60fb8bd65598344fbaad23c1faaa

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyindexrepo-0.1.6-py3-none-any.whl:

Publisher: release.yaml on Stuermer/PyIndexRepo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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