Code and website documentation overhaul

[leoglonz]

Summary

A comprehensive overhaul aims to consolidate content, adding missing explanations, and providing consistent, accessible documentation across the gDM and hydroDL codebases and hydroDL docs website. In addition to addressing architectural updates, docs website should include an expanded roster of tutorials for users (beginners to advanced). As a benchmark, documentation should be as comprehensive as that present for neuralhydrology.

Actions

• Codebase changes:

  • All functions and classes, but especially those exposed to end users, should have useful and descriptive docstrings.
  • Where docstrings are already present, revise and update.
  • Type hints where possible.

• Website changes:

  • Split site into docs for hydroDL, gDM, hydroDL2, and hydro_data_dev; mark hydroDL as depreciated.
    • Add links to new repos.
  • Start by updating existing docs for each package split.
  • Expanded list of tutorials, including those for running dHBV1.0, dHBV1.1p, and dPRMS, as well as for how to build and integrate custom modules (think Trainers, NNs, physics models, loss functions).
  • Instructions for how to migrate from hydroDL.
  • Use mkdocs or similar to add all user-exposed functions/classes and their docstrings to website.
  • Add guidelines for contributing to repos.
  • Revise showcase for publications completed with these 𝛿model repos.
  • Benchmarks should be replicated where possible (related).

Considerations:

• What is the best way to mirror codebase docstrings into website?
• API service.

Assignments: @taddyb, @FRahmani368, @JiangtaoLiud, @Yalan-Song, @kasProg, @XuetingPu, @nrkraabel, @amirmoez98, @kelawson48, @DoaaAboelyazeed, @AMBehroozi, @leoglonz