Getting Started

Tutorials, including command by command guides with explanations, can be found in acheron/tutorials

Cloning acheron

We first need to download acheron, if you haven't done so yet, you can do this by running git clone https://github.com/superphy/acheron.git

Next, we move into acheron using cd acheron

Conda

acheron requires the conda package manager

First, Download anaconda or miniconda (python 3.7), instructions for that are here

Install the conda dependencies by running conda env create -f data/envi.yaml

The name of the conda environment can be found in the first line of data/envi.yaml , currently it is ach.0.5

We can now activate this conda environment by running source activate ach.0.5

You will need to be in this environment when using acheron

Installing acheron

You can install acheron by running pip install -e . while in the conda environment

To verify everything is working, you can run pytest tests/

Get Going!

You are now ready to start using acheron, type acheron -h or visit the other wiki pages to get started!