apsimNGpy: The Next-Generation Agro-ecosystem Simulation Library

Introduction

apsimNGpy is a cutting-edge, open-source framework designed for advanced agroecosystem modeling. Built on object-oriented principles, it provides:

• Fast batch file simulation

• Model prediction and evaluation

• Seamless APSIMX file editing

• APSIM template model inspection

• Weather data retrieval

• Efficient soil profile development

• Parameter optimization (still undergoing rigorous tests). apsimNGpy support a broad selection of local and global optimization methods., including genetic multi-objective optimizations.

• Global and local sensitivity analysis

• Distributed computing framework.

Table of Contents

• Home

Getting Started

• Installation
• Quick guides
• Locating the APSIM Binaries
• Changing/setting the APSIM installation binaries path
  • 1. Manually configure the APSIM binary path. To do this:
  • 2. Change based os.environ module
  • 3. Use the apsimNGpy config module:
  • 4. Use command line interface
• Instantiating apsimNGpy Model Objects
• Running and Retrieving Results
  • Running loaded models
  • Accessing Simulated Results
  • Saving the Simulation

Inspection & Editing

• Inspect Model
• Whole Model inspection
• Inspect Model Parameters
• Editing Model Parameters
• Quick and Simple Way to Run Factorial Experiments
  • Setting Up the Environment
  • Creating an Experiment
  • Adding Factors
  • Running the Experiment
  • Factorial Experiment with Cultivar Replacements
• Quick Overview
• Getting Started
• Adding Input Factors
• Finalizing the Experiment
• API Summary
• Further Reading
• Weather Data Replacement.
  • Get weather data from the web
  • Using local weather data

Optimization & Trade-off Analysis

• Single-Objective Optimization with apsimNGpy
  • Demonstration
  • Minimizing continuous variables
  • Adding control variables
• Mixed-Variable Optimization in apsimNGpy
  • Using MixedVariable in Practice
  • Review optimization results
  • Summary
• Multi-Objective Optimization with apsimNGpy
  • Step 1: Import required modules
  • Step 2: Initialize the APSIM model runner
  • Step 3: Define Objective Functions
  • Step 4a: Define decision variables (Approach 1 - direct List)
  • Step 3b: Define decision variables (Approach 2 - using add_control())
  • Step 5: Run the NSGA-II optimizer
  • Step 6: Plot the Pareto Front
  • Comparing objectives without mult-objective optimization

Support Development

• Support apsimNGpy development
  • How You Can Support
  • Contact
    • How to Contribute to apsimNGpy
  • Reporting Issues
  • Contributing Code
  • Updating Documentation
  • Testing your pull request or your contribution
• How to Cite apsimNGpy

Tutorials

• Comparing cultivars yield

CheatSheet

• apsimNGpy cheatsheet

API Reference

• apsimNGpy: API Reference
• ApsimModel
• ContinuousVariable
• CoreModel
• MixedVariable
• ModelTools
• apsimNGpy.core.base_data
• apsimNGpy.core.load_model
• apsimNGpy.core.runner
• apsimNGpy.core_utils.database_utils
• apsimNGpy.exceptions
• apsimNGpy.manager.soilmanager
• apsimNGpy.manager.weathermanager
• apsimNGpy.parallel.process
• apsimNGpy.validation.evaluator