pywfm.IWFMBudget.get_title_lines

IWFMBudget.get_title_lines(location_id, area_conversion_factor=1.0, length_units='FT', area_units='SQ FT', volume_units='CU FT', alternate_location_name=None)

Return the title lines for the budget data.

Parameters:

• location_id (int) – ID for location (1 to number of locations)

• area_conversion_factor (float, default=1.0) –

  Factor to convert budget file area units to user desired output area units.

  Note

  Only the area shows up in the title lines.

• length_units (str, default='FT') – Units of length used in the budget results.

• area_units (str, default='SQ FT') – Units of area used in the budget results.

• volume_units (str, default='CU FT') – Units of volume used in the budget results.

• alternate_location_name (str, optional) – Alternate name for location given by the location_id.

Returns:

Titles generated for the Budget.

Return type:

list

Note

Conversion from model area units of SQ FT to Acres is 2.29568E-05.

Example

>>> from pywfm import IWFMBudget
>>> bud_file = '../Results/GW.hdf'
>>> gw_bud = IWFMBudget(bud_file)
>>> gw_bud.get_title_lines(1)
['IWFM (v2015.0.1273)',
 'GROUNDWATER BUDGET IN cu ft FOR Region1 (SR1)',
 'SUBREGION AREA: 8610918912.00 sq ft']
>>> gw_bud.close_budget_file()