pyMANGA

PYthon Models for AGeNt-based resource GAthering (pyMANGA) is a collection of models describing vegetation population dynamics from first principles. pyMANGA is modular, and descriptions of individual tree growth, resource availability and competition dynamics can be quickly interchanged.

Structure of pyMANGA documentation

The source code is divided into seven libraries, organized by purpose: ProjectLib, TimeLoopLib, PopulationLib, PlantModelLib, ResourceLib, ModelOutputLib, VisualizationLib (left navigation bar). A library may contain several modules, each representing a different realization of the overarching library purpose.

The documentation for each module follows the structure below:

1. Description: Short description of the module
2. Usage: Specification of the tags to be used in the pyMANGA project XML file (if applicable)
3. Attributes: Input parameters of the module
4. Value: Return value of the module
5. Details: A detailed description of the module, explaining its purpose and processes, and listing notes on its applications and restrictions
6. Examples: Extends the usage by providing more examples of how to use this module

Note All parameters are defined in SI units unless indicated otherwise.

Further information

• For general information about the pyMANGA project and tutorials visit our website
• To learn more about model structure read Wimmler et al. 2024
• Find the source code on GitHub
• Problems? File an Issue

How to cite pyMANGA

When using pyMANGA, please:

• Cite the specific version used in all publications
• Clearly disclose any modifications in the methods section
• Seek verification for new features intended for production use

The table below provides guidance on how to cite pyMANGA depending on your type of usage.

Case	Description	Example citation
1 – Standard usage	Use of pyMANGA without any modifications.	"We used pyMANGA (version [INSERT VERSION TAG]) without modifications (Optional: Wimmler et al. 2024)."
2 – Modified usage (not verified)	Use of pyMANGA with custom modifications that have not been verified by the pyMANGA team.	"We used pyMANGA (version [INSERT VERSION TAG]) with custom modifications to [briefly describe components/modules]. These changes have not been verified by the pyMANGA team. Details are in [Methods/Supplementary Material]."
3 – Extended usage with verified features	Use of pyMANGA including features that are part of an official release (i.e. verified and integrated).	"We used pyMANGA (version [INSERT VERSION TAG]), which includes verified new features described in [Methods/Supplementary Material] and incorporated into the pyMANGA documentation (https://pymanga.github.io/pyMANGA)."

CoreTeam

@mcwimm @jbathmann @jvollhueter

 1#!/usr/bin/env python3
 2# -*- coding: utf-8 -*-
 3"""
 4.. include:: ./doc_page.md
 5"""
 6import os, sys
 7
 8sys.path.append(os.path.abspath(os.path.dirname(__file__)))
 9
10# Define docstring type for documentation rendering with pdoc
11__docformat__ = "google"