Installation

OPynSim is pre-built for its supported platforms and uploaded to PyPi, which means you can easily install it with package managers such as pip and uv for your project’s chosen Python distribution.

opynsim is a fundamental package with minimal dependencies, making it compatible with a wide variety of other python packages and alternative Python distributions (e.g. Anaconda and Miniforge).

pip

In a terminal, install opynsim with:

pip install opynsim

This assumes you have already created/activated your chosen Python (>= v3.12) environment. For example, like this:

# Example virtual environment initialization on Linux/macOS
python3 -m venv .venv
source .venv/bin/activate
pip install opynsim

uv

In a terminal, install opynsim with:

uv install opynsim

This assumes you have already initialized/activated your chosen Python (>= v3.12) environment . For example, like this:

# Example uv environment setup
uv init
uv install opynsim

Anaconda/Miniconda/Miniforge

In a terminal, install opynsim with:

pip install opynsim

This assumes you have already initialized/activated your chosen Python (>= v3.12) environment . For example, like this:

# Example conda environment setup
conda create -n just-opynsim "python>=3.12"
conda activate just-opynsim
pip install opynsim

Supported Platforms

OPynSim contains a native C++ Python extension module, so it’s only compatible with the platforms that it’s built for. The following platforms are currently built and deployed to PyPi by the project:

Python Version	Operating System	Processor Architecture
≥ 3.12	Windows ≥ 10	amd64 (Intel/AMD chip with AVX2 support)
≥ 3.12	MacOS ≥ 14.5 (Sonoma)	arm64 (Apple Silicon)
≥ 3.12	Linux /w glibc 2.28 (Ubuntu ≥ 20.04, Debian ≥ 10, AlmaLinux ≥ 8, RHEL ≥ 8, OpenSUSE ≥ 15)	amd64 (Intel/AMD chip with AVX2 support)