pywfm.IWFMZBudget.get_title_lines#

IWFMZBudget.get_title_lines(zone_id, area_conversion_factor=1.0, area_unit='SQ FT', volume_unit='CU FT')#

Return the title lines for the ZBudget data for a zone.

Parameters:

zone_id (int) – Zone identification number used to retrieve the title lines.
area_conversion_factor (int, float, default 1.0) – Factor used to convert area units between the default model unit and the desired output unit. e.g. ft^2 –> Acre = 2.29568E-05
area_unit (str, default 'SQ FT') – Desired output unit for area.
volume_unit (str, default 'CU FT') – Desired output unit for volume.

Returns:

Title lines for zone.

Return type:

list

Note

Title lines are useful for display when ZBudget data is imported into files (text, spreadsheet, etc.).

See also

IWFMZBudget.get_n_title_lines: Return the number of title lines in a ZBudget

Example

>>> from pywfm import IWFMZBudget
>>> zbud_file = '../Results/GW_ZBud.hdf'
>>> zone_defs = '../ZBudget/ZoneDef_SRs.dat'
>>> gw_zbud = IWFMZBudget(zbud_file)
>>> gw_zbud.generate_zone_list_from_file(zone_defs)
>>> gw_zbud.get_title_lines(1)
['IWFM (v2015.0.1273)',
 'GROUNDWATER ZONE BUDGET IN CU FT FOR ZONE 1 (Region1)',
 'ZONE AREA: 8610918912.00 SQ FT']
>>> gw_zbud.close_zbudget_file()