search

fema-ffrd / ffrd-auto-reports

Automated report generation for FFRD HecRas Models
MIT License
0 stars 0 forks source link

Review & Test #1

Open zherbz opened 1 month ago

zherbz commented 1 month ago

Requesting a code review and independent testing of the tool for automated FFRD report generation. Currently, I would say 90 - 95% of all figure generation related to the report is complete and implemented into an automated workflow. Items remaining to be done are text, and table automation.

Testing Environments:

  1. Within the folder tests/ is a script 'report_runner.py' where you can test the tool against different geometry and plan HDF file paths (either S3 or local).
  2. Within the folder notebooks/ is a jupyter notebook file 'demo.ipynb' where you can try running the same tool but in a notebook environment. See below for issues related to this though.

Main Topics:

  1. There are still some kinks to be worked out here related to asyncio. The function 'auto_report' is wrapped in async to prevent asynchronous errors from occurring. The main cause is yet to be determined, but it seems it is either due to rashdf, API calls, or both. This is only a problem when trying to use the tool within a notebook.
  2. Deployment options are still tbd between a notebook, GUI, executable, etc. Looking for thoughts here since that is what FEMA will be wondering.
zherbz commented 1 month ago

Example figures generated for some of the submitted models from the Trinity pilot study

EaFT-Lavon.zip LT-BelowRichlandCha.zip C-MillCrk.zip

wolfpack-daragon commented 1 month ago

I think the figures (and report) so far are looking great. I recall from the last meeting a few requests (please add where your notes show additional items):

A comment: We could start building out the test suite to include unit tests alongside your integration test approach for subsequent development work.