Repository for the comokit4py package https://pypi.org/project/comokit4py/
  • Python 88.5%
  • R 7.6%
  • GAML 3.3%
  • Makefile 0.6%
Find a file
Hùng f77ee46fa3
Merge pull request #8 from COMOKIT/tests
Add test for report generation
2021-06-15 15:17:07 +07:00
.github/workflows [GHA] Fix upload command for stable 2021-04-06 11:56:55 +07:00
base Assertion fix 2021-06-08 09:58:22 +07:00
comokit4py Add symlink to the report package 2021-06-08 09:20:08 +07:00
doc [DOC] Change header to generate full doc 2021-01-18 15:11:12 +07:00
test Add test for report generation 2021-06-15 15:11:33 +07:00
.gitignore [GIT] Update gitignore 2021-01-13 16:22:42 +07:00
LICENSE Initial commit 2020-12-18 10:54:58 +07:00
Makefile [DOC] Init Sphinx doc 2021-01-15 18:48:35 +07:00
README.md [README] Update badges 2021-01-18 15:35:14 +07:00
setup.py [BOT] Update alpha version number to v0.1.4 2021-04-16 07:44:29 +00:00

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