apsimNGpy Documentation

apsimNGpy: The Next-Generation Agro-ecosystem Simulation Library

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 (not yet on pipy). We expose a large bunch of local and global optimization algorithms, including genetic multi-objective optimizations ones

• Global and local sensitivity analysis

• Distributed computing framework.

Table of Contents

• Home
• 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
    • Now that the path is set, you can import any module attached to pythonnet.
• Examples
• Inspect Model
  • Model Types
  • Finding the Model Type
• Whole Model inspection
  • Note on Model Inspection:
• Inspect Model Parameters
  • What is inspect_model_parameters?
  • inspect_model_parameters function signature
• Editing Model Parameters
  • Parameters
    • Raises
• Command-Line Usage Guide
  • Usage
  • Options
  • Example Usage
  • Logging
  • Troubleshooting
• 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
  • Conclusion
• apsimNGpy: API Reference
• ApsimModel
  • apsimNGpy.core.apsim.ApsimModel()
  • apsimNGpy.core.apsim.ApsimModel.adjust_dul()
  • apsimNGpy.core.apsim.ApsimModel.auto_gen_thickness_layers()
  • apsimNGpy.core.apsim.ApsimModel.replace_downloaded_soils()
  • apsimNGpy.core.apsim.ApsimModel.run_edited_file()
  • apsimNGpy.core.apsim.ApsimModel.spin_up()
• ContinuousVariableProblem
  • apsimNGpy.optimizer.one_obj.ContinuousVariableProblem()
  • apsimNGpy.optimizer.one_obj.ContinuousVariableProblem.minimize_with_local_solver()
  • apsimNGpy.optimizer.one_obj.ContinuousVariableProblem.optimize_with_differential_evolution()
• CoreModel
  • apsimNGpy.core.core.CoreModel()
  • apsimNGpy.core.core.CoreModel.add_crop_replacements()
  • apsimNGpy.core.core.CoreModel.add_db_table()
  • apsimNGpy.core.core.CoreModel.add_factor()
  • apsimNGpy.core.core.CoreModel.add_model()
  • apsimNGpy.core.core.CoreModel.add_report_variable()
  • apsimNGpy.core.core.CoreModel.change_report()
  • apsimNGpy.core.core.CoreModel.change_simulation_dates()
  • apsimNGpy.core.core.CoreModel.change_som()
  • apsimNGpy.core.core.CoreModel.check_som()
  • apsimNGpy.core.core.CoreModel.clean_up()
  • apsimNGpy.core.core.CoreModel.clone_model()
  • apsimNGpy.core.core.CoreModel.create_experiment()
  • apsimNGpy.core.core.CoreModel.edit_cultivar()
  • apsimNGpy.core.core.CoreModel.edit_model()
  • apsimNGpy.core.core.CoreModel.examine_management_info()
  • apsimNGpy.core.core.CoreModel.extract_any_soil_physical()
  • apsimNGpy.core.core.CoreModel.extract_soil_physical()
  • apsimNGpy.core.core.CoreModel.extract_start_end_years()
  • apsimNGpy.core.core.CoreModel.find_model()
  • apsimNGpy.core.core.CoreModel.get_crop_replacement()
  • apsimNGpy.core.core.CoreModel.get_model_paths()
  • apsimNGpy.core.core.CoreModel.get_simulated_output()
  • apsimNGpy.core.core.CoreModel.get_weather_from_web()
  • apsimNGpy.core.core.CoreModel.inspect_file()
  • apsimNGpy.core.core.CoreModel.inspect_model()
  • apsimNGpy.core.core.CoreModel.inspect_model_parameters()
  • apsimNGpy.core.core.CoreModel.move_model()
  • apsimNGpy.core.core.CoreModel.preview_simulation()
  • apsimNGpy.core.core.CoreModel.recompile_edited_model()
  • apsimNGpy.core.core.CoreModel.remove_model()
  • apsimNGpy.core.core.CoreModel.rename_model()
  • apsimNGpy.core.core.CoreModel.replace_model_from()
  • apsimNGpy.core.core.CoreModel.replace_soil_property_values()
  • apsimNGpy.core.core.CoreModel.replace_soils_values_by_path()
  • apsimNGpy.core.core.CoreModel.replicate_file()
  • apsimNGpy.core.core.CoreModel.restart_model()
  • apsimNGpy.core.core.CoreModel.run()
  • apsimNGpy.core.core.CoreModel.save()
  • apsimNGpy.core.core.CoreModel.save_edited_file()
  • apsimNGpy.core.core.CoreModel.set_categorical_factor()
  • apsimNGpy.core.core.CoreModel.set_continuous_factor()
  • apsimNGpy.core.core.CoreModel.show_met_file_in_simulation()
  • apsimNGpy.core.core.CoreModel.update_cultivar()
  • apsimNGpy.core.core.CoreModel.update_mgt()
  • apsimNGpy.core.core.CoreModel.update_mgt_by_path()
• ModelTools
  • apsimNGpy.core._modelhelpers.ModelTools()
• apsimNGpy.core.base_data
  • apsimNGpy.core.base_data.load_default_sensitivity_model()
  • apsimNGpy.core.apsimSoilModel
• apsimNGpy.core.load_model
• apsimNGpy.core.runner
  • apsimNGpy.core.runner.collect_csv_by_model_path()
  • apsimNGpy.core.runner.collect_csv_from_dir()
  • apsimNGpy.settings.config_internal()
  • apsimNGpy.core.runner.get_apsim_version()
  • apsimNGpy.core.runner.run_from_dir()
  • apsimNGpy.core.runner.run_model_externally()
  • apsimNGpy.core.runner.upgrade_apsim_file()
• apsimNGpy.core_utils.database_utils
  • apsimNGpy.core_utils.database_utils.clear_table()
  • apsimNGpy.core_utils.database_utils.dataview_to_dataframe()
  • apsimNGpy.core_utils.database_utils.get_db_table_names()
  • apsimNGpy.core_utils.database_utils.read_with_query()
  • apsimNGpy.core_utils.exceptionsTableNotFoundError
• apsimNGpy.manager.soilmanager
  • apsimNGpy.manager.soilmanager.DownloadsurgoSoiltables()
  • apsimNGpy.manager.soilmanager.set_depth()
• apsimNGpy.manager.weathermanager
  • apsimNGpy.manager.weathermanager.daterange()
  • apsimNGpy.manager.weathermanager.day_of_year_to_date()
  • apsimNGpy.manager.weathermanager.get_iem_by_station()
  • apsimNGpy.manager.weathermanager.merge_columns()
• apsimNGpy.parallel.process
  • apsimNGpy.parallel.process.custom_parallel()
  • apsimNGpy.parallel.process.download_soil_tables()
  • apsimNGpy.parallel.process.run_apsimx_files_in_parallel()
  • apsimNGpy.core_utils.run_utils.run_model()
• apsimNGpy.validation.evaluator
  • apsimNGpy.validation.evaluatorMetrics
  • apsimNGpy.validation.evaluatorvalidate