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.
1. Ensure pip is up‑to‑date
Section titled “1. Ensure pip is up‑to‑date”Upgrade pip itself (recommended):
python -m pip install --upgrade pip2. Create a virtual environment (recommended)
Section titled “2. Create a virtual environment (recommended)”Create an isolated environment named .venv:
python -m venv .venvActivate it on Linux / macOS:
source .venv/bin/activateActivate it on Windows (CMD or PowerShell):
.\.venv\Scripts\activate3. Install Particula
Section titled “3. Install Particula”Install the core package:
pip install particulaNeed the tutorial extras (plots, progress‑bars, etc.)? Install them with:
pip install "particula[extra]"4. Upgrade / Uninstall
Section titled “4. Upgrade / Uninstall”Upgrade Particula:
pip install -U particulaUninstall Particula:
pip uninstall particula6. Developing Particula from source
Section titled “6. Developing Particula from source”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:
pip install -e ".[dev,extra]"The package is now linked to your working copy—changes you make in the repository are picked up immediately.