heiplanet-models

Description

This repository consists of a collection of models that share the same infrastructure code, used for the heiplanet project

Installation

For usage

It is strongly recommended to use a virtual environment to install packages into. This will keep the package self-contained without its dependencies polluting the system, e.g. with python venv:

python3 -m venv .venv # creates a venv name 'venv' in a hidden directory on unix

source ./.venv/bin/activate # activate the environment

Then, install the package from pypi:

pip install heiplanet-models

In order to be able to visualize the computational graphs of the models you use or build, you need to install the package with the viz option. This will install the graphviz python package which will take care of the visualization.

pip install heiplanet-models[viz]

Note that if you are using zsh (default on macos), you need to add quotes

pip install "heiplanet-models[viz]"

Graphviz itself has additional dependencies it needs to install. For more details, see here.

For development

Clone the repository

git clone https://github.com/ssciwr/heiplanet-models.git

Create some virtual environment as described above. Then, go to the base directory of the repository, and run

pip install -e .

or including the graphviz dependency:

pip install -e .[viz]

again, you need to take care of shell specifics, e.g. on zsh:

pip install -e ".[viz]"

Please note the remark on graphviz's dependencies above.