API Reference#

This section provides detailed documentation of the available functionality built into the pywfm python library

Main PyWFM Classes#

The pywfm module is separated into three main classes and one base class.

The IWFMModel class is designed around the IWFM Model Object which allows for interacting with the model data

IWFMModel(preprocessor_file_name, ...[, ...])

IWFM Model Class for interacting with the IWFM API.

The IWFMBudget class is designed around the IWFM Budget application which summarizes model simulation results to a preset area or extent

IWFMBudget(budget_file_name)

IWFM Budget Class for interacting with the IWFM API

The IWFMZBudget class is designed around the IWFM ZBudget application which summarizes model simulation results to a user-customized area or extent

IWFMZBudget(zbudget_file_name)

IWFM ZBudget Class for interacting with the IWFM API.

The IWFMMiscellaneous class is designed around base functionality provided by IWFM. It provides internal IDs for different built-in types and utility functions for working with dates and string arrays.

misc.IWFMMiscellaneous()

IWFM Miscellaneous Class for interacting with the IWFM API

Class Reference#