You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The primary method for determining what variables are needed to calculate a given index or indicator is to look at the call signature (sometimes very busy) and/or the Parameters entries. This can be annoying for users as they might want to calculate something and gloss over a variable that might be required.
Potential Solution
Each index or indicator could list before the Parameters section a block that lists these requirements. e.g.:
Zeitsperre
changed the title
More clearly indicate the requirements for calculating indicators and indices, e.g. requires: tas, pr, snd (snow depth) to be calculated in input dataset (https://xclim.readthedocs.io/en/latest/api.html#xclim.indicators.atmos.drought_code, https://xclim.readthedocs.io/en/latest/indices.html#xclim.indices.fire._cffwis.drought_code)
More clearly indicate the requirements for calculating indicators and indices, e.g. `requires: tas, pr, snd
Jul 26, 2023
Zeitsperre
changed the title
More clearly indicate the requirements for calculating indicators and indices, e.g. `requires: tas, pr, snd
More clearly indicate the requirements for calculating indicators and indices
Jul 26, 2023
Question: does this relate to the HTML docs or the help you get within a Python shell ? If it's the HTML, we could possibly tweak the CSS to highlight some parameters.
Problem
The primary method for determining what variables are needed to calculate a given index or indicator is to look at the call signature (sometimes very busy) and/or the
Parameters
entries. This can be annoying for users as they might want to calculate something and gloss over a variable that might be required.Potential Solution
Each index or indicator could list before the
Parameters
section a block that lists these requirements. e.g.:The text was updated successfully, but these errors were encountered: