pygrin
A basic collection of routines to ray trace through graded index (GRIN) lenses with a parabolic radial profile.
Example
Properties of a 0.25 pitch GRIN lens from an ancient Melles Griot Catalog:
import pygrin
n = 1.608
gradient = 0.339
length = 5.37
diameter = 1.8
pitch = pygrin.period(gradient, length)
ffl = pygrin.FFL(n,pitch,length)
efl = pygrin.EFL(n,pitch,length)
na = pygrin.NA(n,pitch,length,diameter)
angle = pygrin.max_angle(n,pitch,length,diameter)
print('expected pitch = 0.29, calculated %.2f' % pitch)
print('expected FFL = 0.46 mm, calculated %.2f' % ffl)
print('expected NA = 0.46, calculated %.2f' % na)
print('expected full accept angle = 55°, calculated %.0f°' % (2*angle*180/np.pi))
print('working distance = %.2f mm'%(efl-ffl))
Produces:
expected pitch = 0.29, calculated 0.29 expected FFL = 0.46, calculated 0.47 expected NA = 0.46, calculated 0.46 expected full accept angle = 55°, calculated 55° working distance = 1.43 mm
But the real utility of this module is creating plots that show the path of rays through a GRIN lens. For examples, see <https://pygrin.readthedocs.io>
Installation
Use pip:
pip install pygrin
or conda:
conda install -c conda-forge pygrin
or use immediately in your browser via the JupyterLite button below
Citation
If you use pygrin in academic or technical work, please cite:
Prahl, S. (2025). pygrin: A Python module for ray tracing through gradient-index (GRIN) lenses (Version 0.6.0) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.8370821
BibTeX
@software{pygrin_prahl_2025,
author = {Scott Prahl},
title = {pygrin: A Python module for ray tracing through gradient-index (GRIN) lenses},
year = {2025},
version = {0.6.0},
doi = {10.5281/zenodo.8370821},
url = {https://github.com/scottprahl/pygrin},
publisher = {Zenodo}
}
License
pygrin is licensed under the terms of the MIT license.
Metadata
Release files for pygrin 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pygrin-0.6.1.tar.gz | 10.3 kB | With provenance | Details for pygrin-0.6.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pygrin-0.6.1-py3-none-any.whl | Python 3 | none | any | Details for pygrin-0.6.1-py3-none-any.whl |
Total release size: 17.5 kB
Release files / pygrin-0.6.1.tar.gz
| Download URL | pygrin-0.6.1.tar.gz |
|---|---|
| Size | 10.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b2f4ed7b899cb204945fbbcd4f6d4b11e05d1266dbbc043474877be7f0728245
|
|
BLAKE2b-256 checksum How to use checksums |
972f6993605bfdda31984f5df7d261cadd00b2e7977231aa121921e25964a100
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 5, 2026.
Transparency logRelease files / pygrin-0.6.1-py3-none-any.whl
| Download URL | pygrin-0.6.1-py3-none-any.whl |
|---|---|
| Size | 7.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bb790d8236a1e8ea73ab628da41863375d2fe3d073ff34de6ede7778d28e49f5
|
|
BLAKE2b-256 checksum How to use checksums |
9f64133769be6559c3a7f97ab8dfc24dc4bb08082568fc7cd792e748e27e3796
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 5, 2026.
Transparency logSecurity for pygrin 0.6.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for pygrin-0.6.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 5, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.