More extract features for RDRS

juliettelavoie commented 1 year ago

Pull Request Checklist:

[x] This PR addresses an already opened issue (for bug fixes / features)
- This PR fixes #180
[x] (If applicable) Documentation has been added / updated (for bug fixes / features)
[x] This PR does not seem to break the templates.
[x] HISTORY.rst has been updated (with summary of main changes)
- [x] Link to issue (:issue:number) and pull request (:pull:number) has been added

What kind of change does this PR introduce?

These features are in the ESPO-G workflow but I would like to have them in xscen to clean up the workflow. They were added because of RDRS.
feature mask: Either pass a dataset of a mask or find the mask in the catalog (need to do that in search_data_catalog). The mask is used to add nans to the data.
new region method sel: Instead of cutting on lat-lon (for ERA5-Land), I want to cut in rlat-rlon (for RDRS). I want this to be only defined in the config. I know it is a bit weird to put a non-clisops method in the clisops_subset function, but I also call this function in my workflow and I need it to cut the region regardless of if it is defined in rlat-rlon or lat-lon. Would it be too much of a breaking change to change the name of the function ?

Does this PR introduce a breaking change?

not, if we don't change the name of clisops_subset

Other information:

RondeauG commented 1 year ago

I just saw that clisops_subset still exists as is. I think that we should rather have:

def clisops_subset(ds, region):
     warning(blabla)
     ds_subset = xs.spatial.subset(ds, region)
     return ds_subset

So as not to duplicate the code twice and have an outdated version, especially since the new function should work perfectly well with the old arguments.

juliettelavoie commented 1 year ago

I just saw that clisops_subset still exists as is. I think that we should rather have:
def clisops_subset(ds, region):
     warning(blabla)
     ds_subset = xs.spatial.subset(ds, region)
     return ds_subset
So as not to duplicate the code twice and have an outdated version, especially since the new function should work perfectly well with the old arguments.

done!

juliettelavoie commented 1 year ago

In extract_dataset, we ask for the name in the definition of the region in order to update cat:domain. This field was not necessary in clisops_subset, but I made it necessary in spatial.subset.

Ouranosinc / xscen