Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.76 KB

README.md

File metadata and controls

55 lines (37 loc) · 1.76 KB
Raw

PyPI - Package Version PyPI - Python Version PyPI - Downloads

GitHub Maintenance

comokit4py

comokit4py is a Python3 library for easily explore COMOKIT models, and process outputted data, on your laptop or an HPC in a few Python lines.

Requirements

  • comokit4py works with any version of COMOKIT
  • comokit4py requires GAMA => 1.8 and it's dependancies
    • comokit4py requires JDK 1.8

Installation

Use the package manager pip to install comokit4py.

pip install comokit4py

Usage example

import comokit4py

# Prepare GAMA (COMOKIT base software)
gama = comokit4py.Gama("~/.local/share/GAMA_1.8.1_Linux/headless/gama-headless.sh")

# Prepare exploration
explo = comokit4py.GamaExploration(experimentName = "Headless", 
	gamlFile = "~/Documents/COMOKIT/Model/COMOKIT/Experiments/Physical Interventions/Significance of Wearing Masks.gaml", 
	replication = 2, final = 5)
explo.calculatesExperimentSpace()

# Setup the exploration's workspace
ws = comokit4py.Workspace(gama, explo, "./out", True)

# Launch exploration
ws.runGamaHeadless(log = True, cores = 4)

The full library documentation is here : https://comokit.github.io/comokit4py/

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

LGPL-2.1 License