MESMER-group / mesmer

spatially-resolved ESM-specific multi-scenario initial-condition ensemble emulator
https://mesmer-emulator.readthedocs.io/en/latest/
GNU General Public License v3.0
22 stars 15 forks source link

deprecate mask_3D_frac_approx #451

Closed mathause closed 1 month ago

mathause commented 1 month ago

regionmask 0.12.0 offers it's own implementation of mask_3D_frac_approx, so at some point we can remove this function from mesmer. This takes the first step by marking it as deprecated.

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 85.71429% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 83.67%. Comparing base (9b0b76b) to head (ac9eacb). Report is 39 commits behind head on main.

Files Patch % Lines
mesmer/core/regionmaskcompat.py 75.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #451 +/- ## ========================================== - Coverage 87.90% 83.67% -4.24% ========================================== Files 40 44 +4 Lines 1745 1942 +197 ========================================== + Hits 1534 1625 +91 - Misses 211 317 +106 ``` | [Flag](https://app.codecov.io/gh/MESMER-group/mesmer/pull/451/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MESMER-group) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/MESMER-group/mesmer/pull/451/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MESMER-group) | `83.67% <85.71%> (-4.24%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MESMER-group#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

veni-vidi-vici-dormivi commented 1 month ago

Is that a function meant for the user? Wouldn't the user just use mask_ocean_fraction? Then we wouldn't need a depreciation.

mathause commented 1 month ago

Is that a function meant for the user? Wouldn't the user just use mask_ocean_fraction? Then we wouldn't need a depreciation.

Yes, I did it for the off-chance that anyone would be using it. For which the chance is like <= eps, but I couldn't help myself :anguished:

Thanks for the review - aren't you taking the day off?