Installing POSYDON v1.0.0 from Anaconda

We recommend to install the Python distribution Anaconda and to install POSYDON in a virtual environment. Specifically, we recommend using the installation we have provided which can be accessed through conda-forge. On Linux, the new conda environment can be created (we have named our environment posydon-example, but you can choose any name), the conda-forge channel added, and the required library installation can all be completed in one line:

conda create --name posydon-example -c posydon -c conda-forge posydon

On Mac (or if you have problems with the above command on Linux), these steps likely need to be separately run:

conda create -n posydon-conda python=3.7
conda activate posydon-conda
conda config --add channels conda-forge
conda config --add channels posydon
conda config --set channel_priority false
conda install posydon

Now, you can source the environment with

conda activate posydon

Installing the latest release from GitHub

Creating a conda environment

We recommend to install the Python distribution Anaconda and to install POSYDON in a virtual environment. After creating the environment (you can choose any name, e.g., posydon, or posydon_env) like this:

conda create -n posydon python=3.7

Make sure you agree to any questions about installing required libraries. To proceed with the installation, we will need to activate the environment:

conda activate posydon


Clone the repository in a local directory, e.g. /home/POSYDON/, with

git clone

The directory will contain the following structure:


Installing POSYDON

Exporting the global path

Export the path to the cloned POSYDON code (you can add this line to your .bashrc or .bash_profile.), e.g.


Installing the package

From the cloned POSYDON directory execute the commands to install POSYDON and the mpi4py dependency

pip install -e .
conda install mpi4py

Downloading POSYDON data

OPTION 1: Zenodo (latest official version)

Export the path to where you want to clone the data, e.g. /home/, and download the data with the following commands

export PATH_TO_POSYDON_DATA=/home/

OPTION 2: git LFS submodule (latest development version)

Inside the cloned POSYDON repository run the following commands to install and initialise git LFS, and download the data.

conda install git-lfs
git lfs install
git submodule init
git submodule update data/POSYDON_data

Installing POSYDON documentations modules

These modules are needed in order to compile the documentation

pip install -e .[doc]

To compile the documentation and open the html page do the following

cd docs/
make html
open _build/html/index.html

Installation Notes/FAQ



Please note that using the global instance of the conda jupyter-notebook or ipython will most likely fail when trying to use posydon. PLEASE explicitly install both into the posydon environment with either

conda install jupyter ipython

pip install jupyter ipython