Add citation info

fmaussion · Jul 6, 2018 · 48676f5 · 48676f5
1 parent baa9b4a
commit 48676f5
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 13 deletions.
diff --git a/README.rst b/README.rst
@@ -41,13 +41,10 @@ About
 -----
 
 :Status:
-    Experimental - in development
+    Beta - in development
 
 :License:
     3-clause BSD
 
-:Authors:
+:Contact:
     `Fabien Maussion <http://fabienmaussion.info/>`_
-
-:Funding:
-    .. image:: http://acinn.uibk.ac.at/sites/all/themes/imgi/images/acinn_logo.png
diff --git a/docs/examples/plot_change_style.py b/docs/examples/plot_change_style.py
@@ -27,7 +27,7 @@
 smap.set_lonlat_contours(add_ytick_labels=False, interval=5, linewidths=1.5,
                          linestyles='-', colors='C1')
 
-# Add a scalebar
+# Add a scalebar (experimental)
 smap.set_scale_bar(location=(0.87, 0.04), add_bbox=True)
 
 # done!

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -11,6 +11,31 @@ probably change in the future. Salem is well tested though, at least for the
 cases I encounter in my daily work.
 
 
+How should I cite salem?
+------------------------
+
+If you are using salem and would like to cite it in academic publication, we
+would certainly appreciate it. We recommend to use the zenodo DOI for
+this purpose:
+
+    .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1295582.svg
+       :target: https://doi.org/10.5281/zenodo.1295582
+
+An example BibTeX entry::
+
+    @misc{salem_v022,
+      author       = {Fabien Maussion and
+                      tbridel and
+                      Schlump and
+                      Daniel Rothenberg},
+      title        = {fmaussion/salem: v0.2.2},
+      month        = jun,
+      year         = 2018,
+      doi          = {10.5281/zenodo.1295582},
+      url          = {https://doi.org/10.5281/zenodo.1295582}
+    }
+
+
 .. _faqtools:
 
 What others tools should I know about?

diff --git a/docs/index.rst b/docs/index.rst
@@ -56,17 +56,38 @@ Salem is available under the open source `3-clause BSD license`_.
 .. _3-clause BSD license: https://en.wikipedia.org/wiki/BSD_licenses
 
 
+Citation
+--------
+
+If you are using salem and would like to cite it in academic publication, we
+would certainly appreciate it. We recommend to use the zenodo DOI for
+this purpose:
+
+    .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1295582.svg
+       :target: https://doi.org/10.5281/zenodo.1295582
+
+
 About
 -----
 
-:Status:
-    Experimental - in development
-
 :License:
     3-clause BSD
 
-:Authors:
+:Status:
+    .. image:: https://badge.fury.io/py/salem.svg
+        :target: https://badge.fury.io/py/salem
+    .. image:: https://travis-ci.org/fmaussion/salem.svg?branch=master
+        :target: https://travis-ci.org/fmaussion/salem
+    .. image:: https://coveralls.io/repos/fmaussion/salem/badge.svg?branch=master&service=github
+        :target: https://coveralls.io/github/fmaussion/salem?branch=master
+
+:Documentation:
+    .. image:: https://readthedocs.org/projects/salem/badge/?version=stable
+        :target: http://salem.readthedocs.io/en/stable/?badge=stable
+
+:Citation:
+    .. image:: https://zenodo.org/badge/42607422.svg
+        :target: https://zenodo.org/badge/latestdoi/42607422
+
+:Contact:
     `Fabien Maussion <http://fabienmaussion.info/>`_
-
-:Funding:
-    .. image:: http://acinn.uibk.ac.at/sites/all/themes/imgi/images/acinn_logo.png
diff --git a/readthedocs.yml b/readthedocs.yml
@@ -5,3 +5,4 @@ conda:
 python:
     version: 3.6
     setup_py_install: true
+formats: []