Skip to content
This repository has been archived by the owner on Jun 30, 2022. It is now read-only.

Commit

Permalink
Changelog entries for 0.1.0 and CITATION info (#37)
Browse files Browse the repository at this point in the history
Add the stater changelog marking the first release.
Also add citation info and a CITATION.rst file referencing the Zenodo archive.
  • Loading branch information
santisoler authored and leouieda committed May 21, 2019
1 parent fd3435c commit e405e0e
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CITATION.rst
Original file line number Diff line number Diff line change
@@ -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

16 changes: 16 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ Part of the `Fatiando a Terra <https://www.fatiando.org>`__ 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
Expand Down Expand Up @@ -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
<https://github.com/fatiando/rockhound/blob/master/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 <https://github.com/fatiando/rockhound/blob/master/CITATION.rst>`__
to find out more.


Contributing
------------

Expand Down Expand Up @@ -148,3 +163,4 @@ Documentation for other versions
* `Development <https://www.fatiando.org/rockhound/dev>`__ (reflects the *master* branch on
Github)
* `Latest release <https://www.fatiando.org/rockhound/latest>`__
* `v0.1.0 <https://www.fatiando.org/rockhound/v0.1.0>`__
28 changes: 28 additions & 0 deletions doc/changes.rst
Original file line number Diff line number Diff line change
@@ -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 <https://www.fatiando.org/pooch>`__ to download remote files, check if they
are not corrupted and decompress files if necessary.
3 changes: 3 additions & 0 deletions doc/citing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. _citing:

.. include:: ../CITATION.rst
2 changes: 2 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
:caption: Documentation

install.rst
citing.rst
registry.rst
gallery/index.rst
api/index.rst
references.rst
changes.rst

0 comments on commit e405e0e

Please sign in to comment.