iwfm.iwfm_read_elempump

iwfm.iwfm_read_elempump(elempump_file_name, elem_ids, ag=1, ur=2, comment=0, verbose=False)[source]

Read an IWFM Element Pumping file, and return lists for ICOLSK, FRACSK, IOPTSK, FRACSKL[Layer], TYPDSTSK, DSTSK, ICFIRIGSK, ICACJSK, ICSKMAX and FSKMAX for Ag and for Urban for each model element.

Parameters:

  • elem_ids (list) – element IDs

  • elempump_file_name (str) – IWFM Elemental Pumping file name

  • ag (int, default = 1) – Ag value in icfirigsk field

  • ur (int, default = 2) – Urban value in icfirigsk field

  • comment (int, default = 0) – How many comment fields on each line?

  • verbose (bool, default = False) – Print status messages

Returns:

  • elempump_ag and elempump_ur (lists of lists) –

    containing lists of length elements:

    id : element number, int icolsk : Time Series Pumping File data column, int fracsk : Fraction of icolsk, float ioptsk : Pumping distribution flag, int typdstsk : Delivery destination type, int dstsk : Delivery destination ID, int icfirigsk : Irrigation Fractsions Data File column, int icacjsk : Supply Adjustment Data Column, int icskmax : Time Series Pumping Data Column containing maximum pumping, int fskmax : fraction of icskmax data value, float fracskl[layers] : list of lists of length elements

  • header (list) – list of column headers