Install ECLYPSE

ECLYPSE can be installed from PyPI. It requires Python >=3.11,<3.14.

Note

Do not use the global environment to install ECLYPSE. It is recommended to create a virtual environment first.

Using pip

Create and activate a virtual environment, then install the package:

python -m venv .venv
source .venv/bin/activate
pip install eclypse

Using uv

If your project uses uv, add ECLYPSE to the project dependencies:

uv add eclypse

Installing from source

For development, clone the repository and install the dependency groups you need:

git clone https://github.com/eclypse-org/eclypse.git
cd eclypse
uv sync --group dev --group test

The documentation dependencies live in the docs group:

uv sync --group docs

Now you are ready to run your first ECLYPSE simulation!