Logo

📘 User Guide

  • Installation
    • Windows
    • Linux
  • Configuration
    • Types of Configurations
    • Folder Structure
    • File Descriptions
      • simulation_params.json
      • landscape_params.json
      • habitat_domain_patch.json
      • moisture_patch.json
      • obstacle_patch.json
      • resource.json
      • resource_patch.json
      • species.json
      • ontogeneticLinksPreference.csv
      • ontogeneticLinksProfitability.csv
      • checkpoint.bin / checkpoint.txt
    • Configuration Parameters
      • simulation_params
        • Main Properties
        • Object simulation
        • Object checkpoints
        • Object breakConditions
        • Object stability
        • Object initFromFixedSeed
        • Object outputs
        • Warnings
        • Hierarchical Summary
      • landscape_params
        • Main Properties
        • Object landscape
        • Object mapConfig
        • Object landscapeWideParams
        • Object spatialTreeParams
        • Object moistureBasePatch
        • Object temperatureDynamics
        • Object relativeHumidityDynamics
        • Object cycleParams
        • Object pulseParams
        • Object daysBetweenPulsesRange and pulsePeakValueRange
        • Object decay
        • Object linealDecayParams
        • Object nutrients
        • Object life
        • Hierarchical Summary
      • habitat_domain_patch
        • Main Properties
        • Object patch
        • Object source
        • Object shape
        • Object cubicParams
        • Object sphericalParams
        • Object homogeneousParams
        • Object gaussianParams
        • Object randomGaussianParams
        • Hierarchical Summary
      • moisture_patch
        • Main Properties
        • Object patch
        • Object source
        • Object temperatureDynamics
        • Object relativeHumidityDynamics
        • Object cycleParams
        • Object pulseParams
        • Object daysBetweenPulsesRange
        • Object pulsePeakValueRange
        • Object decay
        • Object linealDecayParams
        • Object shape
        • Object cubicParams
        • Object sphericalParams
        • Object homogeneousParams
        • Object gaussianParams
        • Object randomGaussianParams
        • Hierarchical Summary
      • obstacle_patch
        • Main Properties
        • Object patch
        • Object shape
        • Object cubicParams
        • Object sphericalParams
        • Object homogeneousParams
        • Object gaussianParams
        • Object randomGaussianParams
        • Hierarchical Summary
      • resource
        • Main Properties
        • Object resource
        • Object growthModule
        • Hierarchical Summary
      • resource_patch
        • Main Properties
        • Object patch
        • Object source
        • Object growthDynamics
        • Object cycleParams
        • Object pulseParams
        • Object daysBetweenPulsesRange / pulsePeakValueRange
        • Object decay
        • Object linealDecayParams
        • Object growthRateParams
        • Object temperature
        • Object shape
        • Object cubicParams
        • Object sphericalParams
        • Object homogeneousParams
        • Object gaussianParams
        • Object randomGaussianParams
        • Hierarchical Summary
      • species
        • Main Properties
        • Object animal
        • Object debug
        • Submodules
          • Decisions Module
            • Main Properties
            • Object predationProbability
            • Object escapeProbability
            • Object edibilityValue
            • Object decisionWithinPatch
            • Object decisionAmongPatches
            • Object sensoryModel
            • Hierarchical Summary
          • Genetics Module
            • Main Properties
            • Object modules
            • Object modifyAlleles
            • Object affectedTraits
            • Object traits
            • Object individualLevelTraitsOrder
            • Object definition
            • Object base
            • Object decisions
            • Object escapeProbabilityWeight
            • Object predationProbabilityWeight
            • Object edibilityValueWeight
            • Object preferences
            • Object probabilityDensityFunction
            • Object cellValue
            • Object <trait-non-temperature-section>
            • Object speciesLevelParams
            • Object individualLevelParams
            • Object limits
            • Object ranges
            • Object <trait-temperature-size-rule-section>
            • Object temperature of <trait-temperature-size-rule-section>
            • Object tempSizeRuleVector
            • Object <trait-dells-section>
            • Object temperature of <trait-dells-section>
            • Hierarchical Summary
          • Growth Module
            • Main Properties
            • Object capitalBreeding
            • Object capitalBreedingParams
            • Object eggsPerBatch
            • Object eggsPerBatch - equationParameters
            • Object eggDryMass
            • Object eggDryMass - equationParameters
            • Object growthModel
            • Object defaultAtTempFromLab
            • Object temperature
            • Object growthModelThermalChanges (elements)
            • Hierarchical Summary
        • Hierarchical Summary
      • ontogeneticLinksPreference
        • Overview
        • File Format
        • Example Structure
        • Interpretation Example
      • ontogeneticLinksProfitability
        • Overview
        • File Format
        • Example Structure
        • Interpretation Example
  • Usage
    • Command-line Options
    • Modes of Execution
    • Output Folder
    • Interactive Input (Non-GUI)
    • Graphical Interface (GUI)
    • Summary
  • Examples
  • Troubleshooting

🧠 Developer Guide

  • Build System
    • Common Requirements
      • Compiler installation by operating system
        • Windows
        • Linux
    • Release Requirements
      • Windows
      • Linux
    • Documentation Requirements
    • Developer Setup
    • CMake Presets
      • Available Presets
    • Updating vcpkg Version
  • Adding Features
    • Branch Strategy
  • Contribution
    • Pull Requests
    • Code Review
    • Issues
  • Code Style
    • General Guidelines
    • Formatting
    • Comments
  • JSON validator
    • Getting Started
      • What is JSON Schema?
      • Elements of JSON Schema
        • Common Fields
          • type
          • description
          • nullProperty
        • Specific Fields for Each Type
          • Array Type
            • Specific Fields
              • items
              • minItems
              • maxItems
              • itemsOrder
            • Example
          • Boolean Type
            • Specific Fields
            • Example
          • Integer Type
            • Specific Fields
              • minimum
              • exclusiveMinimum
              • maximum
              • exclusiveMaximum
              • multipleOf
            • Example
          • Number Type
            • Specific Fields
              • minimum
              • exclusiveMinimum
              • maximum
              • exclusiveMaximum
            • Example
          • Object Type
            • Specific Fields
              • properties
              • patternProperties
              • conditionals
              • patternConditionals
              • requiredConditions
              • warningConditions
            • Example
          • String Type
            • Specific Fields
              • minLength
              • maxLength
              • pattern
              • enum
            • Example
          • Tuple Type
            • Specific Fields
              • items
            • Example
      • Benefits of Using JSON Schema
      • Example of a Complete JSON Schema
    • Advanced Features
      • Operators of JSON Schema
        • Equality and Comparison Operators
          • Equal (==)
          • Not Equal (!=)
          • Less Than (<)
          • Less Than or Equal (<=)
          • Greater Than (>)
          • Greater Than or Equal (>=)
        • Logical Operators
          • Negation (not)
          • Conjunction (and)
          • Disjunction (or)
        • Property Operators
          • Value of the Property
          • Item of the Property
          • Size of the Property
          • Null Status of the Property
        • Constant Operators
        • Arithmetical Operators
          • Subtract (-)
          • Addition (+)
          • Multiply (*)
          • Division (/)
          • Module (%)
      • Conditionals of JSON Schema
        • Condition
        • Then Block
        • Else Block
      • Conditions of JSON Schema

⚙️ Reference

  • API

🧪 Testing and Deployment

  • Overview
  • Unit Tests
  • Continuous Integration & Continuous Deployment (CI/CD)
    • Configuration
    • Workflows
      • Deploy Release Workflow
        • Job 1 — build-windows
        • Job 2 — release
        • Job 3 — deploy-docs
        • Deploy Release Workflow Notes
      • Update Documentation Workflow
        • Job — update
        • Update Documentation Workflow Notes
Weaver
  • Search

© Copyright 2025, EEZA.

Built with Sphinx using a theme provided by Read the Docs.
v: 2025.12.12 (en)
Versions
2025.12.12
Languages
en