Installation#
Tip
Try the SwarmPAL dashboards
Note
SwarmPAL is available in the Swarm Virtual Research Environment - read more here
Install latest release#
The package is available from PyPI:
pip install swarmpal[dsecs,experimental]
pip install swarmpal
uv add swarmpal[dsecs,experimental]
uv add swarmpal
New to Python?
To setup Python on your system, check guidance on the viresclient installation notes
Install for development#
(using uv)
git clone git@github.com:Swarm-DISC/SwarmPAL.git
cd SwarmPAL
uv venv --python 3.11
uv sync --frozen --all-groups --all-extras
(You might need to omit --frozen or instead use --locked)
You can also use nox to run tests and build docs using ephemeral environments (they live in the .nox directory), e.g.:
uvx nox -s tests
uvx nox -s docs -- no-exec -- serve