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 fe2b8de4..a2b4ecc2 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 @@ -89,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 ------------ @@ -148,3 +163,4 @@ Documentation for other versions * `Development `__ (reflects the *master* branch on Github) * `Latest release `__ +* `v0.1.0 `__ diff --git a/doc/changes.rst b/doc/changes.rst new file mode 100644 index 00000000..40beab4c --- /dev/null +++ b/doc/changes.rst @@ -0,0 +1,28 @@ +.. _changes: + +Changelog +========= + +Version 0.1.0 +------------- + +*Released on: 2019/05/21* + +.. 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, +xarray). + +Available models and datasets: + +- ETOPO1 [AmanteEakins2009]_ +- PREM [Dziewonsky1981]_ +- Bedmap2 [BEDMAP2]_ +- Age of the oceanic lithosphere [Muller2008]_ + +Features: + +- Use `Pooch `__ to download remote files, check if they + are not corrupted and decompress files if necessary. 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 d1b09cfa..32ee2ba6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,7 +8,9 @@ :caption: Documentation install.rst + citing.rst registry.rst gallery/index.rst api/index.rst references.rst + changes.rst