Skip to content

Getting Started

Gamms is a library designed to simulate adversial games in a graph based world. This guide will help you quickly install and set up Gamms so you can start experimenting as soon as possible.

Python Requierement

Gamms requires Python 3.9 or later. If you already have a suitable version installed, skip to Installation and Setup.

Otherwise, visit the official Python download page to install a compatible version for your device (Windows, Mac, or Linux): Python

Installation and Setup

Before installing Gamms, ensure that pip is installed. Most Python distributions include pip by default; if you need to install it separately, follow the instructions on the pip documentation page.

Once pip is set up, use the appropriate commands below for your operating system.

Installing Git

  • sudo apt-get install git wget (Debian/Ubuntu)
  • sudo dnf install git wget (Fedora)
  • sudo pacman -S git wget (Arch)

Local Setup

Create a new folder in the directory where you want your project to live. We'll name it gamms: 

mkdir gamms
cd gamms
Create a Python virtual environment within this folder. You can do this using python or python3, depending on your system: 
python -m venv venv

This command will create a subfolder named venv that contains your virtual environment files.

Activate the virtual environment:

source venv/bin/activate

venv\Scripts\activate

Install Gamms within the virtual environment: 

python -m pip install git+https://github.com/GAMMSim/gamms.git

Verify your installation: 

   import gamms
   print("Gamms version:", gamms.__version__)

Once these steps are completed, you will have Gamms installed in a clean virtual environment. Remember to activate the virtual environment (step 3) whenever you want to work on your project.