apsimngpy 1.5.1

APSIM next generation package interface

Links

Documentation

Publication.

apsimNGpy: The Next Generation Agroe-cosystem Simulation Library

apsimNGpy is an open-source framework for advanced agroecosystem modeling, built entirely in Python. It enables object-oriented, data-driven workflows for interacting with APSIM Next Generation models, offering capabilities for:

• Batch file simulation and model evaluation

• APSIMX file editing and parameter inspection

• Weather data retrieval and pre-processing

• Optimization and performance diagnostics

• Efficient soil profile development and validation

• Parameter sensitivity analysis

Python serves as the execution environment, integrating scientific computing, data analysis, and automation for sustainable agricultural systems.

Requirements

1. .NET SDK — install from https://learn.microsoft.com/en-us/dotnet/core/install/

2. Python 3.10+

3. APSIM Next Generation — ensure the directory containing Models.exe is added to your system PATH.

4. (Optional) Use the official APSIM installer for easiest setup.

5. Minimum 8 GB RAM recommended.

Installation

## Run APSIM in Python

Option 1 – Install from PyPI (stable)

pip install apsimNGpy

If using the uv virtual environment manager:

uv pip install apsimNGpy

Option 2 – Clone the development repository

git clone https://github.com/MAGALA-RICHARD/apsimNGpy.git
cd apsimNGpy
pip install .

Option 3 – Install directly from GitHub

pip install git+https://github.com/MAGALA-RICHARD/apsimNGpy.git

APSIM Next Generation (NG) Installation Tip

Use the pinned APSIM release indicated on the documentation homepage to avoid forward-compatibility issues. The pinned version represents the latest APSIM NG build verified against apsimNGpy’s API and unit tests.