Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ndcube Joss paper #599

Merged
merged 22 commits into from
Mar 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
534f064
First draft of JOSS paper.
DanRyanIrish Nov 11, 2021
73e53ec
Incorporate community use section of joss paper into summary section.
DanRyanIrish Nov 11, 2021
f600de9
Condense data objects section of joss paper.
DanRyanIrish Nov 11, 2021
addfa69
Apply suggestions from code review
DanRyanIrish Nov 11, 2021
7123885
Edits to JOSS paper draft based of comments from Stuart.
DanRyanIrish Nov 11, 2021
f5374a6
Merge branch 'main' of https://github.com/sunpy/ndcube into joss
DanRyanIrish Nov 17, 2021
04a13b4
Add figures for joss paper.
DanRyanIrish Nov 18, 2021
cce8adb
Add figures for joss paper.
DanRyanIrish Aug 26, 2022
2641b9d
Merge branch 'main' of https://github.com/sunpy/ndcube into joss
DanRyanIrish Feb 18, 2023
545ea7b
Simplify JOSS paper draft and add some co-authors.
DanRyanIrish Feb 19, 2023
81a27ba
Update references for joos paper.
DanRyanIrish Feb 19, 2023
bf921af
Order JOSS paper co-authors by larger of additions/substractions.
DanRyanIrish Feb 19, 2023
1b527af
Minor bibtex changes to JOSS paper.
DanRyanIrish Feb 22, 2023
ba0eba6
Merge branch 'main' of https://github.com/sunpy/ndcube into joss
DanRyanIrish Mar 8, 2023
4b6a044
Next draft of JOSS paper.
DanRyanIrish Mar 8, 2023
4b81476
Slight streamlining of some paragraphs in the JOSS paper.
DanRyanIrish Mar 8, 2023
6e6e5f1
Apply suggestions from code review
DanRyanIrish Mar 8, 2023
f070815
Add mention of jdaviz to JOSS paper
DanRyanIrish Mar 8, 2023
b0a8919
Structurewq JOSS paper sections a little more like standard JOSS format.
DanRyanIrish Mar 9, 2023
f03e771
Add GitHub Action to render JOSS paper.
DanRyanIrish Mar 9, 2023
3bb7b70
Fix JOSS paper bib errors.
DanRyanIrish Mar 9, 2023
0145bad
Fix bulleting list format in JOSS paper.
DanRyanIrish Mar 9, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/draft-pdf.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
on: [push]

