diff --git a/README.rst b/README.rst index 98ebcab..ce3f9c0 100644 --- a/README.rst +++ b/README.rst @@ -37,29 +37,20 @@ Requirements Installation ------------ -Should be as easy as running ``pip install hspfbintoolbox`` or ``easy_install -hspfbintoolbox`` at any command line. Not sure on Windows whether this will -bring in pandas but as mentioned above, if you start with Python(x,y) then -you won't have a problem. +Should be as easy as running ``pip install hspfbintoolbox`` at any command +line. Not sure on Windows whether this will bring in pandas but as mentioned +above, if you start with Python(x,y) then you won't have a problem. Usage - Command Line -------------------- -Just run 'hspfbintoolbox' to get a list of subcommands: +Just run 'hspfbintoolbox --help' to get a list of subcommands: catalog Prints out a catalog of data sets in the binary file. - dump - Prints out ALL data from a HSPF binary output file. - extract Prints out data to the screen from a HSPF binary output file. -The default for all of the subcommands is to accept data from stdin -(typically a pipe). If a subcommand accepts an input file for an argument, -you can use "--infile=filename", or to explicitly specify from stdin use -"--infile='-'" . - For the subcommands that output data it is printed to the screen and you can then redirect to a file. @@ -75,7 +66,7 @@ Simply import hspfbintoolbox:: import hspfbintoolbox # Then you could call the functions - ntsd = hspfbintoolbox.dump('tests/test.hbn') + ntsd = hspfbintoolbox.extract('tests/test.hbn', 'yearly', ',905,,AGWS') # Once you have a PANDAS DataFrame you can use that as input. ntsd = tstoolbox.aggregate(statistic='mean', agg_interval='daily', input_ts=ntsd) diff --git a/docs/function_summary.rst b/docs/function_summary.rst index ad36e81..b41b705 100644 --- a/docs/function_summary.rst +++ b/docs/function_summary.rst @@ -8,5 +8,4 @@ Python API Function Summary hspfbintoolbox.hspfbintoolbox.about hspfbintoolbox.hspfbintoolbox.catalog - hspfbintoolbox.hspfbintoolbox.dump hspfbintoolbox.hspfbintoolbox.extract diff --git a/docs/index.rst b/docs/index.rst index b05d0f6..82a32f3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ hspfbintoolbox ============== This is the home page for `hspfbintoolbox`. The `hspfbintoolbox` is a -command line program and Python library functions to dump data out of +command line program and Python library functions to extract data out of Hydrological Simulation Program - FORTRAN (HSPF) binary output files. Should work with Python 3.6+. diff --git a/docs/readme.rst b/docs/readme.rst index 4afd1cc..e05e610 100644 --- a/docs/readme.rst +++ b/docs/readme.rst @@ -7,10 +7,6 @@ catalog ~~~~~~~ .. program-output:: hspfbintoolbox catalog --help -dump -~~~~ -.. program-output:: hspfbintoolbox dump --help - extract ~~~~~~~ .. program-output:: hspfbintoolbox extract --help diff --git a/src/hspfbintoolbox/hspfbintoolbox.py b/src/hspfbintoolbox/hspfbintoolbox.py index ba9c4fc..f5cd2cb 100644 --- a/src/hspfbintoolbox/hspfbintoolbox.py +++ b/src/hspfbintoolbox/hspfbintoolbox.py @@ -63,7 +63,7 @@ def tupleSearch(findme, haystack): def _get_data(binfilename, interval="daily", labels=None, catalog_only=True): """Underlying function to read from the binary file. Used by - 'extract', 'catalog', and 'dump'. + 'extract', 'catalog'. """ if labels is None: labels = [",,,"]