Skip to content

Commit

Permalink
Add JOSS DOI to README and docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
DanRyanIrish committed Sep 23, 2023
1 parent d18b957 commit 516e18e
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
============

Expand Down
18 changes: 18 additions & 0 deletions docs/acknowledging.rst
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ where appropriate.

introduction
installation
acknowledging
explaining_ndcube/index
reference/index
generated/gallery/index
Expand Down

0 comments on commit 516e18e

Please sign in to comment.