From 6f3d09068fdfb2e35ed799f13de601818b74c3bb Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Tue, 21 May 2019 12:08:53 -0300 Subject: [PATCH 01/10] Add doc/changes.rst --- doc/changes.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 doc/changes.rst diff --git a/doc/changes.rst b/doc/changes.rst new file mode 100644 index 00000000..9cfa3eba --- /dev/null +++ b/doc/changes.rst @@ -0,0 +1,25 @@ +.. _changes: + +Changelog +========= + +Version 0.1.0 +------------- + +*Released on: 2019/05/21* + +Fist release of Rockhound. Easily download geophysical models and datasets (PREM, +CRUST1.0, ETOPO1 and more) and load them into Python data structures (pandas, numpy, +xarray). + +Available models and datasets: + +- ETOPO1 +- PREM +- Bedmap2 +- Age of the oceanic lithosphere grids from NOAA NCEI website + +Features: + +- Use Pooch to download remote files, check if they are not corrupted and uncompress + files if necessary. From ff3d0d6c8bac14d0c9ff247b4004884e7b5bc80e Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Tue, 21 May 2019 14:57:23 -0300 Subject: [PATCH 02/10] Add changes.rst to doc/index.rst --- doc/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/index.rst b/doc/index.rst index d1b09cfa..418d67f1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -12,3 +12,4 @@ gallery/index.rst api/index.rst references.rst + changes.rst From 6c4755ef81bc07a18749da5933a46925b8c3804e Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Tue, 21 May 2019 15:16:42 -0300 Subject: [PATCH 03/10] Add references to datasets on changes.rst --- doc/changes.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index 9cfa3eba..437c4372 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -14,10 +14,10 @@ xarray). Available models and datasets: -- ETOPO1 -- PREM -- Bedmap2 -- Age of the oceanic lithosphere grids from NOAA NCEI website +- ETOPO1 [AmanteEakins2009]_ +- PREM [Dziewonsky1981]_ +- Bedmap2 [BEDMAP2]_ +- Age of the oceanic lithosphere [Muller2008]_ Features: From 5ee1fe1bc823b64a800191ef9a359ab5f7538521 Mon Sep 17 00:00:00 2001 From: Leonardo Uieda Date: Tue, 21 May 2019 08:20:47 -1000 Subject: [PATCH 04/10] Update doc/changes.rst --- doc/changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changes.rst b/doc/changes.rst index 437c4372..426ed18a 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -21,5 +21,5 @@ Available models and datasets: Features: -- Use Pooch to download remote files, check if they are not corrupted and uncompress +- Use `Pooch `__ to download remote files, check if they are not corrupted and decompress files if necessary. From 4794bbd266b14d02c8a30a54f470de66d7b00a90 Mon Sep 17 00:00:00 2001 From: Leonardo Uieda Date: Tue, 21 May 2019 08:30:26 -1000 Subject: [PATCH 05/10] Fix formatting --- doc/changes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index 426ed18a..66f4b5ac 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -21,5 +21,5 @@ Available models and datasets: Features: -- Use `Pooch `__ to download remote files, check if they are not corrupted and decompress - files if necessary. +- Use `Pooch `__ to download remote files, check if they + are not corrupted and decompress files if necessary. From fbdb02ad5a5a7cc13d90fc3249a5c9031f13762a Mon Sep 17 00:00:00 2001 From: Leonardo Uieda Date: Tue, 21 May 2019 08:32:13 -1000 Subject: [PATCH 06/10] Add DOI badge from Verde --- doc/changes.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/changes.rst b/doc/changes.rst index 66f4b5ac..136c9493 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -8,6 +8,9 @@ Version 0.1.0 *Released on: 2019/05/21* +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1478245.svg + :target: https://doi.org/10.5281/zenodo.1478245 + Fist release of Rockhound. Easily download geophysical models and datasets (PREM, CRUST1.0, ETOPO1 and more) and load them into Python data structures (pandas, numpy, xarray). From 08ab23b8c25632268d1e48c9c31c58e62d53692d Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Tue, 21 May 2019 15:34:36 -0300 Subject: [PATCH 07/10] Replace DOI with the reserved one for Rockhound --- doc/changes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index 136c9493..40beab4c 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -8,8 +8,8 @@ Version 0.1.0 *Released on: 2019/05/21* -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1478245.svg - :target: https://doi.org/10.5281/zenodo.1478245 +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3086002.svg + :target: https://doi.org/10.5281/zenodo.3086002 Fist release of Rockhound. Easily download geophysical models and datasets (PREM, CRUST1.0, ETOPO1 and more) and load them into Python data structures (pandas, numpy, From 982445d61063bfb27421f3b2aa86f8d3901722fb Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Tue, 21 May 2019 15:42:22 -0300 Subject: [PATCH 08/10] Add Zenodo badge to README.rst --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index fe2b8de4..5f3881f3 100644 --- a/README.rst +++ b/README.rst @@ -39,6 +39,9 @@ Part of the `Fatiando a Terra `__ project .. image:: https://img.shields.io/gitter/room/fatiando/fatiando.svg?style=flat-square :alt: Chat room on Gitter :target: https://gitter.im/fatiando/fatiando +.. image:: https://img.shields.io/badge/doi-10.5281%2Fzenodo.3086002-blue.svg?style=flat-square + :alt: Digital Object Identifier for the Zenodo archive + :target: https://doi.org/10.5281/zenodo.3086002 .. placeholder-for-doc-index From f08c1ff4bac9c664c4cfa8ab2adc3a43c88ab620 Mon Sep 17 00:00:00 2001 From: Leonardo Uieda Date: Tue, 21 May 2019 08:51:31 -1000 Subject: [PATCH 09/10] Add citation file and information --- CITATION.rst | 11 +++++++++++ README.rst | 12 ++++++++++++ doc/citing.rst | 3 +++ doc/index.rst | 1 + 4 files changed, 27 insertions(+) create mode 100644 CITATION.rst create mode 100644 doc/citing.rst diff --git a/CITATION.rst b/CITATION.rst new file mode 100644 index 00000000..0da6ddb2 --- /dev/null +++ b/CITATION.rst @@ -0,0 +1,11 @@ +Citing RockHound +================ + +This is research software **made by scientists**. Citations help us justify the effort +that goes into building and maintaining this project. + +If you used RockHound in your research, please consider citing it: + + Uieda, L., and Soler, S.R. (2019). Rockhound: Download geophysical models/datasets + and load them in Python (Version 0.1.0). Zenodo. https://doi.org/10.5281/zenodo.3086002 + diff --git a/README.rst b/README.rst index 5f3881f3..0658c722 100644 --- a/README.rst +++ b/README.rst @@ -92,6 +92,18 @@ Contacting Us where you can ask questions and leave comments. +Citing RockHound +---------------- + +This is research software **made by scientists** (see `AUTHORS.md +`__). Citations help us +justify the effort that goes into building and maintaining this project. If you used +RockHound for your research, please consider citing us. + +See our `CITATION.rst file `__ +to find out more. + + Contributing ------------ diff --git a/doc/citing.rst b/doc/citing.rst new file mode 100644 index 00000000..9c76d397 --- /dev/null +++ b/doc/citing.rst @@ -0,0 +1,3 @@ +.. _citing: + +.. include:: ../CITATION.rst diff --git a/doc/index.rst b/doc/index.rst index 418d67f1..32ee2ba6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,6 +8,7 @@ :caption: Documentation install.rst + citing.rst registry.rst gallery/index.rst api/index.rst From 0e0557c0ea14437dc5a09f92fa059b2efc58a713 Mon Sep 17 00:00:00 2001 From: Leonardo Uieda Date: Tue, 21 May 2019 08:53:06 -1000 Subject: [PATCH 10/10] Add link to v0.1.0 docs in the README --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index 0658c722..a2b4ecc2 100644 --- a/README.rst +++ b/README.rst @@ -163,3 +163,4 @@ Documentation for other versions * `Development `__ (reflects the *master* branch on Github) * `Latest release `__ +* `v0.1.0 `__