PyOptik 1.1.6.post0

A package for refractive index values.

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.

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:

pip install pyoptik

Usage

After installing PyOptik, you can easily access material properties:

from PyOptik import UsualMaterial

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

# Accessing and plotting material properties
bk7.plot(wavelength_range=[0.3e-6, 2.5e-6])

Example

Here’s 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 UsualMaterial

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

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

# Plot the results
bk7.plot(wavelength_range=wavelengths)

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: [e-mail]