Installation¶

This page describes how to install SymOp for both regular use, development and documentation.

Requirements¶

SymOp requires:

The core package depends on:

Install the latest released version from PyPI with:

pip install symop

This installs SymOp together with its required runtime dependencies.

To upgrade to the latest version:

pip install --upgrade symop

To install the latest version directly from the GitHub repository:

pip install git+https://github.com/tqsd/symop.git

This is useful if you want the newest development version before a release is published on PyPI.

It is recommended to install SymOp inside a virtual environment.

Create and activate one with:

python -m venv .venv
source .venv/bin/activate

Then install SymOp:

pip install symop

On Windows, activate the virtual environment with:

.venv\Scripts\activate

To work on SymOp locally, clone the repository and install it in editable mode:

git clone https://github.com/tqsd/symop.git
cd symop
pip install -e .[dev]

This installs SymOp together with the development dependencies, including:

To build the documentation locally, install the documentation dependencies:

pip install -e .[docs]

If you also want the development tools at the same time, install both extras:

pip install -e .[dev,docs]

After installing the documentation dependencies, build the HTML documentation from the repository root:

sphinx-build -b html docs docs/_build/html

The generated documentation will be available in:

docs/_build/html

You can verify that SymOp is installed by importing it in Python:

python -c "import symop; print(symop.__name__)"

If the installation succeeds, this should print:

symop