Merge pull request #825 from PCMDI/lee1043-patch-1

Prepare v2.2 release

README.md

@@ -3,7 +3,7 @@
 
 PCMDI Metrics Package (PMP)
 ======
-[![stable version](https://img.shields.io/badge/stable%20version-v2.1.1-brightgreen.svg)](https://github.com/PCMDI/pcmdi_metrics/releases/tag/v2.1.1)
+[![latest version](https://img.shields.io/badge/latest%20version-v2.2-brightgreen.svg)](https://github.com/PCMDI/pcmdi_metrics/releases/tag/v2.2)
 ![platforms](https://img.shields.io/badge/platforms-linux%20|%20osx-lightgrey.svg)
 [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.592790.svg)](https://doi.org/10.5281/zenodo.592790)
 [![Anaconda-Server Badge](https://anaconda.org/pcmdi/pcmdi_metrics/badges/installer/conda.svg)](https://conda.anaconda.org/pcmdi)
@@ -34,9 +34,11 @@ Some installation support for CMIP participating modeling groups is available: p
 PMP versions
 ------------
 
+- v2.2 - New metric implemented: precipitation variability across time scale
+- v2.1.2 - Minor update
 - v2.1.1 - Simplified dependent libraries and CI process
 - v2.1.0 - CMEC driver interfaced added.
-- v2.0 - New capabilities implemented: ENSO metrics, demos, documentations.
+- v2.0 - New capabilities: ENSO metrics, demos, and documentations.
 - v1.2 - Tied to CDAT 8.0. Now includes extensive regression testing. New metrics: Diurnal cycle and intermittency of precipitation, sample monsoon metrics.
 - v1.1.2 - Now managed through Anaconda, and tied to UV-CDAT 2.10. Weights on bias statistic added. Extensive provenance information incorporated into json files.
 - v1.1 - First public release, emphasizing climatological statistics, with development branches for ENSO and regional monsoon precipitation indices.

pcmdi_metrics/precip_variability/README.md

@@ -1,16 +1,20 @@
 # Precip variability across time scales
 
+Reference: Ahn, M.-S., P. J. Gleckler, J. Lee, A. G. Pendergrass, and C. Jakob, 2021: Benchmarking Simulated Precipitation Variability across Timescales. Journal of Climate (under review)
+
 ## Driver code:
-./variability_across_timescales_PS_driver.py
+- `variability_across_timescales_PS_driver.py`
 
 ## Parameter codes:
-./param/variability_across_timescales_PS_3hr_params_IMERG.py
-./param/variability_across_timescales_PS_3hr_params_TRMM.py
-./param/variability_across_timescales_PS_3hr_params_CMORPH.py
-./param/variability_across_timescales_PS_3hr_params_cmip5.py
-./param/variability_across_timescales_PS_3hr_params_cmip6.py
+- `param/`
+ - `variability_across_timescales_PS_3hr_params_IMERG.py`
+ - `variability_across_timescales_PS_3hr_params_TRMM.py`
+ - `variability_across_timescales_PS_3hr_params_CMORPH.py`
+ - `variability_across_timescales_PS_3hr_params_cmip5.py`
+ - `variability_across_timescales_PS_3hr_params_cmip6.py`
 
 ## Run scripts:
-./scripts_pcmdi/run_obs.bash
-./scripts_pcmdi/run_cmip5.bash
-./scripts_pcmdi/run_cmip6.bash
+- `scripts_pcmdi/`
+ - `run_obs.bash`
+ - `run_cmip5.bash`
+ - `run_cmip6.bash`

setup.cfg

@@ -29,6 +29,7 @@ exclude =
  *__init__.py
  venv
  *json
+ *md
 
 [isort]
 multi_line_output=3