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

CoreTeam

@jbathmann @mcwimm @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"