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.

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

There are no docs about the output of hydromt-fiat #362

Open
1 task done
savente93 opened this issue Jul 24, 2024 · 0 comments
Open
1 task done

There are no docs about the output of hydromt-fiat #362

savente93 opened this issue Jul 24, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@savente93
Copy link
Contributor

hydomt_fiat version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Kind of issue

Docs are missing

Location of the documentation

???

Documentation problem

The documentation lists supported input data sources, which is good, but as a downstream user of HydroMT FIAT I would like better documentation about what output HydroMT FIAT can produce.

Suggested fix for documentation

While it's understandably unfeasible to describe every kind of data fiat could generate I would expect at least the following:

  1. Typical types of output data for reference by non-expert users
  2. description of what data is needed for the described common use case output (e.g. what you listed in step 1)
  3. Some general description on the kinds of data fiat can produce so that I as a downstream application user can more easily reason about what I can use from FIAT
  4. Listed units for the listed output types where possible, or a description of how these are determined.
@savente93 savente93 added the documentation Improvements or additions to documentation label Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant