pywfm.IWFMBudget#

class pywfm.IWFMBudget(budget_file_name)#

IWFM Budget Class for interacting with the IWFM API

Parameters:: budget_file_name (str) – File path and name of the budget file.
Returns:: instance of the IWFMBudget class and access to the IWFM Budget fortran procedures.
Return type:: IWFMBudget Object

__init__(budget_file_name)#

Methods

`__init__`(budget_file_name)
`close_budget_file`()	Close an open budget file for an IWFM model application
`close_log_file`()
`get_budget_type_ids`()
`get_column_headers`(location_id[, ...])	Return the column headers for a budget location.
`get_data_unit_type_id_area`()
`get_data_unit_type_id_length`()
`get_data_unit_type_ids`()
`get_data_unit_type_volume`()
`get_flow_destination_type_id`()
`get_flow_destination_type_id_element`()
`get_flow_destination_type_id_elementset`()
`get_flow_destination_type_id_gwelement`()
`get_flow_destination_type_id_lake`()
`get_flow_destination_type_id_outside`()
`get_flow_destination_type_id_streamnode`()
`get_flow_destination_type_id_subregion`()
`get_land_use_type_id_gen_ag`()
`get_land_use_type_id_native_riparian`()
`get_land_use_type_id_nonponded_ag`()
`get_land_use_type_id_refuge`()
`get_land_use_type_id_rice`()
`get_land_use_type_id_urban`()
`get_land_use_type_id_urban_indoor`()
`get_land_use_type_id_urban_outdoor`()
`get_land_use_type_ids`()
`get_land_use_type_ids_1`()
`get_last_message`()	the error message in case a procedure call from IWFM API returns an error code (status) other than 0
`get_location_names`()	Retrieve the location names e.g. subregion names, lake names, etc.
`get_location_type_id_bypass`()
`get_location_type_id_diversion`()
`get_location_type_id_element`()
`get_location_type_id_gwheadobs`()
`get_location_type_id_lake`()
`get_location_type_id_node`()
`get_location_type_id_smallwatershed`()
`get_location_type_id_streamhydobs`()
`get_location_type_id_streamnode`()
`get_location_type_id_streamnodebud`()
`get_location_type_id_streamreach`()
`get_location_type_id_subregion`()
`get_location_type_id_subsidenceobs`()
`get_location_type_id_tiledrainobs`()
`get_location_type_id_zone`()
`get_location_type_ids`()
`get_location_type_ids_1`()
`get_n_columns`(location_id)	Retrieve the number of budget data columns for a specified location.
`get_n_intervals`(begin_date, end_date, ...[, ...])	returns the number of time intervals between a provided start date and end date
`get_n_locations`()	Return the number of locations where budget data is available.
`get_n_time_steps`()	Return the number of time steps where budget data is available.
`get_n_title_lines`()	Return the number of title lines for a water budget of a location.
`get_supply_type_id_diversion`()
`get_supply_type_id_elempump`()
`get_supply_type_id_well`()
`get_time_specs`()	Return a list of all the time stamps and the time interval for the budget.
`get_title_length`()	Retrieve the length of the title lines.
`get_title_lines`(location_id[, ...])	Return the title lines for the budget data.
`get_values`(location_id[, columns, ...])	Return budget data for selected budget columns for a location and specified time interval.
`get_values_for_a_column`(location_id, column_name)	Return the budget data for a single column and location for a specified beginning and ending dates.
`get_version`()	returns the version of the IWFM DLL
`get_zbudget_type_ids`()
`get_zone_extent_id_horizontal`()
`get_zone_extent_id_vertical`()
`get_zone_extent_ids`()
`increment_time`(date_string, time_interval, ...)	increments the date provided by the specified time interval
`is_date_greater`(first_date, comparison_date)	returns True if first_date is greater than comparison_date
`log_last_message`()	prints the last error message (generated when a procedure call from IWFM API returns an error code (status) other than 0) to the message log file
`set_log_file`([file_name])	opens a text log file to print out error and warning messages