Skip to content

lkies/corset

Repository files navigation

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:

pip install beam-corset

Documentation

The documentation is hosted on GitHub Pages: https://lkies.github.io/corset/

Contributing

TODO

Git Pre-Commit

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

About

Beam Corset - A Gaussian optics mode matching tool

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages