Skip to main content

General Ecosystem Modeling Framework

GEMF is a ecosystem modelling framework written in python. It is designed to offer an easy to use method for modelling ecosystems with low- to intermediate complexity.
The framework offers the functionality to handle non-equilibrium, non-linear interactions. For the typical use-cases, user do need to write any code but only provide a model configuration. The use-cases can easily be extended with simple user written functions without needing to change any of the framework code.
The framework offers an easy to use method that fits any parameter of the model to mimic the studied system. For simplicity, the current version of the framework is limited to non-spatially resolved models (box-models).

Installation

On Linux

Python and its package manger (pip) should be preinstalled. Hence, it can simply be installed through:

pip install gemf

On Windows:

Get the latest python version from here. For example the 3.8.3 version installer This also installs pythons integrated package manager (pip).
Then, the following install command can be used in windows "powershell":

python -m pip install gemf

Quick Start

See examples.py. For a set of exemplary framework configurations see configuration_files

Usage

import gemf as 

# A model configuration is defined in a yaml file. To read this file:
model = gemf.load_model_configuration('path/to/model_configuration.yml')

# To draw a graph visualizing the model configuration:
gemf.interaction_graph(model)

# To solve the time integration of this model call:
forward_results = gemf.forward_model(model)
# To also solve the inverse problem as defined in the configuration, call:
inverse_results = gemf.inverse_model(model)

# To plot the results call 
gemf.plot.output_summary(inverse_results)

For details on the yaml configuration file, see README_YAML.md
The presented functions offer many (crucial) options, which are discussed in the documentation.

How does it work?

For a conceptual description of the internals of this library, see README_concept.md

Example

A simple example might be a simple NPZD model as presented below: interaction graph

The user needs to define the compartments and interactions between them. If the model should be fitted, they also need to provide some constraints and some data to fit it to.
After that the model automatically generates a graph to visualize the system and to find potential errors in the configuration.

Once the model is configured the framework handles the time integration as well as the fitting without any further required user-interaction.

The results of such a run might then look like the following: exemplary results

Top left shows the cost of the current model configuration. The cost is a quadratic measure of distance of the current model to the desired model. Top right shows a output of the model after it reached its steady state for every parameter set tested. Bottom left shows the all tested parameters sets. Bottom right shows the full model output of the best fitted model found.

Metadata

Release files for gemf 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gemf 0.3.1
File Size Uploaded Provenance Actions
gemf-0.3.1.tar.gz 17.1 kB Without provenance Details for gemf-0.3.1.tar.gz

Release files / gemf-0.3.1.tar.gz

Download URL gemf-0.3.1.tar.gz
Size 17.1 kB
Tags Source
SHA-256 checksum
How to use checksums
0985655b7387333cddbfca306f1a2fb61f12e44cff05ebabfc4d17dd3b449254
BLAKE2b-256 checksum
How to use checksums
70c46bbfe2dc6b5a318f99d44004a743aae8b2671d3086a52eaa7a6a94a8e0e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.3

Security for gemf 0.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page