Metadata-Version: 2.4
Name: beam-corset
Version: 0.1.0
Summary: Beam Corset is a Gaussian optics mode matching tool made for use in Jupyter notebooks.
Project-URL: Source, https://github.com/lkies/corset
Project-URL: Documentation, https://lkies.github.io/corset
Author-email: Lorenz Kies <dev@lkies.net>
License-Expression: BSD-3-Clause
License-File: LICENSE
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Requires-Dist: matplotlib<4,>=3.10.7
Requires-Dist: numpy<3,>=2.3.4
Requires-Dist: pandas<3,>=2.3.3
Requires-Dist: scipy<2,>=1.16.3
Description-Content-Type: text/markdown

# Beam Corset

Beam Corset is a Gaussian optics mode matching tool made for use in Jupyter notebooks.

## Key Features

- Lens placement in multiple shifting regions
- Ensure minimal distances between lenses
- Constrain beam radius to ensure the beam fits through apertures
- Account for existing fixed lenses
- Detailed reachability and sensitivity analysis of solutions

## Installation

Install from PyPI:

```shell
pip install beam-corset
```

Note: the package is published on PyPI as `beam-corset`, but you still import it in Python as `import corset`.

## Documentation

The documentation is hosted on GitHub Pages: [https://lkies.github.io/corset/](https://lkies.github.io/corset/)

## Contributing

TODO

### Git Pre-Commit

```shell
git config filter.strip-notebook-output.clean 'pixi run -e dev jupyter nbconvert --ClearOutputPreprocessor.enabled=True --to=notebook --stdin --stdout --log-level=ERROR'
git config filter.strip-notebook-output.smudge cat
git config filter.strip-notebook-output.required true
```
