Skip to content

Setup via pip

pip is Python’s default package manager—already on most systems and easy to learn. If you have Python, you have pip! Use it inside a virtual environment to keep Particula’s dependencies isolated from other projects.

If you need to install Python, use the miniconda distribution (which includes pip). If you prefer to install Python separately, see the Python.org page for instructions.

Upgrade pip itself (recommended):

Terminal window
python -m pip install --upgrade pip
Section titled “2. Create a virtual environment (recommended)”

Create an isolated environment named .venv:

Terminal window
python -m venv .venv

Activate it on Linux / macOS:

Terminal window
source .venv/bin/activate

Activate it on Windows (CMD or PowerShell):

Terminal window
.\.venv\Scripts\activate

Install the core package:

Terminal window
pip install particula

Need the tutorial extras (plots, progress‑bars, etc.)? Install them with:

Terminal window
pip install "particula[extra]"

Upgrade Particula:

Terminal window
pip install -U particula

Uninstall Particula:

Terminal window
pip uninstall particula

If you want to contribute to Particula, see the Contributor Setup section for details on setting up a development environment and workflow.

Install Particula editable + dev extras:

Terminal window
pip install -e ".[dev,extra]"

The package is now linked to your working copy—changes you make in the repository are picked up immediately.