ndcube

ndcube: Manipulating N-dimensional Astronomical Data in Python - Published in JOSS (2023)

https://github.com/sunpy/ndcube

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 4 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
2 of 35 committers (5.7%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

astropy nddata numfocus sunpy wcs

Keywords from Contributors

astronomy solar-physics sun solar physics astrophysics exoplanet astropy-affiliated dynamics fem

Scientific Fields

Engineering Computer Science - 60% confidence

Last synced: 4 months ago · JSON representation

Repository

A base package for multi-dimensional contiguous and non-contiguous coordinate-aware arrays.

Basic Info

Host: GitHub
Owner: sunpy
License: bsd-2-clause
Language: Python
Default Branch: main
Homepage: http://docs.sunpy.org/projects/ndcube/
Size: 5.26 MB

Statistics

Stars: 47
Watchers: 11
Forks: 54
Open Issues: 74
Releases: 28

Topics

astropy nddata numfocus sunpy wcs

Created over 8 years ago · Last pushed 5 months ago

Metadata Files

Readme Changelog License Zenodo

README.rst

******
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 Chat Channel`_

.. _ndcube Documentation: https://docs.sunpy.org/projects/ndcube/
.. _ndcube Chat 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

Owner

Name: SunPy
Login: sunpy
Kind: organization

Website: https://www.sunpy.org
Repositories: 49
Profile: https://github.com/sunpy

Python for Solar Physics

JOSS Publication

ndcube: Manipulating N-dimensional Astronomical Data in Python

Published

September 22, 2023

DOI

10.21105/joss.05296

Volume 8, Issue 89, Page 5296

Authors

Daniel F. Ryan

University of Applied Sciences Northwest Switzerland, Switzerland, American University, USA

Stuart Mumford

Aperio Software Ltd, UK

Yash Sharma
Meta Platforms Inc., UK

Ankit Kumar Baruah
Workato Gmbh, Germany

Adwait Bhope

Uptycs India Pvt. Ltd., India

Nabil Freij

Lockheed Martin Solar and Astrophysics Laboratory, USA, Bay Area Environmental Research Institute, USA

Laura A. Hayes

European Space Agency, ESTEC

Will T. Barnes

NASA Goddard Space Flight Center, USA, American University, USA

Baptiste Pellorce
Claude Bernard Lyon 1 University, France, Institute of Theoretical Astrophysics, Norway

Richard O'Steen

Space Telescope Science Institute, USA

Derek Homeier

Aperio Software Ltd, UK

J. Marcus Hughes

Southwest Research Institute, USA

David Stansby

Advanced Research Computing Centre, University College London, UK

Albert Y. Shih

NASA Goddard Space Flight Center, USA

Matthew J. West

Southwest Research Institute, USA

Editor

Axel Donath

GitHub Events

Total

Create event: 37
Release event: 5
Issues event: 23
Watch event: 3
Delete event: 29
Issue comment event: 198
Push event: 158
Gollum event: 2
Pull request review comment event: 302
Pull request review event: 295
Pull request event: 170
Fork event: 7

Last Year

Create event: 37
Release event: 5
Issues event: 23
Watch event: 3
Delete event: 29
Issue comment event: 198
Push event: 159
Gollum event: 2
Pull request review comment event: 303
Pull request review event: 296
Pull request event: 170
Fork event: 7

Committers

Last synced: 5 months ago

All Time

Total Commits: 2,452
Total Committers: 35
Avg Commits per committer: 70.057
Development Distribution Score (DDS): 0.616

Past Year

Commits: 353
Committers: 11
Avg Commits per committer: 32.091
Development Distribution Score (DDS): 0.637

Top Committers

Name	Email	Commits
Daniel Ryan	r**5@t**e	941
Stuart J. Mumford	s**t@c**m	437
Nabil Freij	n**j@g**m	223
Yash Sharma	y**4@g**m	150
Junyan Huo	j**o@h**m	128
Ankit Baruah	a**1@g**m	126
Adwait Bhope	a**e@g**m	83
Samuel Bennett	b**9@g**m	64
Laura Hayes	h**a@t**e	53
pre-commit-ci[bot]	6****]	49
Ricky O'Steen	r**n@s**u	32
Baptiste Pellorce	b**e@e**r	28
Will Barnes	w**s@g**m	25
Andrew Leonard	a**d@g**m	23
Mateo Inchaurrandieta	m**a@g**m	13
Derek Homeier	d**e@g**e	11
David Stansby	d**y@g**m	9
Shane Maloney	s**y@d**e	8
Kris Akira Stern	k**n@g**m	6
Marcus Hughes	h**b@g**m	6
Diya Khetarpal	k**a@g**m	5
Andrew Robbertz	2****z	5
Gabe Shafiq	g**q@G**l	5
Aoife Maria Ryan	r**8@t**e	4
Roy Smart	r**t@g**m	4
Sanvi Sharma	s**5@g**m	2
Sam Van Kooten	v**m@g**m	2
P. L. Lim	2****m	2
Mihail Bankov	m**m@g**m	2
Albert Y. Shih	a**h@g**m	1
and 5 more...

Committer Domains (Top 20 + Academic)

tcd.ie: 3 lmsal.com: 1 fysik.lu.se: 1 dias.ie: 1 gwdg.de: 1 etu.univ-lyon1.fr: 1 stsci.edu: 1 cadair.com: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 104
Total pull requests: 408
Average time to close issues: 8 months
Average time to close pull requests: 23 days
Total issue authors: 23
Total pull request authors: 25
Average comments per issue: 2.24
Average comments per pull request: 1.37
Merged pull requests: 314
Bot issues: 2
Bot pull requests: 120

Past Year

Issues: 19
Pull requests: 187
Average time to close issues: 14 days
Average time to close pull requests: 7 days
Issue authors: 7
Pull request authors: 15
Average comments per issue: 1.16
Average comments per pull request: 1.21
Merged pull requests: 138
Bot issues: 2
Bot pull requests: 51

View more stats

Top Authors

Issue Authors

DanRyanIrish (30)
Cadair (25)
hayesla (9)
wtbarnes (9)
nabobalis (5)
dstansby (4)
ayshih (2)
olebole (2)
github-actions[bot] (2)
rosteen (2)
ViciousEagle03 (2)
Alrobbertz (1)
SimonHeybrock (1)
maxnoe (1)
lowderchris (1)

Pull Request Authors

github-actions[bot] (81)
Cadair (70)
nabobalis (55)
meeseeksmachine (45)
DanRyanIrish (40)
pre-commit-ci[bot] (39)
CyclingNinja (17)
hayesla (8)
wtbarnes (8)
PCJY (8)
ViciousEagle03 (7)
samaloney (6)
SolarDrew (5)
ayshih (3)
svank (2)

Top Labels

Issue Labels

help wanted (9) Documentation (9) new feature (8) bug (7) Feature Request (6) Bug (6) enhancement (5) No Changelog Entry Needed (4) Upstream Fix Required (3) Discussion (2) documentation (2) Resample (1) backport 2.2 (1)

Pull Request Labels

No Changelog Entry Needed (215) backport 2.3 (61) backport 2.1 (36) backport 2.2 (35) Minor Change (20) Run cron CI (16) [BugFix] (15) Stale (7) Run publish (6) stale (4) Infrastructure (4) documentation (2) Documentation (2) pre-commit.ci autofix (2) Still Needs Manual Backport (2) Tests (1)

Packages

Total packages: 2
Total downloads:
- pypi 40,308 last-month

Total dependent packages: 12
(may contain duplicates)
Total dependent repositories: 18
(may contain duplicates)
Total versions: 61
Total maintainers: 2

pypi.org: ndcube

A package for multi-dimensional contiguous and non-contiguous coordinate aware arrays.

Homepage: https://docs.sunpy.org/projects/ndcube
Documentation: https://docs.sunpy.org/projects/ndcube
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.
Latest release: 2.3.2
published 7 months ago

Versions: 41
Dependent Packages: 10
Dependent Repositories: 17
Downloads: 40,308 Last month
Docker Downloads: 0

Rankings

Dependent packages count: 1.1%

Downloads: 2.5%

Dependent repos count: 3.6%

Docker downloads count: 3.8%

Average: 4.6%

Forks count: 6.4%

Stargazers count: 10.2%

Maintainers (2)

Cadair DanRyanIrish

Last synced: 4 months ago

conda-forge.org: ndcube

Homepage: http://sunpy.org
License: BSD-2-Clause
Latest release: 2.0.3
published over 3 years ago

Versions: 20
Dependent Packages: 2
Dependent Repositories: 1

Rankings

Dependent packages count: 19.6%

Dependent repos count: 24.1%

Forks count: 28.6%

Average: 28.9%

Stargazers count: 43.5%

Last synced: 4 months ago

Dependencies

.github/workflows/ci.yml actions

Cadair/matrix-notify-action main composite

.github/workflows/stale_bot.yml actions

actions/stale v3 composite

ndcube

Science Score: 95.0%

Keywords

Keywords from Contributors

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

JOSS Publication

ndcube: Manipulating N-dimensional Astronomical Data in Python

Authors

Editor

Tags

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: ndcube

Rankings

Maintainers (2)

conda-forge.org: ndcube

Rankings

Dependencies