From 516e18e2af3622bc99ee2006978081c50bf4a774 Mon Sep 17 00:00:00 2001 From: DanRyanIrish Date: Sat, 23 Sep 2023 12:37:36 +0200 Subject: [PATCH] Add JOSS DOI to README and docs. --- README.rst | 12 +++++++++++- docs/acknowledging.rst | 18 ++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 docs/acknowledging.rst diff --git a/README.rst b/README.rst index 20e537a1d..f7e29297e 100644 --- a/README.rst +++ b/README.rst @@ -19,12 +19,22 @@ ndcube .. |Powered by SunPy| image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat :target: http://www.sunpy.org :alt: SunPy +.. image:: https://joss.theoj.org/papers/10.21105/joss.05296/status.svg + :target: https://doi.org/10.21105/joss.05296 + :alt: JOSS -ndcube is an open-source SunPy affiliated package for manipulating, inspecting and visualizing multi-dimensional contiguous and non-contiguous coordinate-aware data arrays. +``ndcube`` is an open-source SunPy affiliated package for manipulating, inspecting and visualizing multi-dimensional contiguous and non-contiguous coordinate-aware data arrays. It combines data, uncertainties, units, metadata, masking, and coordinate transformations into classes with unified slicing and generic coordinate transformations and plotting/animation capabilities. It is designed to handle data of any number of dimensions and axis types (e.g. spatial, temporal, spectral, etc.) whose relationship between the array elements and the real world can be described by World Coordinate System (WCS) translations. +Acknowledging ndcube +==================== +If you use ``ndcube`` is your work, we kindly ask you to `acknowledge ndcube`_ in your +publications and presentations. + +.. _acknowledge ndcube: https://docs.sunpy.org/projects/ndcube/en/stable/acknowledging.html + Installation ============ diff --git a/docs/acknowledging.rst b/docs/acknowledging.rst new file mode 100644 index 000000000..08867a924 --- /dev/null +++ b/docs/acknowledging.rst @@ -0,0 +1,18 @@ +.. _acknowledging: + +************************ +Acknowledging ``ndcube`` +************************ + +If you use ``ndcube``, we kindly ask you to cite the following references in you publications: + +* Ryan, Mumford et al., ndcube: Manipulating N-dimensional Astronomical Data in Python, Journal of Open Source Software, 2023a, DOI: https://doi.org/10.21105/joss.05296 + +Citing these references helps to spread awareness of ``ndcube``'s capabilities and philosophy and +gives some credit to those who have volunteered their time in making ``ndcube`` possible. +To learn how to become part of the ``ndcube`` project, see :ref:`contributing`. + +You may also like to include the `ndcube logo`_ in your presentations. This helps to publicise +``ndcube`` to others who might find it helpful in their work. + +.. _ndcube logo: https://github.com/sunpy/ndcube/tree/ee94395cda5c8348a33bd1f9ff75fab976bdc66f/docs/logo diff --git a/docs/index.rst b/docs/index.rst index 818178b9a..c2aaf0839 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -78,6 +78,7 @@ where appropriate. introduction installation + acknowledging explaining_ndcube/index reference/index generated/gallery/index