Skip to content

Installation

You'll need Python 3.11 or later. The examples use the OpenAI API, so you'll also need an API key to run them.

Install aigora

Install the latest release from PyPI:

python -m pip install aigora

We recommend using a virtual environment. To start a new experiment folder and install aigora there:

mkdir aigora-experiments
cd aigora-experiments
python3 -m venv .venv
source .venv/bin/activate
python -m pip install aigora
mkdir aigora-experiments
cd aigora-experiments
py -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install aigora

If PowerShell blocks activation, run Set-ExecutionPolicy -Scope Process -ExecutionPolicy RemoteSigned, then try the activation command again. This applies only to the current PowerShell session.

To upgrade an existing installation:

python -m pip install --upgrade aigora

Set your API key(s)

Set the API key for each provider used by your experiment in the same terminal where you will run it. The tutorials use OpenAI:

export OPENAI_API_KEY="your_openai_api_key"
$env:OPENAI_API_KEY = "your_openai_api_key"

These commands set the key for the current terminal session. For Anthropic, use ANTHROPIC_API_KEY; for Google, use GEMINI_API_KEY.

Get the tutorial files

The tutorial files are available as ZIP downloads on each tutorial page. Start with the first experiment files and extract the ZIP into your experiment folder. Keep the included examples/ directory structure, and run the tutorial commands from the folder containing examples/.

You're ready to run Your first experiment!

Install from source (for development)

To work on aigora itself, clone the repository with Git and install an editable copy. With a virtual environment activated:

git clone https://github.com/HRSAndrabi/aigora.git
cd aigora
python -m pip install -e ".[dev]"