Metadata-Version: 2.4
Name: ndcube
Version: 2.3.2
Summary: A package for multi-dimensional contiguous and non-contiguous coordinate aware arrays.
Author-email: The SunPy Community <sunpy@googlegroups.com>
License: Copyright (c) 2024, The SunPy Community
        
        Redistribution and use in source and binary forms, with or without modification,
        are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
        ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://docs.sunpy.org/projects/ndcube
Project-URL: Source Code, https://github.com/sunpy/ndcube
Project-URL: Download, https://pypi.org/project/ndcube
Project-URL: Documentation, https://docs.sunpy.org/projects/ndcube
Project-URL: Changelog, https://docs.sunpy.org/projects/ndcube/en/stable/whatsnew/changelog.html
Project-URL: Issue Tracker, https://github.com/sunpy/ndcube/issues
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: astropy!=5.1.0,>=5.0.6
Requires-Dist: gwcs>=0.18
Requires-Dist: numpy>=1.23.0
Requires-Dist: scipy>=1.8.0
Provides-Extra: tests
Requires-Dist: dask; extra == "tests"
Requires-Dist: pytest-astropy; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-doctestplus; extra == "tests"
Requires-Dist: pytest-mpl>=0.12; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-memray; sys_platform != "win32" and extra == "tests"
Requires-Dist: scipy; extra == "tests"
Requires-Dist: specutils; extra == "tests"
Requires-Dist: sunpy>=5.0.0; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sunpy-sphinx-theme; extra == "docs"
Requires-Dist: packaging; extra == "docs"
Requires-Dist: matplotlib; extra == "docs"
Requires-Dist: mpl-animators>=1.0; extra == "docs"
Requires-Dist: sphinx-changelog>=1.1.0; extra == "docs"
Requires-Dist: sphinx-gallery; extra == "docs"
Requires-Dist: sphinxext-opengraph; extra == "docs"
Requires-Dist: sunpy>=5.0.0; extra == "docs"
Provides-Extra: plotting
Requires-Dist: matplotlib>=3.5.0; extra == "plotting"
Requires-Dist: mpl_animators>=1.0; extra == "plotting"
Provides-Extra: reproject
Requires-Dist: reproject>=0.7.1; extra == "reproject"
Provides-Extra: all
Requires-Dist: ndcube[plotting,reproject]; extra == "all"
Provides-Extra: dev
Requires-Dist: ndcube[docs,plotting,reproject,tests]; extra == "dev"
Dynamic: license-file

******
ndcube
******

|Latest Version| |codecov| |matrix| |Powered by NumFOCUS| |Powered by SunPy|

.. |Latest Version| image:: https://img.shields.io/pypi/v/ndcube.svg
   :target: https://pypi.python.org/pypi/ndcube/
   :alt: It is up to date, we promise
.. |matrix| image:: https://img.shields.io/matrix/ndcube:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=openastronomy.modular.im
   :target: https://app.element.io/#/room/#ndcube:openastronomy.org
   :alt: join us on #ndcube:openastronom.org on matrix
.. |codecov| image:: https://codecov.io/gh/sunpy/ndcube/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/sunpy/sunpy
   :alt: Best code cov this side of mars
.. |Powered by NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
   :target: https://numfocus.org
   :alt: Go give them money
.. |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.

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.

Usage of Generative AI
======================

We expect authentic engagement in our community.
Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content.
If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.

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
============

For detailed installation instructions, see the `installation guide`_ in the ndcube docs.

.. _installation guide: https://docs.sunpy.org/projects/ndcube/en/stable/installation.html

Getting Help
============

For more information or to ask questions about ndcube, check out:

-  `ndcube Documentation`_
-  `ndcube Element Channel`_

.. _ndcube Documentation: https://docs.sunpy.org/projects/ndcube/
.. _ndcube Element Channel: https://app.element.io/#/room/#ndcube:openastronomy.org

Contributing
============

If you would like to get involved, check out the `Newcomers Guide`_ section of the sunpy docs.
This shows how to get setup with a "sunpy" workflow but the same applies for ndcube, you will just need to replace sunpy with ndcube.

Help is always welcome so let us know what you like to work on, or check out the `issues page`_ for the list of known outstanding items.

.. _Newcomers Guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html
.. _issues page: https://github.com/sunpy/ndcube/issues

Code of Conduct
===============

When you are interacting with the SunPy community you are asked to follow our `Code of Conduct`_.

.. _Code of Conduct: https://sunpy.org/coc
