Skip to content

Installation

This guide provides instructions to install pSim.

System Requirements

A Python 3.12 virtual environment is created automatically; you do not need to set it up manually.

1. Setting UV, the Python project manager

To facilitate the creation of virtual environments and manage Python packages and their dependencies we use a state of the art framework uv, its installation is straightforward and can be done via the following command:

Using curl 

curl -LsSf https://astral.sh/uv/install.sh | sh
Using wget 
wget -qO- https://astral.sh/uv/install.sh | sh

Use irm to download the script and execute it with iex: 

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

2. Install pSim

Choose one of the following installation methods:

Recommended for most users

Install the latest stable release from the Python Package Index (PyPI).

uv venv --python 3.12
uv pip install pSim --upgrade

For optional dependencies:

  • To install with Gymnasium support: 

    uv pip install pSim[gym] --upgrade

  • To install with PettingZoo support: 

    uv pip install pSim[zoo] --upgrade

  • To install all optional dependencies: 

    uv pip install pSim[all] --upgrade

Recommended for developers

Install the latest development version directly from the GitHub repository.

git clone https://github.com/juliodltv/pSim.git
cd pSim
uv sync

For optional dependencies, use the same extras as above: 

uv sync --extra gym
uv sync --extra zoo
uv sync --extra all