SINDBAD

julia

Processes

The core module for defining and implementing models and approaches of ecosystem processes in the SINDBAD framework.

Purpose:

The Processes module provides the infrastructure for defining and implementing terrestrial ecosystem models within the SINDBAD framework. It includes tools for process definition, parameter management, and method implementation. All SINDBAD models inherit from LandEcosystem and implement standardized methods for model execution.

Dependencies:

SindbadTEM: Provides the core SINDBAD models and types, including LandEcosystem and purpose function.
FieldMetadata: Enables metadata annotations for model parameters (bounds, units, timescale, descriptions).
Parameters: Provides the @with_kw macro for keyword argument construction.

Included Files:

The module dynamically includes all process implementations from subdirectories under src/Processes/.

Each process directory follows the convention:

A main process file: Processes/<process>/<process>.jl defining the abstract process type
One or more approach files: Processes/<process>/<process>_*.jl implementing specific approaches

Key processes include:

Carbon cycle processes (GPP, respiration, allocation, turnover)
Water cycle processes (evapotranspiration, runoff, soil water)
Vegetation processes (LAI, fAPAR, phenology)
And many more ecosystem processes

Notes:

All models must implement at least one of the following methods: define, precompute, compute, or update.
Parameters should use metadata macros (@bounds, @describe, @units, @timescale) for proper documentation and validation.
Processes should follow SINDBAD modeling conventions for consistency and maintainability.
The module provides getModelDocString and getApproachDocString helpers for automatic documentation generation of models and approaches.

Examples:

julia

julia> using SindbadTEM.Processes

julia> # Define a new process
julia> abstract type MyProcess <: LandEcosystem end

julia> purpose(::Type{MyProcess}) = "Description of my process."

julia> # Define an approach with parameters (example structure)
julia> # @bounds @describe @units @timescale @with_kw struct MyProcess_v1{T} <: MyProcess
julia> #     param1::T = 1.0 | (0.0, 2.0) | "Description" | "units" | "timescale"
julia> # end

julia> # Implement required methods (example)
julia> # function define(params::MyProcess_v1, forcing, land, helpers)
julia> #     # Initialize arrays and variables
julia> #     return land
julia> # end

Processes (models + approaches) ​

EVI ​

LAI ​

NDVI ​

NDWI ​

NIRv ​

PET ​

WUE ​

ambientCO2 ​

autoRespiration ​

autoRespirationAirT ​

cAllocation ​

cAllocationLAI ​

cAllocationNutrients ​

cAllocationRadiation ​

cAllocationSoilT ​

cAllocationSoilW ​

cAllocationTreeFraction ​

cBiomass ​

cCropHarvest ​

cCropHarvestEfficiency ​

cCropHarvestEvent ​

cCropHarvestIntensity ​

cCycle ​

cCycleBase ​

cCycleConsistency ​

cCycleDisturbance ​

cCycleManagement ​

cDieBack ​

cFire ​

cFireBurnedArea ​

cFireCombustionCompleteness ​

cFireMortality ​

cFlow ​

cFlowLitterfall ​

cFlowReserves ​

cFlowStress ​

cForestryHarvest ​

cForestryHarvestEfficiency ​

cForestryHarvestEvent ​

cForestryHarvestIntensity ​

cMicrobialEfficiency ​

cMicrobialEfficiencycLit ​

cMicrobialEfficiencycMic ​

cMicrobialEfficiencycSoil ​

cQualityPartition ​

cQualityPartitioncLit ​

cQualityPartitioncMic ​

cQualityPartitioncSoil ​

cQualityPartitioncVeg ​

cTau ​

cTauSoilProperties ​

cTauSoilT ​

cTauSoilW ​

cTauVegProperties ​

cVegetationDieOff ​

capillaryFlow ​

constants ​

deriveVariables ​

drainage ​

evaporation ​

evapotranspiration ​

fAPAR ​

frozenFraction ​

getPools ​

gpp ​

gppAirT ​

gppDemand ​

gppDiffRadiation ​

gppDirRadiation ​

gppPotential ​

gppSoilW ​

gppVPD ​

groundWRecharge ​

groundWSoilWInteraction ​

groundWSurfaceWInteraction ​

interception ​

percolation ​

rainIntensity ​

rainSnow ​

Processes (models + approaches)

EVI

LAI

NDVI

NDWI

NIRv

PET

WUE

ambientCO2

autoRespiration

autoRespirationAirT

cAllocation

cAllocationLAI

cAllocationNutrients

cAllocationRadiation

cAllocationSoilT

cAllocationSoilW

cAllocationTreeFraction

cBiomass

cCropHarvest

cCropHarvestEfficiency

cCropHarvestEvent

cCropHarvestIntensity

cCycle

cCycleBase

cCycleConsistency

cCycleDisturbance

cCycleManagement

cDieBack

cFire

cFireBurnedArea

cFireCombustionCompleteness

cFireMortality

cFlow

cFlowLitterfall

cFlowReserves

cFlowStress

cForestryHarvest

cForestryHarvestEfficiency

cForestryHarvestEvent

cForestryHarvestIntensity

cMicrobialEfficiency

cMicrobialEfficiencycLit

cMicrobialEfficiencycMic

cMicrobialEfficiencycSoil

cQualityPartition

cQualityPartitioncLit

cQualityPartitioncMic

cQualityPartitioncSoil

cQualityPartitioncVeg

cTau

cTauSoilProperties

cTauSoilT

cTauSoilW

cTauVegProperties

cVegetationDieOff

capillaryFlow

constants

deriveVariables

drainage

evaporation

evapotranspiration

fAPAR

frozenFraction

getPools

gpp

gppAirT

gppDemand

gppDiffRadiation

gppDirRadiation

gppPotential

gppSoilW

gppVPD

groundWRecharge

groundWSoilWInteraction

groundWSurfaceWInteraction

interception

percolation

rainIntensity

rainSnow