Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ pyirf |ci| |codacy| |coverage| |doilatest|
:target: https://codecov.io/gh/cta-observatory/pyirf
.. |doilatest| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4740755.svg
:target: https://doi.org/10.5281/zenodo.4740755
.. |allversions|
:target:

*pyirf* is a python library for the generation of Instrument Response
Functions (IRFs) and sensitivities for the
Expand All @@ -24,11 +26,12 @@ Cherenkov Telescopes (IACTs).

Citing this software
--------------------
If you use a released version of this software for a publication,
please cite it by using the corresponding DOI:
If you use this software for a publication, please cite our publication and the software
DOI published to Zenodo that corresponds to the version of the software you are using:

- latest : |doilatest|
- all versions: `Please visit Zenodo <https://zenodo.org/record/5833284>`_ and select the correct version
- all versions: `Please visit Zenodo <https://zenodo.org/search?q=parent.id%3A4740755&f=allversions%3Atrue&l=list&p=1&s=10&sort=version>`_ and select the correct version


At this point, our latest publication is the `2023 ICRC proceeding <https://doi.org/10.22323/1.444.0618>`_, which you can
cite using the following bibtex entry, especially if using functionalities from ``pyirf.interpolation``:
Expand Down
31 changes: 20 additions & 11 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,29 @@ which this documentation is linked.

Citing this software
--------------------
If you use this software for a publication, please cite our publication and the software
DOI published to Zenodo that corresponds to the version of the software you are using:

.. |doilatest| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4740755.svg
:target: https://doi.org/10.5281/zenodo.4740755
.. |doi_v0.5.0| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4748994.svg
:target: https://doi.org/10.5281/zenodo.4748994
.. |doi_v0.4.0| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4304466.svg
:target: https://doi.org/10.5281/zenodo.4304466
- latest : |doilatest|
- all versions: `Please visit Zenodo <https://zenodo.org/search?q=parent.id%3A4740755&f=allversions%3Atrue&l=list&p=1&s=10&sort=version>`_ and select the correct version

If you use a released version of this software for a publication,
please cite it by using the corresponding DOI.
At this point, our latest publication is the `2023 ICRC proceeding <https://doi.org/10.22323/1.444.0618>`_, which you can
cite using the following bibtex entry, especially if using functionalities from ``pyirf.interpolation``:

.. code::

@inproceedings{pyirf-icrc-2023,
author = {Dominik, Rune Michael and Linhoff, Maximilian and Sitarek, Julian},
title = {Interpolation of Instrument Response Functions for the Cherenkov Telescope Array in the Context of pyirf},
usera = {for the CTA Consortium},
doi = {10.22323/1.444.0703},
booktitle = {Proceedings, 38th International Cosmic Ray Conference},
year=2023,
volume={444},
number={618},
location={Nagoya, Japan},
}

- latest : |doilatest|
- v0.5.0 : |doi_v0.5.0|
- v0.4.0 : |doi_v0.4.0|

.. toctree::
:maxdepth: 1
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ dependencies = [
[project.urls]
"Homepage" = "https://github.com/cta-observatory/pyirf"
"Bug Tracker" = "https://github.com/cta-observatory/pyirf/issues"
"Documentation" = "https://cta-observatory.github.io/pyirf"
"Documentation" = "https://pyirf.readthedocs.io/"
"Source Code" = "https://github.com/cta-observatory/pyirf"

[project.optional-dependencies]
Expand Down
Loading