Skip to main content

Gradient Index (GRIN) Lens Calculations

Project description

A basic collection of routines to ray trace through graded index (GRIN) lenses with a parabolic radial profile.

pypi github conda doi

License Testing Docs Downloads

Try Online

full pitch lens

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

Try Online

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.

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

pygrin-0.6.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

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

pygrin-0.6.1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file pygrin-0.6.1.tar.gz.

File metadata

  • Download URL: pygrin-0.6.1.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pygrin-0.6.1.tar.gz
Algorithm Hash digest
SHA256 b2f4ed7b899cb204945fbbcd4f6d4b11e05d1266dbbc043474877be7f0728245
MD5 910b47fe5f83847e2e1821f35f452529
BLAKE2b-256 972f6993605bfdda31984f5df7d261cadd00b2e7977231aa121921e25964a100

See more details on using hashes here.

Provenance

The following attestation bundles were made for pygrin-0.6.1.tar.gz:

Publisher: pypi.yaml on scottprahl/pygrin

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

File details

Details for the file pygrin-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: pygrin-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pygrin-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bb790d8236a1e8ea73ab628da41863375d2fe3d073ff34de6ede7778d28e49f5
MD5 d814118a5bb0c205ea84de22b986d3ec
BLAKE2b-256 9f64133769be6559c3a7f97ab8dfc24dc4bb08082568fc7cd792e748e27e3796

See more details on using hashes here.

Provenance

The following attestation bundles were made for pygrin-0.6.1-py3-none-any.whl:

Publisher: pypi.yaml on scottprahl/pygrin

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