English and French metadata overhaul

[Zeitsperre]

Pull Request Checklist:

• This PR addresses an already opened issue (for bug fixes / features)
  • This PR fixes More in-depth French Indicators metadata adjustments #936
  • This PR fixes Adopt operators in hot_spell_frequency and hot_spell_max_length #1194
  • This PR fixes freshet_start and first_day_tg_above are identical indices #1195
• Tests for the changes have been added (for bug fixes / features)
  • (If applicable) Documentation has been added / updated (for bug fixes / features)
• HISTORY.rst has been updated (with summary of main changes)
  • Link to issue (:issue:number) and pull request (:pull:number) has been added
• The relevant author information has been added to .zenodo.json

What kind of change does this PR introduce?

• Applies many changes to English indicator metadata (removal of auto-formatted fields in the long_name, shortened long_name fields, uniform capitalization)
  • In general, lengths of fields follow this progression, from shortest to longest:
    • title → long_name → abstract → description
• Frequencies for indicators are only shown in "description".
• English indicators now have an explicit title and abstract to make their French translations.
• French translations of metadata apply many agreed-upon conventions:
  • journalier → quotidien
  • longueur → durée
  • Température quotidienne min/max → Température minimale/maximale quotidienne
  • Précipitation et température au singulier
  • percentile → centile
  • Xieme → Xᵉ
  • Pluvieux → avec précipitation
  • Seuil → Seuil donné (where applicable)

Does this PR introduce a breaking change?

Yes. All metadata fields in indicators, both in English and in French, are affected. Tested indicator metadata has been updated in tests.

Other information:

[Zeitsperre]

@coxipi I was forced to remove the changes you made to freshet_start as this PR is deprecating that indice. If you'd like to add your run_length changes to first_day_temperature_{above | below} feel free to do so in this PR!

[coxipi]

@coxipi I was forced to remove the changes you made to freshet_start as this PR is deprecating that indice. If you'd like to add your run_length changes to first_day_temperature_{above | below} feel free to do so in this PR!

Ok thanks, I'll take a look!

[coxipi]

@coxipi I was forced to remove the changes you made to freshet_start as this PR is deprecating that indice. If you'd like to add your run_length changes to first_day_temperature_{above | below} feel free to do so in this PR!

I think it's best to leave things as they are. The situation is similar to the function season: there's a very specific workflow in mind, i.e. resample with "YS" and check for runs with a given date mm-dd in mind. I didn't add the option to resample after run_length as it would be more confusing than anything else. I don't remember if the situation was similar with freshet_start, but if so, I'd say it's a good thing you had to remove this, thanks!

(If you disagree and believe this could be useful, let me know)

[Zeitsperre]

@coxipi I was forced to remove the changes you made to freshet_start as this PR is deprecating that indice. If you'd like to add your run_length changes to first_day_temperature_{above | below} feel free to do so in this PR!

I think it's best to leave things as they are. The situation is similar to the function season: there's a very specific workflow in mind, i.e. resample with "YS" and check for runs with a given date mm-dd in mind. I didn't add the option to resample after run_length as it would be more confusing than anything else. I don't remember if the situation was similar with freshet_start, but if so, I'd say it's a good thing you had to remove this, thanks!

(If you disagree and believe this could be useful, let me know)

I completely agree. I don't see how this indicator would be useful outside an annual context, so no need!

[Zeitsperre]

@aulemahal This change seems to be crashing in the CLI tests:

degree_days_exceedance_date = Temp(
    title="Degree day exceedance date",
    identifier="degree_days_exceedance_date",
    units="",
    standard_name="day_of_year",
    long_name=lambda **kws: "Day of year when the integral of mean daily temperature {op} {thresh} exceeds {sum_thresh}"
    + (
        ", with the cumulative sum starting from {after_date}"
        if kws["after_date"] is not None
        else ""
    ),
    description=lambda **kws: "Day of year when the integral of degree days (mean daily temperature {op} {thresh}) "
    "exceeds {sum_thresh}"
    + (
        ", with the cumulative sum starting from {after_date}."
        if kws["after_date"] is not None
        else "."
    ),
    abstract="The day of the year when the sum of degree days exceeds a threshold, occurring after a given date. "
    "Degree days are calculated above or below a given temperature threshold.",
    cell_methods="",
    compute=indices.degree_days_exceedance_date,
)

I've seen the same way of accessing the call kwargs in saturation_vapour_pressure. Anything I'm missing here?

[aulemahal]

Aïe, it's because the xclim indices cli command didn't expect the long_name to be a function. All other uses of the lambda **kws method were on description.

May I suggest removing the last part from the long name (and thus go back to a simple string)? The information is still available in the description.

[juliettelavoie]

yeah!