Metadata-Version: 2.4
Name: lightcone_io
Version: 0.5.0
Summary: Module for reading SWIFT lightcone output.
Author-email: John Helly <j.c.helly@durham.ac.uk>
Project-URL: Homepage, https://github.com/jchelly/LightconeIO
Project-URL: Repository, https://github.com/jchelly/LightconeIO.git
Project-URL: Issues, https://github.com/jchelly/LightconeIO/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: h5py
Requires-Dist: numpy
Requires-Dist: unyt>=3.0
Requires-Dist: healpy
Requires-Dist: scipy
Requires-Dist: tqdm
Requires-Dist: pytest
Provides-Extra: mpi
Requires-Dist: mpi4py; extra == "mpi"
Requires-Dist: virgodc>=1.0.1; extra == "mpi"

# Lightcone I/O for SWIFT

This is a python module for reading lightcone output from SWIFT simulations.

The source code and issue tracker are hosted on github:
https://github.com/jchelly/LightconeIO

Releases are hosted on pypi: https://pypi.org/project/lightcone-io/

For documentation see: https://lightconeio.readthedocs.io/en/latest/

## Installation

For read-only use without MPI support, the module can be installed using pip:
```
pip install lightcone_io
```

## Building the documentation

The documentation is built using sphinx:
```
pip install sphinx sphinx-rtd-theme sphinx-autodoc-typehints
cd docs
make html
```

## Running unit tests

There are a few unit tests which can be run with just
```
pytest
```
in the source code directory. Note that test coverage is currently
very poor!
