Ouranosinc / xclim

Library of derived climate variables, ie climate indicators, based on xarray.
https://xclim.readthedocs.io/en/stable/
Apache License 2.0
322 stars 56 forks source link

DOCS: Better documentation for climate indicators and indices #1395

Open SarahG-579462 opened 1 year ago

SarahG-579462 commented 1 year ago

Addressing a Problem?

The current documentation for climate indicators (https://xclim.readthedocs.io/en/latest/indicators.html) is very hard to read: lines extend indefinitely, all indicators are on the same page, and details about the calculations and inputs require jumping between multiple places in the documentation. Some indicators have extra parameters (e.g. id) that others don't. The realm for "atmos" is very large, making searching for the correct indicator quite laborious.

The documentation on the difference between indices and indicators isn't located in an easily accessible location, currently it's in "examples > extending xclim > indices vs indicators". There is some description on the pages themselves for indicators/indices, but it does not link to this page.

The indices module does not distinguish realms, making searching laborious (e.g., 599 results for "temperature"...)

Potential Solution

Additional context

No response

Contribution

Code of Conduct

Zeitsperre commented 1 year ago

Related issue: #1312

Zeitsperre commented 1 year ago

@SarahG-579462

potentially have a link from these to atmos in the atmos/init.py, as from xc.core.indicators.atmos.temperature import *, for example

I feel like we already do this, no?