Installation & updates

These notes walk you through installing ExoSim inside a Python virtual environment. You need Python and pip already installed; ask your system administrator if you have to add them.

Note

ExoSim 2 requires Python 3.12 or newer.

Create the virtual environment

You can create the virtual environment either with Anaconda or with a standard Python installation.

Tip

The Anaconda solution is cross-platform: the instructions below work on Windows, macOS, and Linux.

Anaconda

Assuming Anaconda is installed on your system, open the Anaconda command shell (on a Unix system, just open a terminal).

Create the virtual environment with:

conda create --name ExoSimVE python=3.12

The installer asks whether you want to install some standard packages: accept them.

You can then activate or deactivate the virtual environment with:

conda activate ExoSimVE
conda deactivate

Python venv

With a standard Python installation you can still work in a virtual environment, but you need Python virtualenv installed. On Linux:

mkdir ExoSimVE
virtualenv -p /usr/bin/python3.12 ExoSimVE

Then activate the virtual environment. With csh, type:

source ExoSimVE/bin/activate.csh

(see the virtualenv documentation for other shells).

If you would rather not use a virtual environment, see What if I don’t want to create a Python virtual environment?.

Install the ExoSim package

Install ExoSim

Install from PyPI

ExoSim is published on PyPI. Install it with:

pip install exosim

Install from Git

Clone ExoSim from the main Git repository:

git clone https://github.com/arielmission-space/ExoSim2-public.git

Move into the ExoSim folder:

cd /your_path/ExoSim2.0

ExoSim uses uv for dependency management and package installation. If you do not have uv yet, install it by following the official uv documentation.

Once uv is available, install ExoSim with its development dependencies:

uv sync --extra dev

To check that the installation succeeded, run:

python -c "import exosim"

If no error is raised, ExoSim was installed correctly. The exosim command is now also available on the command line:

exosim

Uninstall ExoSim

ExoSim is installed as a standard Python package, so you can remove it from your environment with:

pip uninstall exosim

Upgrade ExoSim

Upgrade from PyPI

If you installed ExoSim from PyPI, update it with:

pip install exosim --upgrade

Upgrade from Git

If you installed ExoSim from Git, pull the latest version over the old one, then move into the installation directory:

cd /your_path/ExoSim2.0

Update the environment with:

uv sync --extra dev

Modify ExoSim

You can edit ExoSim’s source code as you like. An editable install (uv sync, or pip install -e .) makes your changes take effect immediately, with no reinstall needed.

To develop new ExoSim features and contribute them back to the project, see Contributing guidelines.