Installation

Note

The standard way of installing this version of Aragog is within the PROTEUS Framework, as described in the PROTEUS installation guide.

Quick install

The basic procedure is to install Aragog into a Python environment. For example, if you are using a Conda distribution to create and manage Python environments (e.g. Anaconda), create a new environment noting that Aragog requires Python >= 3.10. Once created, make sure to activate the environment. To achieve this, terminal commands are given below, but you can also use the Anaconda Navigator (or similar GUI) to create and activate environments:

conda create -n aragog python
conda activate aragog

Alternatively, you can create and activate a virtual environment.

Finally, install Aragog into the activated environment:

pip install aragog

Developer install

Navigate to a location on your computer and obtain the source code using git:

git clone git@github.com:FormingWorlds/aragog.git aragog
cd aragog

Install Aragog into the environment using either: (a) Poetry, or (b) pip.

There are some subtle differences between Poetry and pip, but in general Aragog is configured to be interoperable for most common operations (e.g. see this Gist).

(a) Poetry option, which requires that Poetry is installed:

poetry install --with docs

(b) pip option, where the -e option is for an editable install:

pip install -e ".[docs]"

If desired, you will need to manually install the dependencies for the tests, which are automatically installed by Poetry but not by pip. See the additional dependencies to install in pyproject.toml.

More comprehensive set up guides are available here:

• VS Code and Poetry guide
• Windows and Spyder guide

Download data from the OSF repository

Aragog requires lookup table data storing thermophysics properties of the liquid and solid matter. These data are stored in the OSF repository. You can download it with the command:

aragog download all

The command aragog env will give you the path where the data have been downloaded. If you want to setup your own path, setup the environment variable FWL_DATA before running the download command:

export FWL_DATA=your_absolute_path/