Option to cap low winds to 0.5 m/s

[profesorpaiche]

Pull Request Checklist:

• This PR addresses an already opened issue (for bug fixes / features)
  • This PR fixes UTCI for low wind velocities #1634
• Tests for the changes have been added (for bug fixes / features)
  • (If applicable) Documentation has been added / updated (for bug fixes / features)
• CHANGES.rst has been updated (with summary of main changes)
  • Link to issue (:issue:number) and pull request (:pull:number) has been added

What kind of change does this PR introduce?

• Adds an option to the universal_thermal_climate_index function to cap low wind to a minimum of 0.5 m/s

Does this PR introduce a breaking change?

• No

Other information:

References for the change:

• https://link.springer.com/article/10.1007/s00484-011-0454-1
• https://www.mdpi.com/2079-7737/12/6/802

[github-actions]

Welcome, new contributor!

It appears that this is your first Pull Request. To give credit where it's due, we ask that you add your information to the AUTHORS.rst and .zenodo.json:

• The relevant author information has been added to AUTHORS.rst and .zenodo.json

Please make sure you've read our contributing guide. We look forward to reviewing your Pull Request shortly ✨

[profesorpaiche]

• The relevant author information has been added to AUTHORS.rst and .zenodo.json

[Zeitsperre]

Nice! Think you could add a really simple test under tests/test_indices.py?

[profesorpaiche]

I expanded the original UTCI test by trying two wind values (2 and 1 km/h, or 0.556 and 0.278 m/s) with and without the option to cap the minimum wind velocities. Now the test checks:

1. If the UTCI is similar to the expected value at wind velocity higher than 0.5 m/s (original test)
2. If the UTCI is NaN when the wind is lower than 0.5 m/s and wind_cap_min is set to False
3. If the UTCI is similar to the expected value when the wind velocity is lower than 0.5 m/s and wind_cap_min is set to True

[aulemahal]

This looks clean. Thanks @profesorpaiche!

[aulemahal]

Oh, would it be interesting to cite Bröde 2012 here ? Or below in the "references" section ?
In any case, the metadata for the publication has to be added to "docs/references.bib" before being cited here with :cite:t: or added to the :cite:cts: directive below.

[profesorpaiche]

I think is better to cite Bröde 2012 (and also Bröde 2023 Figure 2) here because the user may want to know a bit more context of this specific option. I will include both in the "docs/reference.bib" file and update the description

[profesorpaiche]

Included the article of Bröde 2012 in the description of wind_cap_min. This article is more than enough to explain wind_cap_min so I didn't include Bröde 2023

[coveralls]

coverage: 90.171% (+0.002%) from 90.169%
when pulling 3ac6c5d on profesorpaiche:utci-low-wind
into 41379c5 on Ouranosinc:master.

[Zeitsperre]

@profesorpaiche Thanks for the contribution!