Metadata-Version: 2.1
Name: caustics
Version: 0.5.0
Summary: A gravitational lensing simulator for the future
Home-page: https://github.com/Ciela-Institute/caustics
Author: Ciela
License: MIT license
Keywords: gravitational lensing,astrophysics,differentiable programming,pytorch
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: graphviz (==0.20.1)
Requires-Dist: h5py (>=3.8.0)
Requires-Dist: levmarq-torch (==0.0.1)
Requires-Dist: numpy (>=1.23.5)
Requires-Dist: scipy (>=1.8.0)
Requires-Dist: torch (>=2.0.0)
Requires-Dist: astropy (>=5.2.1)
Provides-Extra: dev
Requires-Dist: lenstronomy (==1.11.1) ; extra == 'dev'
Requires-Dist: setuptools (>=67.2.0) ; extra == 'dev'

[![tests](https://github.com/Ciela-Institute/caustics/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/Ciela-Institute/caustics/actions)
[![Docs](https://github.com/Ciela-Institute/caustics/actions/workflows/documentation.yaml/badge.svg)](https://github.com/Ciela-Institute/caustics/actions/workflows/documentation.yaml)
[![PyPI version](https://badge.fury.io/py/caustics.svg)](https://pypi.org/project/caustics/)
[![coverage](https://img.shields.io/codecov/c/github/Ciela-Institute/caustics)](https://app.codecov.io/gh/Ciela-Institute/caustics)
# caustics

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 caustics from PyPI:
```bash
pip install caustics
```

## Documentation

Please see our [documentation page](Ciela-Institute.github.io/caustics/) 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
```bash
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`](https://docs.pytest.org/).
