Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Major task list #1

Open
2 of 13 tasks
markwang0 opened this issue Apr 25, 2024 · 0 comments
Open
2 of 13 tasks

Major task list #1

markwang0 opened this issue Apr 25, 2024 · 0 comments
Assignees
@mdp0023 @paolaPassaH2O @markwang0
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@markwang0
Copy link
Member

markwang0 commented Apr 25, 2024 •
edited by mdp0023
Loading

Major task list

  • Make sphinx website and documentation
    • create sphinx architecture
    • implement autodoc for pygeoflood class
    • deploy github action to automatically populate site
  • Populate documentation website
    • User guide
    • Getting started page
    • Background page
    • Jupyter notebook tutorials
    • Working examples
  • Calculate HAND with D-infinity flow directions #2
  • Unit tests
  • Change project's name to something that references compound flooding
  • Integrate FSM from RichDEM (pluvial)
  • Integrate c-HAND (coastal)
  • Method to load example data
  • Automate fetching NWM data, catchments, DEMs, streamlines, etc.
  • Plotting library
  • Evaluation library
    • Compare with validation data (remote sensing or hydrodynamic model)
    • TP/TN/FP/FN maps
  • GitHub workflow to format code on push
  • Live view web application
@markwang0 markwang0 added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mdp0023 mdp0023

@paolaPassaH2O paolaPassaH2O

@markwang0 markwang0

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mdp0023 @paolaPassaH2O @markwang0