NEMF: network-based ecosystem modeling framework
NEMF 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).
A detailed introduction and many more resources can be found at: nemf.readthedocs.io
Installation
The package can be installed using pythons integrated package manager pip.
pip install nemf
For a detailed description how it can be installed, see install notes
Quick Start
See examples.py. For a set of exemplary framework configurations see configuration_files
Usage
import nemf as
# A model configuration is defined in a yaml file. To read this file:
model = nemf.load_model('path/to/model_configuration.yml')
# To draw a graph visualizing the model configuration:
nemf.interaction_graph(model)
# To solve the time integration of this model call:
forward_results = nemf.forward_model(model)
# To also solve the inverse problem as defined in the configuration, call:
inverse_results = nemf.inverse_model(model)
# To plot the results call
nemf.plot.output_summary(inverse_results)
For details on the yaml configuration file, see
yaml documentation
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 model concept
Example
A simple example might be a simple NPZD model as presented below:
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:
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 nemf 0.3.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nemf-0.3.4.tar.gz | 24.1 kB | Without provenance | Details for nemf-0.3.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nemf-0.3.4-py3-none-any.whl | Python 3 | none | any | Details for nemf-0.3.4-py3-none-any.whl |
Total release size: 50.1 kB
Release files / nemf-0.3.4.tar.gz
| Download URL | nemf-0.3.4.tar.gz |
|---|---|
| Size | 24.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9b67f5ac38c6f75f242c269c6e007160183e53e19aa4e82fa9846869bfd67d90
|
|
BLAKE2b-256 checksum How to use checksums |
e14d021c35cb69b0a75cd7e51e0d9d42c80216ab6f32147b6585fbd68a3a3d52
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5
|
Release files / nemf-0.3.4-py3-none-any.whl
| Download URL | nemf-0.3.4-py3-none-any.whl |
|---|---|
| Size | 26.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
70d015df217c29c3f0d1069eacacae4215239b75e4d1aecb89892d036ed1e768
|
|
BLAKE2b-256 checksum How to use checksums |
1f8a6473a9ac075c9f5594109c1492db85f5fb55cf43cbaaae8703f51101769c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5
|
Security for nemf 0.3.4
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.