farmingpy.apsim.APSIMX

farmingpy.apsim.APSIMX#

class APSIMX(model: str | Simulations, copy=True, out_path=None)[source]#

Modify and run Apsim next generation simulation models.

__init__(model: str | Simulations, copy=True, out_path=None)[source]#
Parameters:

  • model – Path to .apsimx file or C# Models.Core.Simulations object

  • copy – If True a copy of original simulation will be created on init, by default True.

  • optional – If True a copy of original simulation will be created on init, by default True.

  • out_path – Path of modified simulation, if None will be set automatically.

  • optional – Path of modified simulation, if None will be set automatically.

Methods

__init__(model[, copy, out_path])

clone_simulation(target[, simulation])

Clone a simulation and add it to Model

clone_zone(target, zone[, simulation])

Clone a zone and add it to Model

find_physical_soil([simulation])

Find physical soil

find_simulations([simulations])

Find simulations by name

find_zones(simulation)

Find zones from a simulation

get_agpasture_crops([simulations])

Get AgPasture crops from simulations.

get_bd([simulation])

Get soil bulk density

get_crop_ll([simulation])

Get crop lower limit

get_dates([simulations])

Get simulation dates

get_default_phenological_parameters([simulation])

Return all default parameters for a PMF crop in the simulation

get_dul([simulation])

Get soil dry upper limit (DUL)

get_initial_nh4([simulation])

Get soil initial NH4 content

get_initial_no3([simulation])

Get soil initial NO3 content

get_initial_urea([simulation])

Get soil initial urea content

get_ksat([simulation])

Get saturated hydraulic conductivity of soil mm/day

get_ll15([simulation])

Get soil water content lower limit (LL15)

get_management()

Get management of all simulations as dataframe

get_report([simulation])

Get current report string

get_sat([simulation])

Get soil saturated water content (SAT)

get_soil([simulation])

Get soil definition as dataframe

get_sw([simulation])

Get soil water content

get_swcon([simulation])

Get soil water conductivity (SWCON) constant for each soil layer.

print_cultivar([simulation])

Print current cultivar parameters, can be copied to APSIM user interface

remove_simulation(simulation)

Remove a simulation from the model

run([simulations, clean, multithread])

Run simulations

save([out_path])

Save the model

set_bd(bd[, simulations])

Set soil bulk density

set_crop_ll(ll[, simulations])

Set crop lower limit

set_dates([start_date, end_date, simulations])

Set simulation dates

set_dul(dul[, simulations])

Set soil dry upper limit (DUL)

set_initial_nh4(values[, simulations])

Set soil initial NH4 content

set_initial_no3(values[, simulations])

Set soil initial NO3 content

set_initial_urea(values[, simulations])

Set soil initial urea content

set_ksat(ksat[, simulations])

Set saturated hydraulic conductivity of soil mm/day

set_ll15(ll15[, simulations])

Set soil water content lower limit (LL15)

set_report(report[, simulations])

Set APSIM report

set_sat(sat[, simulations])

Set soil saturated water content (SAT)

set_soil(soildf[, simulations])

Set soil properties using a DataFrame

set_sw(sw[, simulations])

Set soil water content

set_swcon(swcon[, simulations])

Set soil water conductivity (SWCON) constant for each soil layer.

set_weather(weather_file[, simulations])

Set simulation weather file

show_management([simulations])

Show management

show_weather()

Show weather file for all simulations

update_cultivar(parameters[, simulations, clear])

Update cultivar parameters

update_management(management[, simulations, ...])

Update management

Attributes

simulations

results

Simulation results as dataframe