Installation¶

Requirements¶

Install the core package:

pip install alberta-framework

The framework has several optional dependency groups for different use cases.

For running tests and linting:

pip install alberta-framework[dev]

Includes: pytest, pytest-cov, ruff, mypy

For using RL environments as experience streams:

pip install alberta-framework[gymnasium]

Includes: gymnasium>=0.29.0

For publication-quality experiments and visualization:

pip install alberta-framework[analysis]

Includes: matplotlib, scipy, joblib, tqdm

For building documentation locally:

pip install alberta-framework[docs]

Includes: mkdocs, mkdocs-material, mkdocstrings

Install everything:

pip install alberta-framework[dev,gymnasium,analysis,docs]

Clone the repository and install in editable mode:

git clone https://github.com/j-klawson/alberta-framework.git
cd alberta-framework
pip install -e ".[dev,gymnasium,analysis,docs]"

import alberta_framework
print(alberta_framework.__version__)

Run the test suite:

pytest tests/ -v