Skip to content

Commit

Permalink
Add github action for JOSS pdf generation
Browse files Browse the repository at this point in the history
  • Loading branch information
MetinSa committed Apr 10, 2024
1 parent 20a7597 commit f5afb46
Show file tree
Hide file tree
Showing 5 changed files with 343 additions and 3 deletions.
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@v4
- 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: 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: paper.pdf
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,5 @@ settings.json
#files
test.py
context.py

*.pdf
6 changes: 3 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ pip install zodipy
## Dependencies
ZodiPy has the following dependencies (these are automatically downloaded alongside ZodiPy):

- [numpy](https://numpy.org)
- [astropy](https://www.astropy.org) (>= 5.0.1)
- [Astropy](https://www.astropy.org) (>= 5.0.1)
- [NumPy](https://numpy.org)
- [healpy](https://healpy.readthedocs.io/en/latest/)
- [jplehem](https://pypi.org/project/jplephem/)
- [scipy](https://scipy.org/)
- [SciPy](https://scipy.org/)
233 changes: 233 additions & 0 deletions paper/paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
@software{2011ascl.soft12014R,
author = {{Rhodes}, Brandon Craig},
title = {{PyEphem: Astronomical Ephemeris for Python}},
howpublished = {Astrophysics Source Code Library, record ascl:1112.014},
year = 2011,
month = dec,
eid = {ascl:1112.014},
adsurl = {https://ui.adsabs.harvard.edu/abs/2011ascl.soft12014R},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@article{2023arXiv230617219A,
author = {{Aldering}, Greg and {Rubin}, David and {Rose}, Benjamin and {Hounsell}, Rebekah and {Perlmutter}, Saul and {Deustua}, Susana},
title = {{Roman CCS White Paper: Balanced Prism Plus Filter Cadence in the High Latitude Time Domain Survey Core Community Survey}},
journal = {arXiv e-prints},
keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Cosmology and Nongalactic Astrophysics},
year = 2023,
month = jun,
eid = {arXiv:2306.17219},
pages = {arXiv:2306.17219},
doi = {10.48550/arXiv.2306.17219},
archiveprefix = {arXiv},
eprint = {2306.17219},
primaryclass = {astro-ph.IM},
adsurl = {https://ui.adsabs.harvard.edu/abs/2023arXiv230617219A},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@article{2023arXiv230617226R,
author = {{Rose}, Benjamin and {Aldering}, Greg and {Hounsell}, Rebekah and {Joshi}, Bhavin and {Rubin}, David and {Scolnic}, Dan and {Perlmutter}, Saul and {Deustua}, Susana and {Sako}, Masao},
title = {{Roman CCS White Paper: Considerations for Selecting Fields for the Roman High-latitude Time Domain Core Community Survey}},
journal = {arXiv e-prints},
keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Cosmology and Nongalactic Astrophysics, Astrophysics - Astrophysics of Galaxies, Astrophysics - High Energy Astrophysical Phenomena},
year = 2023,
month = jun,
eid = {arXiv:2306.17226},
pages = {arXiv:2306.17226},
doi = {10.48550/arXiv.2306.17226},
archiveprefix = {arXiv},
eprint = {2306.17226},
primaryclass = {astro-ph.IM},
adsurl = {https://ui.adsabs.harvard.edu/abs/2023arXiv230617226R},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@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}
}

@article{Avitan2023,
author = {Avitan, Or and Schechner, Yoav Y. and Behar, Ehud},
journal = {IEEE Transactions on Pattern Analysis and Machine Intelligence},
title = {Using Zodiacal Light For Spaceborne Calibration Of Polarimetric Imagers},
year = {2023},
volume = {},
number = {},
pages = {1-12},
keywords = {Calibration;Scattering;Atmospheric modeling;Clouds;Sun;Earth;Space vehicles;Computational photography;Polarimetric calibration;Astronomy},
doi = {10.1109/TPAMI.2023.3299526}
}

@article{Hanzawa2024,
author = {Hanzawa, Masaki and Matsuura, Shuji and Takahashi, Aoi and Chary, Ranga-Ram and Sano, Kei and Takimoto, Kohji and Tome, Yuto},
title = {{Measurement of the zodiacal light absolute intensity through Fraunhofer line spectroscopy of the night sky with the Hale telescope}},
journal = {Publications of the Astronomical Society of Japan},
pages = {psae016},
year = {2024},
month = {03},
issn = {2053-051X},
doi = {10.1093/pasj/psae016},
url = {https://doi.org/10.1093/pasj/psae016},
eprint = {https://academic.oup.com/pasj/advance-article-pdf/doi/10.1093/pasj/psae016/57049109/psae016.pdf}
}

@article{Kelsall1998,
author = {{Kelsall}, T. and {Weiland}, J.~L. and {Franz}, B.~A. and {Reach}, W.~T. and {Arendt}, R.~G. and {Dwek}, E. and {Freudenreich}, H.~T. and {Hauser}, M.~G. and {Moseley}, S.~H. and {Odegard}, N.~P. and {Silverberg}, R.~F. and {Wright}, E.~L.},
title = {{The COBE Diffuse Infrared Background Experiment Search for the Cosmic Infrared Background. II. Model of the Interplanetary Dust Cloud}},
journal = {\apj},
keywords = {COSMOLOGY: OBSERVATIONS, COSMOLOGY: DIFFUSE RADIATION, INFRARED: GENERAL, INFRARED: SOLAR SYSTEM, INTERPLANETARY MEDIUM, Cosmology: Observations, Cosmology: Diffuse Radiation, Infrared: General, Infrared: Solar System, Interplanetary Medium, Astrophysics},
year = 1998,
month = nov,
volume = {508},
number = {1},
pages = {44-73},
doi = {10.1086/306380},
archiveprefix = {arXiv},
eprint = {astro-ph/9806250},
primaryclass = {astro-ph},
adsurl = {https://ui.adsabs.harvard.edu/abs/1998ApJ...508...44K},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
@article{numpy2011,
author = {van der Walt, Stefan and Colbert, S. Chris and Varoquaux, Gael},
journal = {Computing in Science & Engineering},
title = {The {NumPy} Array: A Structure for Efficient Numerical Computation},
year = {2011},
volume = {13},
number = {2},
pages = {22-30},
doi = {10.1109/MCSE.2011.37}
}

@article{numpy2020,
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}
}

@article{Planck2014,
author = {{Planck Collaboration} and {Ade}, P.~A.~R. and {Aghanim}, N. and {Armitage-Caplan}, C. and {Arnaud}, M. and {Ashdown}, M. and {Atrio-Barandela}, F. and {Aumont}, J. and {Baccigalupi}, C. and {Banday}, A.~J. and {Barreiro}, R.~B. and {Bartlett}, J.~G. and {Battaner}, E. and {Benabed}, K. and {Beno{\^\i}t}, A. and {Benoit-L{\'e}vy}, A. and {Bernard}, J. -P. and {Bersanelli}, M. and {Bielewicz}, P. and {Bobin}, J. and {Bock}, J.~J. and {Bonaldi}, A. and {Bond}, J.~R. and {Borrill}, J. and {Bouchet}, F.~R. and {Boulanger}, F. and {Bridges}, M. and {Bucher}, M. and {Burigana}, C. and {Butler}, R.~C. and {Cardoso}, J. -F. and {Catalano}, A. and {Chamballu}, A. and {Chary}, R. -R. and {Chen}, X. and {Chiang}, H.~C. and {Chiang}, L. -Y. and {Christensen}, P.~R. and {Church}, S. and {Clements}, D.~L. and {Colley}, J. -M. and {Colombi}, S. and {Colombo}, L.~P.~L. and {Couchot}, F. and {Coulais}, A. and {Crill}, B.~P. and {Curto}, A. and {Cuttaia}, F. and {Danese}, L. and {Davies}, R.~D. and {de Bernardis}, P. and {de Rosa}, A. and {de Zotti}, G. and {Delabrouille}, J. and {Delouis}, J. -M. and {D{\'e}sert}, F. -X. and {Dickinson}, C. and {Diego}, J.~M. and {Dole}, H. and {Donzelli}, S. and {Dor{\'e}}, O. and {Douspis}, M. and {Dupac}, X. and {Efstathiou}, G. and {En{\ss}lin}, T.~A. and {Eriksen}, H.~K. and {Finelli}, F. and {Forni}, O. and {Frailis}, M. and {Fraisse}, A.~A. and {Franceschi}, E. and {Galeotta}, S. and {Ganga}, K. and {Giard}, M. and {Giraud-H{\'e}raud}, Y. and {Gonz{\'a}lez-Nuevo}, J. and {G{\'o}rski}, K.~M. and {Gratton}, S. and {Gregorio}, A. and {Gruppuso}, A. and {Hansen}, F.~K. and {Hanson}, D. and {Harrison}, D. and {Helou}, G. and {Henrot-Versill{\'e}}, S. and {Hern{\'a}ndez-Monteagudo}, C. and {Herranz}, D. and {Hildebrandt}, S.~R. and {Hivon}, E. and {Hobson}, M. and {Holmes}, W.~A. and {Hornstrup}, A. and {Hovest}, W. and {Huffenberger}, K.~M. and {Jaffe}, A.~H. and {Jaffe}, T.~R. and {Jones}, W.~C. and {Juvela}, M. and {Keih{\"a}nen}, E. and {Keskitalo}, R. and {Kisner}, T.~S. and {Kneissl}, R. and {Knoche}, J. and {Knox}, L. and {Kunz}, M. and {Kurki-Suonio}, H. and {Lagache}, G. and {L{\"a}hteenm{\"a}ki}, A. and {Lamarre}, J. -M. and {Lasenby}, A. and {Laureijs}, R.~J. and {Lawrence}, C.~R. and {Leonardi}, R. and {Lesgourgues}, J. and {Liguori}, M. and {Lilje}, P.~B. and {Linden-V{\o}rnle}, M. and {L{\'o}pez-Caniego}, M. and {Lubin}, P.~M. and {Mac{\'\i}as-P{\'e}rez}, J.~F. and {Maffei}, B. and {Maino}, D. and {Mandolesi}, N. and {Maris}, M. and {Marshall}, D.~J. and {Martin}, P.~G. and {Mart{\'\i}nez-Gonz{\'a}lez}, E. and {Masi}, S. and {Massardi}, M. and {Matarrese}, S. and {Matthai}, F. and {Mazzotta}, P. and {Meinhold}, P.~R. and {Melchiorri}, A. and {Mendes}, L. and {Mennella}, A. and {Migliaccio}, M. and {Mitra}, S. and {Miville-Desch{\^e}nes}, M. -A. and {Moneti}, A. and {Montier}, L. and {Morgante}, G. and {Mortlock}, D. and {Mottet}, S. and {Munshi}, D. and {Murphy}, J.~A. and {Naselsky}, P. and {Nati}, F. and {Natoli}, P. and {Netterfield}, C.~B. and {N{\o}rgaard-Nielsen}, H.~U. and {Noviello}, F. and {Novikov}, D. and {Novikov}, I. and {Osborne}, S. and {O'Sullivan}, C. and {Oxborrow}, C.~A. and {Paci}, F. and {Pagano}, L. and {Pajot}, F. and {Paladini}, R. and {Paoletti}, D. and {Pasian}, F. and {Patanchon}, G. and {Perdereau}, O. and {Perotto}, L. and {Perrotta}, F. and {Piacentini}, F. and {Piat}, M. and {Pierpaoli}, E. and {Pietrobon}, D. and {Plaszczynski}, S. and {Pointecouteau}, E. and {Polegre}, A.~M. and {Polenta}, G. and {Ponthieu}, N. and {Popa}, L. and {Poutanen}, T. and {Pratt}, G.~W. and {Pr{\'e}zeau}, G. and {Prunet}, S. and {Puget}, J. -L. and {Rachen}, J.~P. and {Reach}, W.~T. and {Rebolo}, R. and {Reinecke}, M. and {Remazeilles}, M. and {Renault}, C. and {Ricciardi}, S. and {Riller}, T. and {Ristorcelli}, I. and {Rocha}, G. and {Rosset}, C. and {Roudier}, G. and {Rowan-Robinson}, M. and {Rusholme}, B. and {Sandri}, M. and {Santos}, D. and {Savini}, G. and {Scott}, D. and {Seiffert}, M.~D. and {Shellard}, E.~P.~S. and {Smoot}, G.~F. and {Spencer}, L.~D. and {Starck}, J. -L. and {Stolyarov}, V. and {Stompor}, R. and {Sudiwala}, R. and {Sureau}, F. and {Sutton}, D. and {Suur-Uski}, A. -S. and {Sygnet}, J. -F. and {Tauber}, J.~A. and {Tavagnacco}, D. and {Terenzi}, L. and {Toffolatti}, L. and {Tomasi}, M. and {Tristram}, M. and {Tucci}, M. and {Tuovinen}, J. and {Umana}, G. and {Valenziano}, L. and {Valiviita}, J. and {Van Tent}, B. and {Vielva}, P. and {Villa}, F. and {Vittorio}, N. and {Wade}, L.~A. and {Wandelt}, B.~D. and {Yvon}, D. and {Zacchei}, A. and {Zonca}, A.},
title = {{Planck 2013 results. XIV. Zodiacal emission}},
journal = {\aap},
keywords = {zodiacal dust, interplanetary medium, cosmic background radiation, Astrophysics - Cosmology and Nongalactic Astrophysics},
year = 2014,
month = nov,
volume = {571},
eid = {A14},
pages = {A14},
doi = {10.1051/0004-6361/201321562},
archiveprefix = {arXiv},
eprint = {1303.5074},
primaryclass = {astro-ph.CO},
adsurl = {https://ui.adsabs.harvard.edu/abs/2014A&A...571A..14P},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@article{San2022,
author = {{San}, M. and {Herman}, D. and {Erikstad}, G.~B. and {Galloway}, M. and {Watts}, D.},
title = {{COSMOGLOBE: Simulating zodiacal emission with ZodiPy}},
journal = {\aap},
keywords = {interplanetary medium, cosmic background radiation, zodiacal dust, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics},
year = 2022,
month = oct,
volume = {666},
eid = {A107},
pages = {A107},
doi = {10.1051/0004-6361/202244133},
archiveprefix = {arXiv},
eprint = {2205.12962},
primaryclass = {astro-ph.EP},
adsurl = {https://ui.adsabs.harvard.edu/abs/2022A&A...666A.107S},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@article{scipy2020,
author = {Virtanen, Pauli and Gommers, Ralf and Oliphant, Travis E. and Haberland, Matt and Reddy, Tyler and Cournapeau, David and Burovski, Evgeni and Peterson, Pearu and Weckesser, Warren and Bright, Jonathan and {van der Walt}, St{\'e}fan J. and Brett, Matthew and Wilson, Joshua and Millman, K. Jarrod and Mayorov, Nikolay and Nelson, Andrew R. J. and Jones, Eric and Kern, Robert and Larson, Eric and Carey, C J and Polat, {\.I}lhan and Feng, Yu and Moore, Eric W. and {VanderPlas}, Jake and Laxalde, Denis and Perktold, Josef and Cimrman, Robert and Henriksen, Ian and Quintero, E. A. and Harris, Charles R. and Archibald, Anne M. and Ribeiro, Ant{\^o}nio H. and Pedregosa, Fabian and {van Mulbregt}, Paul and {SciPy 1.0 Contributors}},
title = {{{SciPy} 1.0: Fundamental Algorithms for Scientific Computing in Python}},
journal = {Nature Methods},
year = {2020},
volume = {17},
pages = {261--272},
adsurl = {https://rdcu.be/b08Wh},
doi = {10.1038/s41592-019-0686-2}
}

@article{Tsumura2023,
author = {{Tsumura}, Kohji and {Matsuura}, Shuji and {Sano}, Kei and {Iwata}, Takahiro and {Yano}, Hajime and {Kitazato}, Kohei and {Takimoto}, Kohji and {Yamada}, Manabu and {Morota}, Tomokatsu and {Kouyama}, Toru and {Hayakawa}, Masahiko and {Yokota}, Yasuhiro and {Tatsumi}, Eri and {Matsuoka}, Moe and {Sakatani}, Naoya and {Honda}, Rie and {Kameda}, Shingo and {Suzuki}, Hidehiko and {Cho}, Yuichiro and {Yoshioka}, Kazuo and {Ogawa}, Kazunori and {Shirai}, Kei and {Sawada}, Hirotaka and {Sugita}, Seiji},
title = {{Heliocentric distance dependence of zodiacal light observed by Hayabusa2\#}},
journal = {Earth, Planets and Space},
keywords = {Zodiacal light, Interplanetary dust, Hayabusa2\#, Astrophysics - Earth and Planetary Astrophysics},
year = 2023,
month = dec,
volume = {75},
number = {1},
eid = {121},
pages = {121},
doi = {10.1186/s40623-023-01856-x},
archiveprefix = {arXiv},
eprint = {2303.07013},
primaryclass = {astro-ph.EP},
adsurl = {https://ui.adsabs.harvard.edu/abs/2023EP&S...75..121T},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@article{Zonca2019,
doi = {10.21105/joss.01298},
url = {https://doi.org/10.21105/joss.01298},
year = {2019},
publisher = {The Open Journal},
volume = {4},
number = {35},
pages = {1298},
author = {Andrea Zonca and Leo P. Singer and Daniel Lenz and Martin Reinecke and Cyrille Rosset and Eric Hivon and Krzysztof M. Gorski},
title = {healpy: equal area pixelization and spherical harmonics transforms for data on the sphere in Python},
journal = {Journal of Open Source Software}
}

@article{Gorski2005,
author = {{G{\'o}rski}, K.~M. and {Hivon}, E. and {Banday}, A.~J. and {Wandelt}, B.~D. and {Hansen}, F.~K. and {Reinecke}, M. and {Bartelmann}, M.},
title = "{HEALPix: A Framework for High-Resolution Discretization and Fast Analysis of Data Distributed on the Sphere}",
journal = {\apj},
keywords = {Cosmology: Cosmic Microwave Background, Cosmology: Observations, Methods: Statistical, Astrophysics},
year = 2005,
month = apr,
volume = {622},
number = {2},
pages = {759-771},
doi = {10.1086/427976},
archivePrefix = {arXiv},
eprint = {astro-ph/0409513},
primaryClass = {astro-ph},
adsurl = {https://ui.adsabs.harvard.edu/abs/2005ApJ...622..759G},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
Loading

0 comments on commit f5afb46

Please sign in to comment.