Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.25 KB

README.md

File metadata and controls

33 lines (24 loc) · 1.25 KB

tests PyPI version coverage

caustic

The lensing pipeline of the future: GPU-accelerated, automatically-differentiable, highly modular. Currently under heavy development: expect interface changes and some imprecise/untested calculations.

Installation

Simply install caustic from PyPI:

pip install caustic

Documentation

Please see our documentation page for more detailed information.

Contributing

Please reach out to one of us if you're interested in contributing!

To start, follow the installation instructions, replacing the last line with

pip install -e ".[dev]"

This creates an editable install and installs the dev dependencies.

Please use isort and black to format your code. Open up issues for bugs/missing features. Use pull requests for additions to the code. Write tests that can be run by pytest.