Installation Guide¶

This guide covers the setup of the necessary environment and installation of the library.

Prerequisites¶

Python 3.10–3.12 (3.13 not yet supported)
pip and venv (usually included with Python)
Optional (for graph rendering): Graphviz system package
- Ubuntu/Debian: sudo apt-get install graphviz
- macOS: brew install graphviz
- Windows: use Conda (see Option A)

Installation Options¶

Clone the Repository (If necessary): If you haven’t already, clone the repository to your local machine:

git clone <repository_url> # Replace <repository_url> with the actual URL
cd ammm # Or your repository directory name

Option A: Conda (Recommended for Windows)¶

conda create -n ammm python=3.11 pip -y
conda activate ammm
conda install -c conda-forge prophet m2w64-toolchain -y
pip install -e .
# Optional extras
pip install -e .[dev]
pip install -e .[docs]

Option B: venv (Linux/macOS and alternatives)¶

Create and Activate a Virtual Environment:

python -m venv venv_ammm
# Linux/macOS
source venv_ammm/bin/activate
# Windows (Command Prompt/PowerShell)
venv_ammm\Scripts\activate

Your terminal prompt should now indicate that you are in the (venv_ammm) environment.

Upgrade Build Tools (Recommended):

python -m pip install --upgrade pip setuptools wheel

Install Dependencies:
```
pip install -e .
```
The -e flag installs the package in “editable” mode, meaning changes you make to the source code are immediately reflected when you run the library.
Install Optional Extras:
- Development tools:
```
pip install -e .[dev]
```
- Documentation tools (for contributing to docs):
```
pip install -e .[docs]
```

Verification¶

After installation, verify using either the Python API or the CLI.

Python API (current import path):

from src.driver import MMMBaseDriverV2
print("AMMM driver available:", MMMBaseDriverV2 is not None)

Alternatively, verify the installed top-level module:

import src
print("AMMM version:", getattr(src, "__version__", "unknown"))

CLI tool (cache utilities):
```
ammm-cache info
```
You should see an “AMMM Cache Information” header.

You are now ready to configure and run the model! See the Quickstart Guide.