Skip to content

v0.8.1: HSP2 Add Python 3 Executable, Setup, Demos, and Docs

Compare
Choose a tag to compare
@aufdenkampe aufdenkampe released this 31 Mar 01:29
3b9f894

DOI

The Hydrologic Simulation Program–Python (HSP2 or HSPsquared) model is being developed by RESPEC as part of an internally funded research and development (R&D) project.

This release of HSP2, from 6/13/2020, is Python 3.x compatible and supports the major hydrology modules of HSPF -- PWATER, IWATER and HYDR. HSP2 is designed to work with Python 3.6, 3.7 and 3.8.

This release adds an executable file, setup instructions, demonstration Jupyter notebooks, and and other documentation developed during and after the March 24-25, 2020, collaborative workshop with LimnoTech.

Change Log

New Features

  • Installation instructions for Python 3 version, with Setup.py or with a conda environment.yml file.
  • A HSP2_Driver Windows executable (HSP2_Driver.exe, and associated files)
    • This allows a user to run HSP2 from the command line, similar to HSPF, enabling a user to run HSP2 without needing to do anything with python code or notebooks. The driver uses the PyQt5 file dialog to prompt for the name of the HDF5 file to run, or if that doesn’t exist yet you can give it the name of a UCI or WDM file to import. It also runs with the H5 file name on the command line.
  • Added a number Jupyter notebooks (Introduction.ipynb, Demo2.ipynb, Demo3.ipynb) and associated TutorialData to an updated Demo1.ipynb notebook, all tested with the new Python 3 codebase for HSP2.

Improvements

  • Updated conda environment (environment.yml) to use Python 3.7.
  • Git-track notebooks as binary. #35

Bug Fixes

  • Fixed issues in HSP2 hydrology to fully agree with HSPF (9a56943)