[Feature]: Shape file capablity for mean climate

[lee1043]

Is your feature request related to a problem?

Capability to apply shape file for mean climate metrics calculation.

Describe the solution you'd like

No response

Describe alternatives you've considered

No response

Additional context

No response

[lee1043]

@acordonez I recall you have implemented the shape file capability, could you point how this task could be initiated?

[acordonez]

@lee1043 The function is here: https://github.com/PCMDI/pcmdi_metrics/blob/main/pcmdi_metrics/io/region_from_file.py

It's a good idea to apply the shape file to all data files used, including things like the land/sea mask.

For an example of how to apply it, you can look at my edits to the precip variability code:
Parameters needed:

pcmdi_metrics/pcmdi_metrics/precip_variability/lib/argparse_functions.py

Lines 92 to 106 in 9d35ceb

	P.add_argument(
	"--region_file",
	dest="region_file",
	help="File containing vector region of interest.",
	default=None,
	)
	P.add_argument(
	"--feature", dest="feature", help="Feature in vectorized region.", default=None
	)
	P.add_argument(
	"--attr",
	dest="attr",
	help="Attribute containing feature in vectorized region.",
	default=None,
	)

Function call:

pcmdi_metrics/pcmdi_metrics/precip_variability/lib/lib_variability_across_timescales.py

Line 76 in 9d35ceb

rgtmp_ds = region_from_file(rgtmp_ds, fshp, attr, feature)

[lee1043]

@acordonez thank you for the information!