Metadata-Version: 2.1
Name: optika
Version: 0.0.6
Summary: A Python library for simulating optical systems, similar to Zemax
Author-email: "Roy T. Smart" <roytsmart@gmail.com>
Project-URL: Homepage, https://github.com/sun-data/optika
Project-URL: Documentation, https://optika.readthedocs.io/en/latest
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: astropy
Requires-Dist: named-arrays
Provides-Extra: doc
Requires-Dist: pytest ; extra == 'doc'
Requires-Dist: matplotlib ; extra == 'doc'
Requires-Dist: graphviz ; extra == 'doc'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'doc'
Requires-Dist: pydata-sphinx-theme ; extra == 'doc'
Requires-Dist: ipykernel ; extra == 'doc'
Requires-Dist: jupyter-sphinx ; extra == 'doc'
Requires-Dist: sphinx-favicon ; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

# optika

[![tests](https://github.com/sun-data/optika/actions/workflows/tests.yml/badge.svg)](https://github.com/sun-data/optika/actions/workflows/tests.yml)
[![codecov](https://codecov.io/gh/sun-data/optika/graph/badge.svg?token=tBcex8q72g)](https://codecov.io/gh/sun-data/optika)
[![Black](https://github.com/sun-data/optika/actions/workflows/black.yml/badge.svg)](https://github.com/sun-data/optika/actions/workflows/black.yml)
[![Documentation Status](https://readthedocs.org/projects/optika/badge/?version=latest)](https://optika.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/optika.svg)](https://badge.fury.io/py/optika)

A Python library for simulating optical systems, similar to Zemax.

## Installation

Optika can be installed using pip:

```bash
pip install optika
```

## Features
- Sequential raytrace modeling
- Spherical, conical and toroidal surface sag profiles
- Ruled surfaces, constant and variable line spacing
- Circular, rectangular, and polygonal apertures
- n-dimensional configurations of the optical system using [named-arrays](https://github.com/sun-data/named-arrays)
- uncertainity propagation using [named-arrays](https://github.com/sun-data/named-arrays)

## Example Gallery

An [example](https://optika.readthedocs.io/en/latest/_autosummary/optika.systems.SequentialSystem.html#optika.systems.SequentialSystem)
of how to raytrace a Newtonian telescope using Optika:

![Newtonian telescope example](https://optika.readthedocs.io/en/latest/_images/optika.systems.SequentialSystem_0_0.png)
