gama-platform/gama.docker
1
0
Fork 0
mirror of https://github.com/gama-platform/gama.docker.git synced 2026-07-09 10:10:27 +00:00
Code Issues Projects Releases Packages Wiki Activity
⛴ Docker image of GAMA headless https://hub.docker.com/r/gamaplatform/gama
168 commits 1 branch 0 tags 228 KiB
  • Dockerfile 100%
Find a file
Exact
GitHub Action bd52c06089 avoid being suspended
2026-07-01 02:38:10 +00:00
.github avoid being suspended 2026-07-01 02:38:10 +00:00
tags fix: Bump alpha's JDK to 25 2026-04-09 12:56:12 +07:00
docker-compose.yaml Add docker-compose.yaml example 2024-10-22 10:34:49 +02:00
LICENSE Initial commit 2019-09-20 19:49:37 +02:00
README.md Add compose example to README.md 2024-10-22 10:57:44 +02:00

README.md

GAMA Docker Container

This project is a simple Docker image that contains a GAMA platform ready to use in headless mode within a minimal Alpine with Eclipse Adoptium OpenJDK 21 64-Bit Server VM container.

Getting Started

These instructions will cover usage information and for the docker container

Prerequisities

In order to run this container you'll need to install docker.

Usage

Tags

The GAMA Platform Docker repository does contain a lot of different versions of GAMA :

  • Stable releases
  • Rolling releases
    • alpha which is the latest build done with current github code. This is not tested contrary to official releases.
  • Meta tags
    • latest which is the latest official release

Simple usage

The command to run the previously builded image is simple as below

docker run gamaplatform/gama:latest <custom argument for headless execution>

By default, if you don't add argument after the container image, it will display the help message.

Shutdown the container

The container will stop automatically when the headless run will end.

Enter in the container

If you want to enter in bash inside the gama container, you will have to explicitly change the Docker Entrypoint of the container by this way

docker run -i -t --entrypoint /bin/bash <containerID>

Example

$ docker run --rm gamaplatform/gama:1.8.1 -help
gama-headless.sh
******************************************************************
* GAMA version 1.8.1                                             *
* http://gama-platform.org                                       *
* (c) 2007-2019 UMI 209 UMMISCO IRD/SU & Partners                *
******************************************************************
 Welcome to Gama-platform.org version GAMA 1.8.1
sh ./gama-headless.sh [Options] [XML Input] [output directory]

List of available options:
      -help                   -- get the help of the command line
      -version                -- get the the version of gama
      -m [mem]                -- allocate memory (ex 2048m)
      -c                      -- start the console to write xml parameter file
      -v                      -- verbose mode
      -hpc [core]             -- set the number of core available for experimentation
      -socket [socketPort]    -- start socket pipeline to interact with another framework
      -p                      -- start pipeline to interact with another framework
      -validate [directory]   -- invokes GAMA to validate the models present in the directory passed as argument
      -test [directory]       -- invokes GAMA to execute the tests present in the directory and display their results
      -failed                 -- only display the failed and aborted test results
      -xml [experimentName] [modelFile.gaml] [xmlOutputFile.xml] -- only display the failed and aborted test results
 sh ./gama-headless.sh -xml experimentName gamlFile xmlOutputFile

      build an xml parameter file from a model

Environment Variables

  • /usr/lib/gama/headless/gama-headless.sh - Headless launch script (Default Entrypoint)

Useful File Locations

  • /opt/gama-platform - The installed version of GAMA

  • /opt/gama-platform/headless/gama-platform.sh - The helping file to launch GAMA Headless

Installing

Docker Hub pull

$ docker pull gamaplatform/gama:[latest|1.8.1|..]

To see all the available tags, see there.

Building

Clone this repository

git clone https://github.com/gama-platform/gama.docker

Move in the cloned repository

cd ./gama.docker/tags/<any-tag-name>

Build the Docker image

docker build -t gama .

Docker compose

services:
  gama:
    image: gamaplatform/gama:alpha
    # Modify here the command to be run by the container upon execution
    command: gama-headless -v /opt/gama-platform/headless/samples/roadTraffic.xml /opt/gama-platform/output
    container_name: gama_container
    # Map the outputs of the execution to a local "output" directory
    volumes: 
      - ./output:/opt/gama-platform/output
    restart: no

You can run the following to execute the example docker compose file :

$ docker compose up -d

If you want to run your own model inside the container, map it to volumes inside the container :

services:
  gama:
    image: gamaplatform/gama:alpha
    command: gama-headless -v /opt/gama-platform/headless/your_model/ExperimentFile.xml /opt/gama-platform/output
    container_name: gama_container
    volumes: 
      - ./output:/opt/gama-platform/output
      - /path/to/your_model:/opt/gama-platform/headless/your_model
    restart: no

Built With

Find Us

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL3 License - see the LICENSE.md file for details