From 4a200403f85b65e45f3ff5f1e19a0435a1b0c897 Mon Sep 17 00:00:00 2001 From: Ian Bolliger Date: Fri, 8 Apr 2022 15:56:33 -0700 Subject: [PATCH] update DOI in readme --- README.md | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ad3c0c2..18f944e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6010452.svg)](https://doi.org/10.5281/zenodo.6010452) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6012027.svg)](https://doi.org/10.5281/zenodo.6012027) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6426191.svg)](https://doi.org/10.5281/zenodo.6426191) # Sea Level Impacts Input Dataset by Elevation, Region, and Scenario (SLIIDERS) -This repository hosts the code used to create the [SLIIDERS-ECON](https://doi.org/10.5281/zenodo.6010452) and [SLIIDERS-SLR](https://doi.org/10.5281/zenodo.6012027) datasets. The SLIIDERS datasets contain current and forecasted physical and socioeconomic metrics from 2000-2100 - organized by coastal segment, elevation slice, and scenario - for use as inputs to global coastal climate impacts research. +This repository hosts the code used to create the [SLIIDERS-ECON and SLIIDERS-SLR](https://doi.org/10.5281/zenodo.6426191) datasets. The SLIIDERS datasets contain current and forecasted physical and socioeconomic metrics from 2000-2100 - organized by coastal segment, elevation slice, and scenario - for use as inputs to global coastal climate impacts research. **SLIIDERS-ECON** contains socioeconomic variables, varying horizontally and vertically over space. **SLIIDERS-SLR** contains Monte Carlo projections of Local Sea Level Rise under different emissions and ice sheet dynamics assumptions, based on the outputs of [LocalizeSL](https://github.com/bobkopp/LocalizeSL). Coastal segments in SLIIDERS-ECON can be matched to gridded LSLR projections in SLIIDERS-SLR via the `SLR_site` key. All work utilizing this code or the resulting SLIIDERS datasets should cite Depsky, Bolliger et al. 2022 (in prep.). See [License](#license) for details. ## Installation + Most users will want to just use the datasets directly, accessible at the DOIs linked above. If you wish to recreate and/or modify the datasets, which we encourage, you will need to run the Jupyter notebooks in this repository. A collection of helper functions, organized into a Python package, is necessary to run the notebooks and can be found within the `sliiders` directory. A simple pip install will install this package ```bash @@ -21,19 +21,21 @@ In addition, you will need to have [Dask Gateway](https://gateway.dask.org) inst A Conda environment file better specifying a full environment needed to execute all of the workflows in this repo is in development and will be posted when complete. ## Filepaths and other settings + All filepaths and settings for the notebooks can be found within `settings.py`. Before moving onto executing different parts of this repository, please adjust these settings to match your directory structure and desired values. Most values will not need to be updated unless you change a particular dataset. However, at minimum you should: 1. Update the `DIR_DATA` filepath within this file to point to the root directory within which all of the data consumed and generated by this workflow will live. 2. Update `DASK_IMAGE` to point to a Docker Image that you will use for Dask workers (advanced users not using Dask Gateway may not need this parameter). ## Package Structure + * `sliiders`: Contains `.py` files with essential settings and functions for the SLIIDERS workflow - - `settings.py`: Contains essential settings, including various parameters and data storage directories - - `gcs.py`: Contains functions related to the use of Google Cloud Storage (GCS). Users running workflows locally or on a different cloud provider are encouraged to contribute similar modules for other contexts. - - `io.py`: Contains various I/O-related functions - - `spatial.py`: Contains functions for executing spatial and geographic operations including those related to shapefiles, grid-cell level operations, and more. - - `dask.py`: Contains utility functions for working with dask clusters - - `country_level_ypk.py`: Contains functions for cleaning and working with country-level socioeconomic data, especially for the workflow in `notebooks/country_level_ypk` + * `settings.py`: Contains essential settings, including various parameters and data storage directories + * `gcs.py`: Contains functions related to the use of Google Cloud Storage (GCS). Users running workflows locally or on a different cloud provider are encouraged to contribute similar modules for other contexts. + * `io.py`: Contains various I/O-related functions + * `spatial.py`: Contains functions for executing spatial and geographic operations including those related to shapefiles, grid-cell level operations, and more. + * `dask.py`: Contains utility functions for working with dask clusters + * `country_level_ypk.py`: Contains functions for cleaning and working with country-level socioeconomic data, especially for the workflow in `notebooks/country_level_ypk` * `notebooks`: contains the workflows to create SLIIDERS-ECON and SLIIDERS-SLR. @@ -70,23 +72,27 @@ The list and order of notebooks to run is reproduced in full here, along with an 9. `9-generate_exposure_tiles.ipynb` 10. `10-combine_exposure_tiles.ipynb` 4. `create-SLIIDERS-ECON.ipynb` - + The resulting datasets can be found at these paths, defined in `settings.py`: **SLIIDERS-ECON**: `PATH_SLIIDERS_ECON` **SLIIDERS-SLR**: `PATH_SLIIDERS_SLR` ## Support + Please file an issue for any problems you encounter. ## Contributing + We encourage community contributions. At the moment, we have no contribution template. Please fork the project and file a Merge Request to propose your addition. Clearly define the contribution that the Merge Request is making and, when any issues have been resolved, we will merge the new code. ## Authors + The original authors of this code include: -- Daniel Allen -- Ian Bolliger -- Junho Choi -- Nicholas Depsky +* Daniel Allen +* Ian Bolliger +* Junho Choi +* Nicholas Depsky ## License -This code is licensed under the [MIT License](./LICENSE). However, we request that wherever this code or the SLIIDERS datasets are used, that the underlying manuscript (Depsky et al. 2022) is cited. A citation guide will be posted once the manuscript preprint is available. \ No newline at end of file + +This code is licensed under the [MIT License](./LICENSE). However, we request that wherever this code or the SLIIDERS datasets are used, that the underlying manuscript (Depsky et al. 2022) is cited. A citation guide will be posted once the manuscript preprint is available.