miranda.gis package

GIS Operations module.

Submodules

miranda.gis._domains module

miranda.gis._domains.add_ar6_regions(ds: Dataset) → Dataset

Add the IPCC AR6 Regions to dataset.

Parameters:

ds (xarray.Dataset)

Returns:

xarray.Dataset

miranda.gis._domains.subset_domain(ds: Dataset | DataArray, domain: str, **kwargs) → Dataset | DataArray

Subset an xarray object according to a specific domain.

Parameters:

• ds (xarray.Dataset or xarray.DataArray)

• domain (str)

• **kwargs

Returns:

xarray.Dataset or xarray.DataArray

Notes

Requires installation of GIS libraries.

miranda.gis._domains.subsetting_domains(domain: str) → list

Provides the bounding box coordinates for specific domains.

Parameters:

domain ({“global”, “nam”, “can”, “qc”, “mtl”})

Returns:

np.array – North, West, South, and East coordinates

miranda.gis.utils module

Utility functions for GIS operations.

miranda.gis.utils.conservative_regrid(ds: DataArray | Dataset, ref_grid: DataArray | Dataset) → DataArray | Dataset

Perform a conservative_normed regridding.

Parameters:

• ds (xr.DataArray or xr.Dataset) – The dataset to regrid.

• ref_grid (xr.DataArray or xr.Dataset) – The reference grid.

Returns:

xr.DataArray or xr.Dataset – The regridded dataset.

miranda.gis.utils.threshold_mask(ds: Dataset | DataArray, *, mask: Dataset | DataArray, mask_cutoff: float | bool = False) → Dataset | DataArray

Land-Sea mask operations.

Parameters:

• ds (xr.Dataset or str or os.PathLike) – The dataset to be masked.

• mask (xr.Dataset or xr.DataArray) – The land-sea mask.

• mask_cutoff (float or bool) – The mask cutoff value.

Returns:

xr.Dataset or xr.DataArray – The masked dataset.