jobs:
paper:
runs-on: ubuntu-latest
name: Paper Draft
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Build draft PDF
uses: openjournals/openjournals-draft-action@master
with:
journal: joss
# This should be the path to the paper within your repo.
paper-path: joss_paper/paper.md
- name: Upload
uses: actions/upload-artifact@v1
with:
name: paper
# This is the output path where Pandoc will write the compiled
# PDF. Note, this should be the same directory as the input
# paper.md
path: joss_paper/paper.pdf
205 changes: 205 additions & 0 deletions joss_paper/paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,205 @@
@misc{ape14,
author = {{Robitaille}, Thomas and {Tollerud}, Erik and {Mumford}, Stuart and {Ginsburg}, Adam},
title = {APE-14: A shared Python interface for World Coordinate Systems},
year = {2018},
publisher = {GitHub},
journal = {GitHub repository},
url = {https://github.com/astropy/astropy-APEs/blob/main/APE14.rst}
}

@article{astropy,
author = {{Astropy Collaboration}},
title = "{Astropy: A community Python package for astronomy}",
journal = {Astronomy and Astrophysics},
archivePrefix = "arXiv",
eprint = {1307.6212},
primaryClass = "astro-ph.IM",
keywords = {methods: data analysis, methods: miscellaneous, virtual observatory tools},
year = 2013,
month = oct,
volume = 558,
doi = {10.1051/0004-6361/201322068},
url = {http://adsabs.harvard.edu/abs/2013A%26A...558A..33A}
}

@inproceedings{cupy,
title = {{{CuPy}}: {{A NumPy-Compatible}} Library for {{NVIDIA GPU}} Calculations},
booktitle = {Proceedings of Workshop on Machine Learning Systems ({{LearningSys}}) in the Thirty-First Annual Conference on Neural Information Processing Systems ({{NIPS}})},
author = {Okuta, Ryosuke and Unno, Yuya and Nishino, Daisuke and Hido, Shohei and Loomis, Crissman},
year = {2017}
}

@Manual{dask,
title = {Dask: Library for dynamic task scheduling},
author = {{Dask Development Team}},
year = {2016},
url = {https://dask.org},
}

@misc{eispac-docs,
author = {{EISPAC Developers}},
title = {EISPAC Documentation},
year = {2023},
publisher = {ReadTheDocs},
journal = {ReadTheDocs},
url = {https://eispac.readthedocs.io/en/latest}
}

@misc{eispac-code,
author = {{EISPAC Developers}},
title = {EISPAC code-base},
year = {2023},
publisher = {GitHub},
journal = {GitHub Repository},
url = {https://github.com/USNavalResearchLaboratory/eispac}
}

@misc{gwcs-docs,
author = {{gWCS Developers}},
title = {gWCS Documentation},
year = {2023},
publisher = {ReadTheDocs},
journal = {ReadTheDocs},
url = {https://gwcs.readthedocs.io/en/stable/}
}

@misc{gwcs-code,
author = {{gWCS Developers}},
title = {gWCS code-base},
year = {2023},
publisher = {GitHub},
journal = {GitHub Repository},
url = {https://github.com/spacetelescope/gwcs}
}

@misc{irispy-docs,
author = {{irispy-lmsal Developers}},
title = {irispy-lmsal Documentation},
year = {2023},
publisher = {ReadTheDocs},
journal = {ReadTheDocs},
url = {https://irispy-lmsal.readthedocs.io/en/stable/}
}

@misc{irispy-code,
author = {{irispy-lmsal Developers}},
title = {irispy-lmsal code-base},
year = {2023},
publisher = {GitHub},
journal = {GitHub Repository},
url = {https://github.com/LM-SAL/irispy-lmsal}
}

DanRyanIrish marked this conversation as resolved.
Show resolved Hide resolved
@software{jdaviz,
author = {JDADF Developers and
Averbukh, Jesse and
Bradley, Larry and
Buikhuizen, Mario and
Busko, Ivo and
Cherinka, Brian and
Conroy, Kyle and
Earl, Nicholas and
Fox, Ori and
Geda, Robel and
Jones, Craig and
Karatay, Hatice and
Kotler, Jenn and
Lim, Pey Lian and
Morris, Brett and
Nguyen, Duy and
O'Steen, Richard and
Ogaz, Sara and
Ogle, Patrick and
Otor, O. Justin and
Pacifici, Camilla and
Robitaille, Thomas and
Tollerud, Erik and
Volfman, Sabrina},
title = {Jdaviz},
month = feb,
year = 2023,
note = {If you use this software, please cite it as below.},
publisher = {Zenodo},
version = {3.3.0},
doi = {10.5281/zenodo.7625637},
url = {https://doi.org/10.5281/zenodo.7625637}
}

@article{ndcube,
author = {{Ryan}, Daniel and {Mumford}, Stuart and {Barnes}, Will T. and {Kumar Baruah}, Ankit and {Bhope}, Adwait and {Buchlin}, Eric and {Freij}, Nabil and {Ginsburg}, Adam and {Hayes}, Laura A. and {Homeier}, Derek and {Hughes}, J. Marcus and {Lowder}, Chris and {O'Steen}, Richard and {Pellorce}, Baptiste and {Robitaille}, Thomas and {Sharma}, Yash and {Shih}, Albert Y. and {Tollerud}, Erik and {West}, Matthew J.},
title = "{A Unified Framework for Manipulating N-dimensional Astronomical Data and Coordinate
Transformations in Python: The NDCube 2 & Astropy APE-14 WCS APIs}",
year = {submitted},
journal = {The Astrophysical Journal},
}

@Article{numpy,
title = {Array programming with {NumPy}},
author = {Charles R. Harris and K. Jarrod Millman and St{\'{e}}fan J.
van der Walt and Ralf Gommers and Pauli Virtanen and David
Cournapeau and Eric Wieser and Julian Taylor and Sebastian
Berg and Nathaniel J. Smith and Robert Kern and Matti Picus
and Stephan Hoyer and Marten H. van Kerkwijk and Matthew
Brett and Allan Haldane and Jaime Fern{\'{a}}ndez del
R{\'{i}}o and Mark Wiebe and Pearu Peterson and Pierre
G{\'{e}}rard-Marchant and Kevin Sheppard and Tyler Reddy and
Warren Weckesser and Hameer Abbasi and Christoph Gohlke and
Travis E. Oliphant},
year = {2020},
month = sep,
journal = {Nature},
volume = {585},
number = {7825},
pages = {357--362},
doi = {10.1038/s41586-020-2649-2},
publisher = {Springer Science and Business Media {LLC}},
url = {https://doi.org/10.1038/s41586-020-2649-2}
}

@INPROCEEDINGS{punch,
author = {{Deforest}, Craig and {Killough}, Ronnie and {Gibson}, Sarah and {Henry}, Alan and {Case}, Traci and {Beasley}, Matthew and {Laurent}, Glenn and {Colaninno}, Robin and {Waltham}, Nick and {Punch Science Team}},
title = "{Polarimeter to UNify the Corona and Heliosphere (PUNCH): Science, Status, and Path to Flight}",
keywords = {Three-dimensional displays, Instruments, Small satellites, Scattering, Optics, Corona, Synchronization},
booktitle = {2022 IEEE Aerospace Conference},
year = 2022,
month = aug,
eid = {1},
pages = {1-11},
doi = {10.1109/AERO53065.2022.9843340},
adsurl = {https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fui.adsabs.harvard.edu%2Fabs%2F2022aero.confE...1D&data=05%7C01%7Cdaniel.ryan%40fhnw.ch%7Cb7081a5c61bf4b75c1a508db10625f73%7C9d1a5fc8321e4101ae63530730711ac2%7C0%7C0%7C638121786933488209%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=d%2Bok8sOTJBMaeg4%2BT%2BlBvGYrUtTNEIbaPUqaomSfwAs%3D&reserved=0},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@misc{sep12,
author = {{Mumford}, Stuart and {Ryan}, Daniel F.},
title = {SEP-0012: NDCube 2 API},
year = {2020},
publisher = {GitHub},
journal = {GitHub repository},
url = {https://github.com/sunpy/sunpy-SEP/blob/master/SEP-0012.md}
}

@misc{specutils-docs,
author = {{specutils Developers}},
title = {specutils Documentation},
year = {2023},
publisher = {ReadTheDocs},
journal = {ReadTheDocs},
url = {https://specutils.readthedocs.io/en/stable/}
}

@misc{specutils-code-base,
author = {{specutils Developers}},
title = {specutils code},
year = {2023},
publisher = {GitHub},
journal = {GitHub Repository},
url = {https://github.com/astropy/specutils}
}

@article{sunraster,
author = {{Ryan}, Daniel and {et al}},
title = "{sunraster: Manipulating Solar Slit-spectrograph Observations in Python}",
year = {in prep.},
journal = {Journal of Open Source Software},
}
Loading