pyathena

pyathena#

Jupyter Book Badge

About#

pyathena is a set of python scripts for reading and analyzing simulation data produced by the Athena-TIGRESS code.

Installation#

Below is an example of how you can set up pyathena. It assumes that you have already installed miniconda or anaconda on your system.

  1. Clone the pyathena repo

    git clone https://github.com/jeonggyukim/pyathena.git

  2. Create an environment from the env.yml file

    conda update conda # if you haven't already
conda env create -f path_to_pyathena/env.yml

  3. Activate the pyathena environment

    conda activate pyathena

  4. Add pyathena directory to your python startup file (optional but recommended).

Example Usage#

Will be added.

Contributing#

If you have a suggestion that would make pyathena better, please fork the repo and create a pull request. Don’t forget to give the project a star! Thanks again!

  1. Fork pyathena

  2. Create your feature branch (git checkout -b feature/AmazingFeature)

  3. Commit your changes (git commit -m 'Add some AmazingFeature')

  4. Push to the branch (git push origin feature/AmazingFeature)

  5. Open a Pull Request

References#

1

Chang-Goo Kim and Eve C. Ostriker. Three-phase Interstellar Medium in Galaxies Resolving Evolution with Star Formation and Supernova Feedback (TIGRESS): Algorithms, Fiducial Model, and Convergence. \apj , 846(2):133, September 2017. arXiv:1612.03918, doi:10.3847/1538-4357/aa8599.

Contents