Skip to content

Ciela-Institute/caustics

Repository files navigation

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

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.

Some guidelines:

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