Installation Guide

Prerequisites

These are the dependencies required to run ExoNAMD:

These are the dependencies required to build the documentation:

The installation can be done using pip or poetry, see below.

pip install exonamd

Using Pip:

git clone https://github.com/abocchieri/ExoNAMD.git
cd ExoNAMD
pip install -e .

Using poetry:

pip install poetry
poetry install

Optional dependencies can be installed with the following command:

poetry install --with docs

To test for correct setup you can do

python -c "import exonamd; print(exonamd.__version__)"

If no errors appeared then it was successfully installed.

Additionally the ExoNAMD program should now be available in the command line

exonamd -h

ExoNAMD is installed in your system as a standard python package: you can uninstall it from your environment as

pip uninstall exonamd

If you have installed ExoNAMD using Pip, now you can update the package simply as

pip install exonamd --upgrade

If you have installed ExoNAMD from GitHub, you can download or pull a newer version of ExoNAMD over the old one.

Then you have to place yourself inside the installation directory with the console

cd /your_path/ExoNAMD

Now you can update ExoNAMD simply as

pip install . --upgrade

or simply

pip install .

You can modify the ExoNAMD main code, editing as you prefer, but in order to make the changes effective

pip install . --upgrade

or simply

pip install .

To produce new ExoNAMD functionalities and contribute to the code, please see Developer guide.