Metadata-Version: 2.4
Name: optisketch
Version: 0.0.3
Summary: a light raytracing library
Project-URL: homepage, https://github.com/kevinyamauchi/optisketch
Project-URL: repository, https://github.com/kevinyamauchi/optisketch
Author-email: Kevin Yamauchi <kevin.yamauchi@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE
License-File: NOTICE
License-File: licenses/optiland_license.txt
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: anywidget>=0.11.0
Requires-Dist: marimo>=0.23.8
Requires-Dist: matplotlib>=3.10.9
Requires-Dist: numpy>=2.4.6
Requires-Dist: scipy>=1.17.1
Provides-Extra: jax
Requires-Dist: jax>=0.4.0; extra == 'jax'
Requires-Dist: jaxlib>=0.4.0; extra == 'jax'
Description-Content-Type: text/markdown

# trace-light

[![License](https://img.shields.io/pypi/l/trace-light.svg?color=green)](https://github.com/kevinyamauchi/trace-light/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/trace-light.svg?color=green)](https://pypi.org/project/trace-light)
[![Python Version](https://img.shields.io/pypi/pyversions/trace-light.svg?color=green)](https://python.org)
[![CI](https://github.com/kevinyamauchi/trace-light/actions/workflows/ci.yml/badge.svg)](https://github.com/kevinyamauchi/trace-light/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/kevinyamauchi/trace-light/branch/main/graph/badge.svg)](https://codecov.io/gh/kevinyamauchi/trace-light)

a light raytracing library

> This library is heavily inspired by and in part derived from
> [Optiland](https://github.com/optiland/optiland) (MIT License).
> See [NOTICE](NOTICE) for details.

## Development

The easiest way to get started is to use the [github cli](https://cli.github.com)
and [uv](https://docs.astral.sh/uv/getting-started/installation/):

```sh
gh repo fork kevinyamauchi/trace-light --clone
# or just
# gh repo clone kevinyamauchi/trace-light
cd trace-light
uv sync
```

Run tests:

```sh
uv run pytest
```

Lint files:

```sh
uv run pre-commit run --all-files
```
