Metadata-Version: 2.1
Name: Hyperion
Version: 0.9.11
Summary: Monte-Carlo Radiative Transfer Code
Home-page: http://www.hyperion-rt.org
Author: Thomas Robitaille
Author-email: thomas.robitaille@gmail.com
License: BSD
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.11
Requires-Dist: matplotlib>=1.5
Requires-Dist: astropy>=1.2
Requires-Dist: h5py>=2.4
Requires-Dist: decorator
Provides-Extra: recommended
Requires-Dist: yt>=3.2; extra == "recommended"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

About
-----

[![Continuous Integration](https://github.com/hyperion-rt/hyperion/actions/workflows/main.yml/badge.svg)](https://github.com/hyperion-rt/hyperion/actions/workflows/main.yml)
[![Documentation Status](https://readthedocs.org/projects/hyperion/badge/?version=stable)](http://docs.hyperion-rt.org/en/stable/?badge=stable)

Hyperion is a 3D Monte-Carlo radiation transfer code - see http://www.hyperion-rt.org
for more details.

Downloading
-----------

Stable releases can be found at:

    https://pypi.python.org/pypi/Hyperion/

To download from the git repository, use:

    git clone https://github.com/hyperion-rt/hyperion.git
    cd hyperion
    git submodule init
    git submodule update

Documentation
-------------

To build the HTML documentation:

    cd docs
    make html

The documentation will then be available at `docs/build/html`. Note that <a
href="http://sphinx-doc.org/">Sphinx</a> is required to build the documentation

Updating
--------

To update your clone of the git repository, use:

    git pull
    git submodule update

