Metadata-Version: 2.1
Name: rayoptics
Version: 0.9.2
Summary: Tools for image forming optical design and analysis
Home-page: https://github.com/mjhoptics/ray-optics
Author: Michael J Hayford
Author-email: mjhoptics@gmail.com
License: BSD 3 Clause
Keywords: geometric optics, ray tracing, image forming optics,,paraxial optics, optical design, lens design,,aberrations, opd, psf
Platform: any
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: opticalglass >=1.0.8
Requires-Dist: numpy <2.0.0,>=1.26.4
Requires-Dist: scipy >=1.13.1
Requires-Dist: matplotlib >=3.8.4
Requires-Dist: pandas >=2.2.2
Requires-Dist: anytree >=2.8.0
Requires-Dist: parsimonious >=0.10.0
Requires-Dist: transforms3d >=0.4.1
Requires-Dist: requests >=2.32.3
Requires-Dist: packaging >=24.0
Requires-Dist: json-tricks >=3.17.3
Requires-Dist: deprecation >=2.1.0
Requires-Dist: ipywidgets >=8.1.3
Requires-Dist: pyqt5 <5.16
Requires-Dist: qdarkstyle <3.1.0,>=3.0.2
Requires-Dist: qtconsole <5.4.0,>=5.3.0
Requires-Dist: ipython >=8.25.0
Requires-Dist: traitlets >=5.14.3
Provides-Extra: testing
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'


.. image:: https://readthedocs.org/projects/ray-optics/badge/?version=latest
   :alt: ReadTheDocs
   :target: https://ray-optics.readthedocs.io/

.. image:: https://img.shields.io/pypi/v/rayoptics.svg
   :alt: PyPI-Server
   :target: https://pypi.org/project/rayoptics/

.. image:: https://img.shields.io/conda/vn/conda-forge/rayoptics.svg
   :alt: Conda-Forge
   :target: https://anaconda.org/conda-forge/rayoptics

==========
ray-optics
==========

Installation
------------

To install *rayoptics* using pip, use

.. code::

    > pip install rayoptics

Alternatively, *rayoptics* can be installed from the conda-forge channel using conda

.. code::

   > conda install rayoptics --channel conda-forge

Documentation
-------------

The documentation for *ray-optics* is hosted at `Read the Docs <https://ray-optics.readthedocs.io>`_

Tools for image forming optical design and analysis
---------------------------------------------------

RayOptics is a Python geometrical optics and image forming optics library. It provides a geometric ray tracing foundation for the analysis of image forming and coherent optical systems. A number of standard geometrical analysis options such as transverse ray and wavefront aberration analysis are provided on this base. Paraxial layout of optical systems is also supported by y-ybar diagrams and graphical editing of paraxial rays in lens layout views. Import of Zemax .zmx and CODEV .seq files is supported. RayOptics can be used in Python scripts, the Python and IPython shells, the Jupyter notebook, and a Qt-based graphical user interface application.

Getting Help
------------

Users of ray-optics are encouraged to post questions to the Discussions page of the Github repository. Please post any bug reports to the Issues page in the repo. The author welcomes questions and comments posted on Github and will try to be responsive. The author will not respond to emails with questions about ray-optics.

Note
----

This project has been set up using PyScaffold 4.3. For details and usage information on PyScaffold see https://pyscaffold.org/.
