hspf_reader.hspf_reader.hbn

hspf_reader.hspf_reader.hbn(hbnpath, interval, *labels, **kwds)

Prints out data to the screen from a HSPF binary output file.

Parameters:

  • hbnpath (str) – The HSPF binary output file. This file must have been created from a completed model run.

  • interval (str) – One of ‘yearly’, ‘monthly’, ‘daily’, or ‘bivl’. The ‘bivl’ option is a sub-daily interval defined in the UCI file. Typically ‘bivl’ is used for hourly output, but can be set to any value that evenly divides into a day and needs to match the BIVL setting in the model run.

  • labels (str) –

    The remaining arguments uniquely identify a time-series in the binary file. The format is ‘OPERATIONTYPE,ID,VARIABLEGROUP,VARIABLE’.

    For example: ‘PERLND,101,PWATER,UZS IMPLND,101,IWATER,RETS’

    Leaving a section without an entry will wild card that specification. To get all the PWATER variables for PERLND 101 the label would use:

    PERLND,101,PWATER,

    To get TAET for all PERLNDs:

    PERLND,,,TAET

    Note that there are spaces ONLY between label specifications not within the labels themselves.

    OPERATIONTYPE

    VARIABLEGROUP

    PERLND

    ATEMP, SNOW, PWATER, SEDMNT, PSTEMP, PWTGAS, PQUAL, MSTLAY, PEST, NITR, PHOS, TRACER

    IMPLND

    ATEMP, SNOW, IWATER, SOLIDS, IWTGAS, IQUAL

    RCHRES

    HYDR, CONS, HTRCH, SEDTRN, GQUAL, OXRX, NUTRX, PLANK, PHCARB, INFLOW, OFLOW, ROFLOW

    BMPRAC

    Not used Have to leave VARIABLEGROUP as a wild card. For example, ‘BMPRAC,875,,RMVOL’

    The Time Series Catalog in the HSPF Manual lists all of the variables in each of these VARIABLEGROUPs. For BMPRAC, all of the variables in all Groups in the Catalog are available in the unnamed (blank) Group.

    ID is the operation type identification number specified in the UCI file.

    Here, the user can specify:

    • a single ID number to match (1-999)

    • no entry, matching all ID’s in the hbn file

    • a range, specified as any combination of integers and groups of integers marked as “start:end”, with multiple allowed sub-ranges separated by the “+” sign.

    Example Label ID

    Expands to:

    1:10

    1,2,3,4,5,6,7,8,9,10

    11:14+19:22

    11,12,13,14,19,20,21,22

    3:5+7

    3,4,5,7

  • start_date (str) –

    [optional, defaults to first date in time-series, input filter]

    The start_date of the series in ISOdatetime format, or ‘None’ for beginning.

  • end_date (str) –

    [optional, defaults to last date in time-series, input filter]

    The end_date of the series in ISOdatetime format, or ‘None’ for end.

  • sort_columns –

    [optional, default is False]

    If set to False will maintain the columns order of the labels. If set to True will sort all columns by their columns names.