Installation¶
The examples on this site target VAMOS 1.1.0. Use an isolated Python environment and the pinned commands below to follow the same release.
Supported Python and operating systems¶
| Operating system | Python versions covered by CI | Installed-wheel release checks |
|---|---|---|
| Linux | 3.10, 3.11, 3.12 | Core on 3.10; core and compute on 3.12 |
| Windows | 3.12 | Core |
| macOS | 3.12 | Core |
These are the combinations in the project's CI and release verification matrices, not a promise for every version of every optional dependency. Other interpreter/platform combinations are unclaimed. See Known limitations.
Core package¶
Create an isolated environment and install the package from PyPI:
python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install "vamos-optimization==1.1.0"
py -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install "vamos-optimization==1.1.0"
Verify the installation:
python -c "import vamos; print(vamos.__version__)"
vamos check
The version command must print 1.1.0 for this release. To install the latest
published version instead, use python -m pip install --upgrade vamos-optimization
and consult the documentation for that version. Pinning VAMOS alone does not
freeze dependencies; retain the environment record for scientific runs (see
Run artifacts and replay).
Optional extras¶
Install only the capability groups you use:
| Extra | Purpose | Interface status |
|---|---|---|
compute |
Numba kernels, MooCore indicators, and Dask evaluation | Stable backend selection; Experimental Dask integration |
research |
Third-party research baselines and benchmarks | Experimental |
analysis |
Data frames, plotting, notebooks, and analysis helpers | Experimental helpers |
tuning |
Optional model-based tuning backends | Experimental |
studio |
Panel-based local Studio | Experimental; see Studio for release limitations |
examples |
Dependencies used by selected examples | Depends on the example's interfaces |
openai, anthropic |
Optional provider SDKs | Experimental integrations |
docs |
Documentation toolchain | Developer tooling |
dev |
Tests, linting, typing, building, and docs checks | Developer tooling |
all |
All optional and development groups | Mixed; does not change interface guarantees |
For example:
python -m pip install "vamos-optimization[compute,analysis]==1.1.0"
An explicit optional backend fails clearly when its dependency is unavailable. VAMOS does not install packages during optimization, verification, or replay. Installing an extra does not make its APIs stable. The stability policy defines Stable, Experimental, and Internal interfaces.
Install from a source checkout¶
Only use an editable install when developing VAMOS or modifying repository examples. First obtain the source and enter its root:
git clone https://github.com/vamos-optimization/VAMOS.git
cd VAMOS
python -m pip install -e ".[dev]"
Use the environment setup above before this command. The default branch may
contain work beyond the published release; record the checked-out commit. To
inspect the release source, check out the v1.1.0 tag before installing.
For ordinary use, prefer the PyPI installation under Core package.