Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cmahony committed Jan 8, 2025
1 parent 253ab95 commit 622d959
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,30 @@ subscribe to the `climr` GitHub repo using the following steps:

`climr` provides the following data:

- Two historical observational time series: (1) the 1901-2023 ClimateNA time series (Wang et al., 2016) and (2) the 1901-2022 combined Climatic Research Unit TS dataset (for temperature) and Global Precipitation Climatology Centre dataset (for precipitation).
- Two historical observational time series: (1) the 1901-2022 combined Climatic Research Unit TS dataset
(for temperature) and Global Precipitation Climatology Centre dataset (for precipitation) and (2) the 1901-2023 ClimateNA time series
(Wang et al., 2024).

- Multiple historical (1851-2014) and future (2015-2100) climate model simulations for each of 13 CMIP6 global climate models, in monthly time series and 20-year normals.
- Multiple historical (1851-2014) and future (2015-2100) climate model simulations
for each of 13 CMIP6 global climate models, in monthly time series and 20-year normals.

- User selection of single or multiple climate variables, with derived variables following the ClimateNA methodology of Wang et al. (2016).
- User selection of single or multiple climate variables, with derived variables
following the ClimateNA methodology of Wang et al. (2016).

### Data Sources

The high resolution reference climate maps for Western Canada and Western US are a custom 800m-resolution mosaic of [BC PRISM](https://www.pacificclimate.org/data/prism-climatology-and-monthly-timeseries), adjusted [US PRISM](https://prism.oregonstate.edu/normals/), [Western Canada PRISM](https://prism.oregonstate.edu/projects/canw.php), and [Daymet](https://daymet.ornl.gov/overview) (Alberta and Saskatchewan).
Reference climatologies for North America are the 4km-resolution ClimateNA (Wang et al. 2016) mosaics of PRISM (BC, US, W. Canada) and WorldClim (rest of North America).
The ClimateNA mosaics are accessed from [AdaptWest](https://adaptwest.databasin.org/pages/adaptwest-climatena/).
The default reference climate maps for North America are a
custom 2.5km-resolution mosaic of [BC PRISM](https://www.pacificclimate.org/data/prism-climatology-and-monthly-timeseries),
[US PRISM](https://prism.oregonstate.edu/normals/),
deep learning prediction (Yukon, Northwest Territories, and Alberta), and
[Daymet](https://daymet.ornl.gov/overview) (rest of North America).
The climr mosaic is described in [`vignette("climr_methods_mosaic")`](https://bcgov.github.io/climr/articles/methods_mosaic.html).
The alternative 4km-resolution ClimateNA mosaics of PRISM (BC, US, W. Canada) and WorldClim (rest of North America) are accessed from [AdaptWest](https://adaptwest.databasin.org/pages/adaptwest-climatena/).

Historical observational time series are obtained from [ClimateNA](https://climatena.ca/) (Wang et al. 2016), [Climatic Research Unit](https://crudata.uea.ac.uk/cru/data/hrg/), and [Global Precipitation Climatology Centre](https://psl.noaa.gov/data/gridded/data.gpcc.html).
The default historical observational time series are obtained from [Climatic Research Unit](https://crudata.uea.ac.uk/cru/data/hrg/), [Global Precipitation Climatology Centre](https://psl.noaa.gov/data/gridded/data.gpcc.html), and [ClimateNA](https://climatena.ca/) (Wang et al. 2016), .

CMIP6 global climate model simulations were downloaded from the [Earth System Grid Federation](https://aims2.llnl.gov/search/cmip6). The majority of these downloads were conducted by Tongli Wang, Associate Professor at the UBC Department of Forest and Conservation Sciences.
The 13 global climate models selected for `climr`, and best practices for ensemble analysis, are described in Mahony et al. (2022) and summarized in `vignette("climr_methods_ensembleSelection")`.
The 13 global climate models selected for `climr`, and best practices for ensemble analysis, are described in Mahony et al. (2022) and summarized in [`vignette("climr_methods_ensembleSelection")`](https://bcgov.github.io/climr/articles/methods_ensembleSelection.html).

## Installation

Expand All @@ -62,23 +70,15 @@ remotes::install_github("bcgov/climr@devl")

## Usage

See:

- `vignette("climr_workflow_beg")` for a simple `climr` workflow;

- `vignette("climr_workflow_int")` for a deeper dive into `climr`
and more advanced examples of how it can be used;

- `vignette("climr_with_rasters")` for several examples of how
to work with `climr` using spatial inputs and outputs, such as raster and vector data.
See `vignette("climr_workflow_beg")` to get started with simple `climr` workflows;

## Methods

For an overview of downscaling methods used in `climr` see `vignette("methods_downscaling")`

## Known issues

- Downloads of time series take a long time. We are looking into ways to speed this up, but until then we recommend users dedicate some time prior to analysis to cache their time series of interest for their areas of interest in a batch. Once the time series are cached, they don't need to be downloaded again.
- Downloads of time series take a long time. We recommend users dedicate some time prior to analysis to cache their time series of interest for their areas of interest in a batch. Once the time series are cached, they don't need to be downloaded again.
- We are still working on the documentation, examples, and vignettes. Please let us know if something isn't clear, preferably as a [GitHub](https://github.com/bcgov/climr) issue.

### License
Expand All @@ -103,4 +103,6 @@ We acknowledge the World Climate Research Programme, which, through its Working

Mahony, C.R., T. Wang, A. Hamann, and A.J. Cannon. 2022. [A global climate model ensemble for downscaled monthly climate normals over North America](https://rmets.onlinelibrary.wiley.com/doi/full/10.1002/joc.7566). International Journal of Climatology. 42:5871-5891. [doi.org/10.1002/joc.7566](https://doi.org/10.1002/joc.7566)

Wang, Tongli, Andreas Hamann, Dave Spittlehouse, and Carlos Carroll. 2016. “Locally Downscaled and Spatially Customizable Climate Data for Historical and Future Periods for North America.” Edited by Inés Álvarez. PLOS ONE 11 (6): [e0156720](https://doi.org/10.1371/journal.pone.0156720).
Wang, Tongli, Andreas Hamann, Dave Spittlehouse, and Carlos Carroll. 2016. “Locally Downscaled and Spatially Customizable Climate Data for Historical and Future Periods for North America.” Edited by Inés Álvarez. PLOS ONE 11 (6): [e0156720](https://doi.org/10.1371/journal.pone.0156720).

Wang, Tongli, Andreas Hamann, and Zihaohan Sang. 2024. “Monthly High-Resolution Historical Climate Data for North America Since 1901.” International Journal of Climatology. early view: [https://doi.org/10.1002/joc.8726](https://doi.org/10.1002/joc.8726).

0 comments on commit 622d959

Please sign in to comment.