Skip to main content

A package for refractive index values.

Project description

PyOptik is a powerful Python tool designed to import refractive indexes and extinction coefficients for various materials across different wavelengths. The data provided by PyOptik can be used in numerous applications, including simulating light interactions with particles. All data is sourced from the reputable RefractiveIndex.INFO database.

Logo

Testing

Unittest Status

Unittest coverage

Package

PyPi

PyPi_download

anaconda

Meta

python

Documentation Status

Features

  • Comprehensive Database Access: Seamlessly import refractive index and extinction coefficient data for a wide range of materials.

  • Simulation Ready: Ideal for light-matter interaction simulations, particularly in optics and photonics.

  • Simple API: Easy-to-use API that integrates well with other Python libraries.

  • Open Source: Fully open-source.

Installation

To install PyOptik, simply use pip or conda:

pip install PyOptik
conda install --channels martinpdes pyoptik

Simple Usage

After installing PyOptik, you can easily access material properties:

from PyOptik import Material

# Access the refractive index of BK7 glass
bk7 = Material.BK7
n = bk7.compute_refractive_index(0.55e-6)
print(f"Refractive index at 0.55 µm: {n}")

Example

Here is a quick example demonstrating how to use PyOptik to retrieve and plot the refractive index of a material:

import numpy as np
from PyOptik import Material

# Define wavelength range
wavelengths = np.linspace(0.3e-6, 2.5e-6, 100)

# Retrieve refractive index for BK7 glass
bk7 = Material.BK7
n_values = bk7.compute_refractive_index(wavelengths)

# Plot the results
bk7.plot()

This code produces the following figure:

example_bk7

You can also add a custom element to your library providing a URL from refractiveindex.info website.

from PyOptik.utils import download_yml_file
from PyOptik.directories import sellmeier_data_path  # or tabulated_data_path for tabulated elements

download_yml_file(
   filename='test',
   url='https://refractiveindex.info/database/data-nk/main/H2O/Daimon-19.0C.yml',
   location=tabulated_data_path
)

Evidently, you can also remove element from the library using as follows:

from PyOptik.utils import remove_element

remove_element(filename='test', location='any')  # location can be "any", "sellmeier" or "tabulated"

Testing

To test locally after cloning the GitHub repository, install the dependencies and run the tests:

git clone https://github.com/MartinPdeS/PyOptik.git
cd PyOptik
pip install .
pytest

Contributing

PyOptik is open to contributions. Whether you’re fixing bugs, adding new features, or improving documentation, your help is welcome! Please feel free to fork the repository and submit pull requests.

Contact Information

As of 2024, PyOptik is still under development. If you would like to collaborate, it would be a pleasure to hear from you. Contact me at:

Author: Martin Poinsinet de Sivry-Houle

Email: martin.poinsinet.de.sivry@gmail.com

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

pyoptik-1.7.0.post0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

PyOptik-1.7.0.post0-py3-none-any.whl (43.4 kB view details)

Uploaded Python 3

File details

Details for the file pyoptik-1.7.0.post0.tar.gz.

File metadata

  • Download URL: pyoptik-1.7.0.post0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for pyoptik-1.7.0.post0.tar.gz
Algorithm Hash digest
SHA256 9fda336e3b8eafe97acefc5164b9120550f03ac80f5cd289c7b6cd5ff415cd64
MD5 835c39f4203821dd0b58a83684d9ad0b
BLAKE2b-256 5fc4b25c0d99001bf1111c0ea85c54a2f97b80f5568aa3102a75e4befe7dd058

See more details on using hashes here.

File details

Details for the file PyOptik-1.7.0.post0-py3-none-any.whl.

File metadata

File hashes

Hashes for PyOptik-1.7.0.post0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f944bd833da7c244c1088c762f5d5026e2741a5c3996b7beb75adbc0dea9efa
MD5 9abf0306f88d199b273e523e22511ead
BLAKE2b-256 7c39fb63a26fc50fb4293b9d8e59abe91f69bab78324b99cdfc46aa5f57ac25c

See more details on using hashes here.

Supported by

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