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

DOCS: Better documentation for climate indicators and indices #1395

Open
5 of 8 tasks
SarahG-579462 opened this issue Jun 16, 2023 · 2 comments
Open
5 of 8 tasks

DOCS: Better documentation for climate indicators and indices #1395

SarahG-579462 opened this issue Jun 16, 2023 · 2 comments
Assignees
Labels
API Interfacing and User Concerns docs Improvements to documenation enhancement New feature or request standards / conventions Suggestions on ways forward
Milestone

Comments

@SarahG-579462
Copy link
Contributor

SarahG-579462 commented Jun 16, 2023

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

  • I would be willing/able to open a Pull Request to contribute this feature.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@SarahG-579462 SarahG-579462 added enhancement New feature or request API Interfacing and User Concerns docs Improvements to documenation labels Jun 16, 2023
@Zeitsperre Zeitsperre added the standards / conventions Suggestions on ways forward label Jun 19, 2023
@Zeitsperre
Copy link
Collaborator

Related issue: #1312

@Zeitsperre Zeitsperre added this to the v1.0 milestone Jul 25, 2023
@Zeitsperre Zeitsperre self-assigned this Jul 25, 2023
@Zeitsperre
Copy link
Collaborator

@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?

@Zeitsperre Zeitsperre modified the milestones: v1.0, Summer 2024 May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Interfacing and User Concerns docs Improvements to documenation enhancement New feature or request standards / conventions Suggestions on ways forward
Projects
Development

No branches or pull requests

2 participants