From 6b674aa67ed8e2228a8491edbc81879d77513f02 Mon Sep 17 00:00:00 2001 From: Maximilian Linhoff Date: Mon, 13 Oct 2025 10:38:57 +0200 Subject: [PATCH 1/2] Fix docs link, update citation section --- README.rst | 4 ++-- docs/index.rst | 31 ++++++++++++++++++++----------- pyproject.toml | 2 +- 3 files changed, 23 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index 310e06a12..2b95bb940 100644 --- a/README.rst +++ b/README.rst @@ -24,8 +24,8 @@ 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 `_ and select the correct version diff --git a/docs/index.rst b/docs/index.rst index 00d92469a..1546e7d26 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 `_ 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 `_, 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 diff --git a/pyproject.toml b/pyproject.toml index 4e6aa8989..bec530fbe 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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] From 9fd5f343929d93f53fd5e185b8659903616b8af8 Mon Sep 17 00:00:00 2001 From: Maximilian Linhoff Date: Mon, 13 Oct 2025 10:42:45 +0200 Subject: [PATCH 2/2] Fix link to all version on Zenodo --- README.rst | 5 ++++- docs/index.rst | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 2b95bb940..c39be817b 100644 --- a/README.rst +++ b/README.rst @@ -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 @@ -28,7 +30,8 @@ If you use this software for a publication, please cite our publication and the DOI published to Zenodo that corresponds to the version of the software you are using: - latest : |doilatest| -- all versions: `Please visit Zenodo `_ and select the correct version +- all versions: `Please visit Zenodo `_ and select the correct version + At this point, our latest publication is the `2023 ICRC proceeding `_, which you can cite using the following bibtex entry, especially if using functionalities from ``pyirf.interpolation``: diff --git a/docs/index.rst b/docs/index.rst index 1546e7d26..25e36d236 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,7 +40,7 @@ If you use this software for a publication, please cite our publication and the DOI published to Zenodo that corresponds to the version of the software you are using: - latest : |doilatest| -- all versions: `Please visit Zenodo `_ and select the correct version +- all versions: `Please visit Zenodo `_ and select the correct version At this point, our latest publication is the `2023 ICRC proceeding `_, which you can cite using the following bibtex entry, especially if using functionalities from ``pyirf.interpolation``: