Getting Started

Tutorial

Quick Start

Standard Installation

# Install from PyPI in a virtual environment
python -m venv .venv

# Activate virtual environment
# On Linux/Mac:
source .venv/bin/activate
# On Windows:
.venv\Scripts\activate

# Install temoa
pip install temoa

Get Started in 30 Seconds

In a virtual env with temoa installed, run:

# Create tutorial files in the current directory
temoa tutorial quick_start

# Run the model
temoa run quick_start.toml

Installation & Setup

Development Installation

For users who want to contribute to or modify Temoa should install in development mode using uv:

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh
# Clone repository
git clone https://github.com/TemoaProject/temoa.git
cd temoa

# Setup development environment with uv
uv sync --all-extras --dev

# Install pre-commit hooks
uv run pre-commit install

# Run tests
uv run pytest

# Run type checking
uv run mypy

Solver Dependencies

TEMOA requires at least one optimization solver:

  • Free: HiGHS
    • Included via the highspy Python package (automatically installed with Temoa)
    • Default solver for tutorial and testing
  • Free: CBC
    • Requires separate installation (see CBC documentation)
    • Alternative free solver option
  • Commercial: Gurobi, CPLEX, or Xpress
    • Requires separate license and installation
    • See individual solver documentation

Documentation & Support