hspf_utils.hspf_utils.parameters

hspf_utils.hspf_utils.parameters(uci, index_prefix='', index_delimiter='')

Develops a table of parameter values.

Parameters:

• uci –

  [optional, defaults to None]

  This uci file will be read to determine all of the areas and other aspects of the model. If available it will read the land cover names from the PERLND GEN-INFO table.

  The uci keyword and file is required if you want the water balance area-weighted between land covers.

  WARNING: The areas used come only from the SCHEMATIC block and if areas are adjusted by SPECIAL ACTIONS those changes are not used in the mass balance.

• index_prefix –

  [optional, defaults to ‘’]

  A string prepended to the PERLND code, which would allow being run on different models and collected into one dataset by creating a unique ID.

• index_delimiter (str) –

  [optional, defaults to ‘-‘]

  Useful to separate the index_prefix from the PERLND/IMPLND number.

• tablefmt (str) –

  [optional, default is ‘cvs_nos’]

  The table format. Can be one of ‘csv’, ‘tsv’, ‘csv_nos’, ‘tsv_nos’, ‘plain’, ‘simple’, ‘github’, ‘grid’, ‘fancy_grid’, ‘pipe’, ‘orgtbl’, ‘jira’, ‘presto’, ‘psql’, ‘rst’, ‘mediawiki’, ‘moinmoin’, ‘youtrack’, ‘html’, ‘latex’, ‘latex_raw’, ‘latex_booktabs’ and ‘textile’.

• float_format (str) –

  [optional, default is ‘.2f’]

  The format for floating point numbers in the output table.