dLuxToliman 0.1.1

A repo to hold the canonical dLux Toliman models.

dLuxToliman

Description

∂Lux is an open-source differentiable optical modelling framework harnessing the structural isomorphism between optical systems and neural networks, giving forwards models of optical system as a parametric neural network.

∂Lux is built in Zodiax which is an open-source object-oriented Jax framework built as an extension of Equinox for scientific programming. This framework allows for the creation of complex optical systems involving many planes, phase and amplitude screens in each, and propagate between them in the Fraunhofer or Fresnel regimes. This enables fast phase retrieval, image deconvolution, and hardware design in high dimensions. Because ∂Lux models are fully differentiable, you can optimize them by gradient descent over millions of parameters; or use Hamiltonian Monte Carlo to accelerate MCMC sampling. Our code is fully open-source under an MIT license, and we encourage you to use it and build on it to solve problems in astronomy and beyond.

Features

This package contains pre-built optical simulation models for the Toliman instrument.

Installation

dLuxToliman is pip-installable. To install the latest release, simply run:

pip install dLuxToliman

Usage # TODO: Update this section for dLux 13.0

Explain how users can import and use your package in their projects. Provide code examples or snippets if possible.

Contributing

Let users know how they can contribute to your package, report issues, or submit pull requests.

Limitations

Outline any known limitations or caveats that users should be aware of when using your package.

License

This package is released under the BSD 3-Clause License. See the LICENSE file for more information.

Documentation # TODO add

If you have additional documentation or resources, provide links or instructions for accessing them.

Support

If you encounter any problems or have any questions related to Toliman models, please contact me at [e-mail].