Metadata-Version: 2.4
Name: aurel
Version: 0.0.post4
Summary: A Python package for general relativity calculations.
Author-email: Robyn L Munoz <r.l.munoz@sussex.ac.uk>
License-Expression: GPL-3.0-or-later
Project-URL: Source, https://github.com/robynlm/aurel
Project-URL: Documentation, https://robynlm.github.io/aurel/
Keywords: numerical relativity,general relativity,simulation,Python,tensor
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: sympy
Requires-Dist: h5py
Requires-Dist: glob2
Requires-Dist: scipy
Requires-Dist: ipython
Requires-Dist: jax
Requires-Dist: jaxlib
Requires-Dist: spinsfast
Dynamic: license-file

<p align="left">
    <a href="https://robynlm.github.io/aurel/" target = "_blank">
    <img src="https://raw.githubusercontent.com/robynlm/aurel/refs/heads/main/docs/_static/aurel.png" width="250px" />
</a>
</p>

[![Python 3.8+](https://img.shields.io/badge/python-3.8%2B-blue)](https://www.python.org/)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Documentation](https://img.shields.io/badge/docs-available-blue)]()

`aurel` is a open source Python package for computing geometric and physical quantities in general relativity on a 3D spatial grid. It is designed to support both analytical and numerical spacetimes by providing an easy interface to *automatically calculate any relativistic term your heart desires*.

See the [documentation](https://robynlm.github.io/aurel/)

See the [`notebooks/Example.ipynb`](https://github.com/robynlm/aurel/blob/main/notebooks/Example.ipynb) for a full demonstration.

Also see [`notebooks/tov_ET.ipynb`](https://github.com/robynlm/aurel/blob/main/notebooks/tov_ET.ipynb) for a demonstration with numerical simulation output (e.g., Einstein Toolkit).
