Installation¶

This page explains how to install AMIGO from source using Anaconda (recommended for developers).

Target Python version: ≥ 3.11

Install from Source¶

This option is ideal if you plan to contribute, debug, or modify AMIGO. We recommend using Anaconda to create a dedicated virtual environment, ensuring all dependencies are correctly managed and isolated.

2.1 — Install Anaconda¶

Download and install Anaconda from the official website:

https://www.anaconda.com/download

Tip: Anaconda simplifies package management and ensures a reproducible setup.

2.2 — Install Git (Optional)¶

We recommend installing Git so you can clone the repository instead of downloading it manually.

Important: Run the following commands in an Anaconda Prompt (Windows) or terminal (macOS/Linux):

conda install git

If you don’t want to use Git, you can download the source code manually as a .zip file.
You don’t need to create a specific folder manually. Git will automatically create a folder called AMIGOpy when cloning.

2.3 — Clone the Repository (Recommended)¶

git clone https://github.com/PhysicsResearch/AMIGOpy.git
cd AMIGOpy

2.4 — Or Download the Source Manually¶

Go to the AMIGO GitHub repository.
Click Code → Download ZIP.
Extract the archive to a desired folder.

2.5 — Create and Activate a Conda Environment¶

Use the provided amigo.yml file to ensure correct dependencies:

conda env create -f amigo.yml
conda activate amigo

2.6 — Run AMIGO¶

python Launch_ImGUI.py

Troubleshooting¶

Dependency conflicts → Remove your environment and recreate it using:

conda env remove -n amigo
conda env create -f amigo.yml

* Issues running compiled version → Check the GitHub Issues.

For advanced usage and development setup, see the Developer Guide.