[![tests](https://github.com/Ciela-Institute/caustic/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/Ciela-Institute/caustic/actions)
[![Docs](https://github.com/Ciela-Institute/caustic/actions/workflows/documentation.yaml/badge.svg)](https://github.com/Ciela-Institute/caustic/actions/workflows/documentation.yaml)
[![PyPI version](https://badge.fury.io/py/caustic.svg)](https://pypi.org/project/caustic/)
[![coverage](https://img.shields.io/codecov/c/github/Ciela-Institute/caustic)](https://app.codecov.io/gh/Ciela-Institute/caustic)
# 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:
```bash
pip install caustic
```
## Documentation
Please see our [documentation page](Ciela-Institute.github.io/caustic/) 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/).
Raw data
{
"_id": null,
"home_page": "https://github.com/Ciela-Institute/caustic",
"name": "caustic",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "gravitational lensing,astrophysics,differentiable programming,pytorch",
"author": "Ciela",
"author_email": "",
"download_url": "",
"platform": null,
"description": "[![tests](https://github.com/Ciela-Institute/caustic/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/Ciela-Institute/caustic/actions)\n[![Docs](https://github.com/Ciela-Institute/caustic/actions/workflows/documentation.yaml/badge.svg)](https://github.com/Ciela-Institute/caustic/actions/workflows/documentation.yaml)\n[![PyPI version](https://badge.fury.io/py/caustic.svg)](https://pypi.org/project/caustic/)\n[![coverage](https://img.shields.io/codecov/c/github/Ciela-Institute/caustic)](https://app.codecov.io/gh/Ciela-Institute/caustic)\n# caustic\n\nThe lensing pipeline of the future: GPU-accelerated, automatically-differentiable,\nhighly modular. Currently under heavy development: expect interface changes and\nsome imprecise/untested calculations.\n\n## Installation \n\nSimply install caustic from PyPI:\n```bash\npip install caustic\n```\n\n## Documentation\n\nPlease see our [documentation page](Ciela-Institute.github.io/caustic/) for more detailed information.\n\n## Contributing\n\nPlease reach out to one of us if you're interested in contributing!\n\nTo start, follow the installation instructions, replacing the last line with\n```bash\npip install -e \".[dev]\"\n```\nThis creates an editable install and installs the dev dependencies.\n\nSome guidelines:\n- Please use `isort` and `black` to format your code.\n- Use `CamelCase` for class names and `snake_case` for variable and method names.\n- Open up issues for bugs/missing features.\n- Use pull requests for additions to the code.\n- Write tests that can be run by [`pytest`](https://docs.pytest.org/).\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A gravitational lensing simulator for the future",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/Ciela-Institute/caustic"
},
"split_keywords": [
"gravitational lensing",
"astrophysics",
"differentiable programming",
"pytorch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "225ce212ef6660cb4a70e0a62ceeda897514bf4ee4c3aca668b6ce246447bde3",
"md5": "ec5d4fbeb7f6becb799f23e1683a89cb",
"sha256": "3fb8ea984b9f9a86fb5fd44e138986821ae55f51acb3d1e868cf6eacb6205987"
},
"downloads": -1,
"filename": "caustic-0.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec5d4fbeb7f6becb799f23e1683a89cb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 63088,
"upload_time": "2023-11-03T20:03:43",
"upload_time_iso_8601": "2023-11-03T20:03:43.758445Z",
"url": "https://files.pythonhosted.org/packages/22/5c/e212ef6660cb4a70e0a62ceeda897514bf4ee4c3aca668b6ce246447bde3/caustic-0.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 20:03:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ciela-Institute",
"github_project": "caustic",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "graphviz",
"specs": [
[
"==",
"0.20.1"
]
]
},
{
"name": "h5py",
"specs": [
[
">=",
"3.8.0"
]
]
},
{
"name": "levmarq_torch",
"specs": [
[
"==",
"0.0.1"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.23.5"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.8.0"
]
]
},
{
"name": "torch",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "astropy",
"specs": [
[
">=",
"5.2.1"
]
]
}
],
"lcname": "caustic"
}