Skip to content

Commit 8a66f3b

Browse files
authored
Add Zenodo badge and cite information in README
1 parent b4d29da commit 8a66f3b

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed

README.rst

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,27 @@ ctaplot
44

55
ctaplot provides low-level reconstruction quality-checks metrics computation and vizualisation for Imaging Atmospheric Cherenkov Telescopes such as CTA
66

7+
.. image:: https://travis-ci.org/cta-observatory/ctaplot.svg?branch=master
8+
:target: https://travis-ci.org/cta-observatory/ctaplot
9+
:alt: Travis CI
710

8-
You may find examples in the `documentation <https://ctaplot.readthedocs.io/en/latest/>`_.
9-
Or you can run a simple one here:
11+
.. image:: https://readthedocs.org/projects/ctaplot/badge/?version=latest
12+
:target: https://ctaplot.readthedocs.io/en/latest/?badge=latest
13+
:alt: Documentation Status
14+
15+
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
16+
:target: https://opensource.org/licenses/MIT
17+
:alt: License: MIT
1018

1119
.. image:: https://mybinder.org/badge_logo.svg
12-
:target: https://mybinder.org/v2/gh/cta-observatory/ctaplot/master?filepath=examples%2Fnotebooks%2Fresolution_examples.ipynb
20+
:target: https://mybinder.org/v2/gh/cta-observatory/ctaplot/master?filepath=examples%2Fnotebooks
21+
22+
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5833854.svg
23+
:target: https://doi.org/10.5281/zenodo.5833854
24+
25+
26+
You may find examples in the `documentation <https://ctaplot.readthedocs.io/en/latest/>`_ and run them via mybinder.
27+
1328

1429
----
1530

@@ -29,21 +44,6 @@ In cases for which the CTA instrument response functions are used in a research
2944

3045
----
3146

32-
.. image:: https://travis-ci.org/cta-observatory/ctaplot.svg?branch=master
33-
:target: https://travis-ci.org/cta-observatory/ctaplot
34-
:alt: Travis CI
35-
36-
.. image:: https://readthedocs.org/projects/ctaplot/badge/?version=latest
37-
:target: https://ctaplot.readthedocs.io/en/latest/?badge=latest
38-
:alt: Documentation Status
39-
40-
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
41-
:target: https://opensource.org/licenses/MIT
42-
:alt: License: MIT
43-
44-
.. image:: https://mybinder.org/badge_logo.svg
45-
:target: https://mybinder.org/v2/gh/cta-observatory/ctaplot/master?filepath=examples%2Fnotebooks
46-
4747

4848
Install
4949
=======
@@ -122,3 +122,8 @@ When an experiment is deselected, it simply is removed from the plots.
122122
.. image:: /share/gammaboard.gif
123123
:alt: gammaboard_demo
124124

125+
126+
Cite
127+
====
128+
129+
We would appreciate you cite the version of ctaplot you used using the corresponding Zenodo DOI that cound find here: https://doi.org/10.5281/zenodo.5833854

0 commit comments

Comments
 (0)