Skip to main content

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

Reason this release was yanked:

not importable on some versions due to cyclical import

Project description

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

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/

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beam_corset-0.1.0.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beam_corset-0.1.0-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

Details for the file beam_corset-0.1.0.tar.gz.

File metadata

  • Download URL: beam_corset-0.1.0.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for beam_corset-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a5cf5b71c6531a777e321c07e6a43a2c18312d12cf0e1faec7ae9743acc43334
MD5 c48085c65bb5ab44819fd585a9b49271
BLAKE2b-256 97435bbbe6300c845a9ac99fa45b81d1130fedc07e37020bcd5aad4010f35976

See more details on using hashes here.

File details

Details for the file beam_corset-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: beam_corset-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 25.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for beam_corset-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b0ecb40ab3a3f8b4d607849a9e1605e708cb78ab0a6d8f27a8a5e3a3cffc50c4
MD5 4e6c1b678fdf6bff24c2cf39962452f9
BLAKE2b-256 77132584a733760ac4094d567bf0fe0d09f3474a49b2896a2368e4933b2dd632

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page