Installation

Swarm Virtual Research Environment

The easiest way to use SwarmPAL is in the Swarm Virtual Research Environment (read more here). To get started with the SwarmPAL demo tool (which includes the examples given on these pages, as interactive notebooks), follow this link:

Install latest release

The package is available from PyPI:

If you do not need the DSECS toolbox:

pip install swarmpal

If you do need the DSECS toolbox:

pip install swarmpal[dsecs]

which includes apexpy, which is needed for the DSECS toolbox. There can be some trouble installing this so you might need to manually install apexpy first.

New to Python?

To setup Python on your system, check guidance on the viresclient installation notes

Install latest development version

Assuming you have a compatible system with git, a fortran compiler, and a Python>=3.8 installation with a recent version of pip, you can install the latest development version from the staging branch with:

pip install git+https://github.com/Swarm-DISC/SwarmPAL@staging#egg=swarmpal[dsecs]

Fortran compiler?

If you are using conda, you can get one from:

conda install conda-forge::fortran-compiler

The fortran compiler is required in order to install the dependency, apexpy. It may be better to try installing apexpy first and debugging that if you run into trouble.

To bypass installation of apexpy (so disabling usage of the DSECS toolbox), you can use pip without the [dsecs] option:

pip install git+https://github.com/Swarm-DISC/SwarmPAL@staging#egg=swarmpal

Install for local development

Clone the repository and install it in editable mode:

git clone https://github.com/Swarm-DISC/SwarmPAL
pip install -e SwarmPAL/

For more information check the development Guide on HackMD