respec / HSPsquared

Hydrologic Simulation Program Python (HSPsquared)
GNU Affero General Public License v3.0
43 stars 17 forks source link

Merge LimnoTech RQUAL class approach, GENER, expanded testing to RESPEC `develop` #61

Closed aufdenkampe closed 2 years ago

aufdenkampe commented 2 years ago

This PR initiates a dialog and testing phase for a large effort to develop and test detailed water quality modules from RQUAL (i.e. OXRX, NUTRX, PLANK, PHCARB) using a class-based approach, as described in this master issue:

... and including PRs:

This PR also includes implementation of the GENER module:

This PR also includes improved tested capabilities that expands to additional use cases, includes new RQUAL module code from #58, and substantially enhance performance. See:

We don't plan on merging this PR until we have satisfactorily tested the code with several different HSPF test cases.

cc: @tredder75, @ptomasula, @PaulDudaRESPEC

aufdenkampe commented 2 years ago

@tredder75 added today via email:

While I believe we are getting close to a fully successful test of the RQUAL modules with our priority project HSP2 application, that testing effort is still ongoing. I know we’ve discussed this and you are very well aware – but given the complexity of the modules and the range of input options, I think testing with multiple UCI configurations is going to be necessary before we can declare “victory” on those modules.

Two other limitations in the current RQUAL code that will probably be evident to you, but I wanted to highlight here:

  • Implementation is still needed for: - 1) nutrient wet/dry deposition, 2) plankton wet/dry deposition, and 3) benthic invertebrates. None of these factor into our current application, so I deprioritized those more complex inputs and just left placeholders in the code that will need to be addressed.

  • Outputs – have been focused on state variables and outflows, and so there is still work to do to add the various process fluxes, etc.

aufdenkampe commented 2 years ago

@PaulDudaRESPEC, thanks for the careful review!

We're excited to get all these new water quality capabilities into the next release!