Adding JOSS paper

README.rst

@@ -12,9 +12,11 @@ Exposure time calculator for APO/ARCES
     :target: http://www.astropy.org
     :alt: Powered by Astropy Badge
 
-Calculate S/N and exposure times for stellar spectroscopy with the ARC Echelle
-Spectrograph (ARCES) on the 3.5 m Telescope at Apache Point Observatory
-
+Calculate S/N and exposure times for
+stellar spectroscopy with the `ARC Echelle Spectrograph (ARCES)
+<https://www.apo.nmsu.edu/arc35m/Instruments/ARCES/>`_ on the
+`ARC 3.5 m Telescope <https://www.apo.nmsu.edu/arc35m/>`_ at
+`Apache Point Observatory <https://www.apo.nmsu.edu>`_.
 
 License
 -------

arcesetc/plots.py

@@ -19,6 +19,9 @@ def plot_order_counts(sptype, wavelength, V, exp_time=None,
     Either ``exp_time`` or ``signal_to_noise`` should be supplied to the
     function (but not both).
 
+    .. warning ::
+        ``arcesetc`` doesn't know anything about saturation. Ye be warned!
+
     Parameters
     ----------
     sptype : str
@@ -38,9 +41,6 @@ def plot_order_counts(sptype, wavelength, V, exp_time=None,
     kwargs : dict
         All extra keyword arguments will be passed to the plot function
 
-    .. warning ::
-        ``arcesetc`` doesn't know anything about saturation. Ye be warned!
-
     Returns
     -------
     fig : `~matplotlib.pyplot.Figure`

docs/paper.bib

@@ -0,0 +1,59 @@
+@ARTICLE{astropy:2018,
+       author = {{The Astropy Collaboration} and {Price-Whelan}, A.~M. and
+        {Sip{\'{o}}cz}, B.~M. and {G{\"u}nther}, H.~M. and {Lim}, P.~L.
+        and {Crawford}, S.~M. and {Conseil}, S. and {Shupe}, D.~L. and
+        {Craig}, M.~W. and {Dencheva}, N. and {Ginsburg}, A. and
+        {VanderPlas}, J.~T. and {Bradley}, L.~D. and {P{\'e}rez-
+        Su{\'a}rez}, D. and {de Val-Borro}, M. and {Aldcroft}, T.~L. and
+        {Cruz}, K.~L. and {Robitaille}, T.~P. and {Tollerud}, E.~J. and
+        {Ardelean}, C. and {Babej}, T. and {Bachetti}, M. and {Bakanov},
+        A.~V. and {Bamford}, S.~P. and {Barentsen}, G. and {Barmby}, P.
+        and {Baumbach}, A. and {Berry}, K.~L. and {Biscani}, F. and
+        {Boquien}, M. and {Bostroem}, K.~A. and {Bouma}, L.~G. and
+        {Brammer}, G.~B. and {Bray}, E.~M. and {Breytenbach}, H. and
+        {Buddelmeijer}, H. and {Burke}, D.~J. and {Calderone}, G. and
+        {Cano Rodr{\'\i}guez}, J.~L. and {Cara}, M. and {Cardoso},
+        J.~V.~M. and {Cheedella}, S. and {Copin}, Y. and {Crichton}, D.
+        and {D{\'A}vella}, D. and {Deil}, C. and {Depagne}, {\'E}. and
+        {Dietrich}, J.~P. and {Donath}, A. and {Droettboom}, M. and
+        {Earl}, N. and {Erben}, T. and {Fabbro}, S. and {Ferreira},
+        L.~A. and {Finethy}, T. and {Fox}, R.~T. and {Garrison}, L.~H.
+        and {Gibbons}, S.~L.~J. and {Goldstein}, D.~A. and {Gommers}, R.
+        and {Greco}, J.~P. and {Greenfield}, P. and {Groener}, A.~M. and
+        {Grollier}, F. and {Hagen}, A. and {Hirst}, P. and {Homeier}, D.
+        and {Horton}, A.~J. and {Hosseinzadeh}, G. and {Hu}, L. and
+        {Hunkeler}, J.~S. and {Ivezi{\'c}}, {\v{Z}}. and {Jain}, A. and
+        {Jenness}, T. and {Kanarek}, G. and {Kendrew}, S. and {Kern},
+        N.~S. and {Kerzendorf}, W.~E. and {Khvalko}, A. and {King}, J.
+        and {Kirkby}, D. and {Kulkarni}, A.~M. and {Kumar}, A. and
+        {Lee}, A. and {Lenz}, D. and {Littlefair}, S.~P. and {Ma}, Z.
+        and {Macleod}, D.~M. and {Mastropietro}, M. and {McCully}, C.
+        and {Montagnac}, S. and {Morris}, B.~M. and {Mueller}, M. and
+        {Mumford}, S.~J. and {Muna}, D. and {Murphy}, N.~A. and
+        {Nelson}, S. and {Nguyen}, G.~H. and {Ninan}, J.~P. and
+        {N{\"o}the}, M. and {Ogaz}, S. and {Oh}, S. and {Parejko}, J.~K.
+        and {Parley}, N. and {Pascual}, S. and {Patil}, R. and {Patil},
+        A.~A. and {Plunkett}, A.~L. and {Prochaska}, J.~X. and
+        {Rastogi}, T. and {Reddy Janga}, V. and {Sabater}, J. and
+        {Sakurikar}, P. and {Seifert}, M. and {Sherbert}, L.~E. and
+        {Sherwood-Taylor}, H. and {Shih}, A.~Y. and {Sick}, J. and
+        {Silbiger}, M.~T. and {Singanamalla}, S. and {Singer}, L.~P. and
+        {Sladen}, P.~H. and {Sooley}, K.~A. and {Sornarajah}, S. and
+        {Streicher}, O. and {Teuben}, P. and {Thomas}, S.~W. and
+        {Tremblay}, G.~R. and {Turner}, J.~E.~H. and {Terr{\'o}n}, V.
+        and {van Kerkwijk}, M.~H. and {de la Vega}, A. and {Watkins},
+        L.~L. and {Weaver}, B.~A. and {Whitmore}, J.~B. and {Woillez},
+        J. and {Zabalza}, V.},
+        title = "{The Astropy Project: Building an inclusive, open-science project and
+        status of the v2.0 core package}",
+      journal = {ArXiv e-prints},
+     keywords = {Astrophysics - Instrumentation and Methods for Astrophysics},
+         year = 2018,
+        month = Jan,
+          eid = {arXiv:1801.02634},
+        pages = {arXiv:1801.02634},
+archivePrefix = {arXiv},
+       eprint = {1801.02634},
+       adsurl = {https://ui.adsabs.harvard.edu/#abs/2018arXiv180102634T},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}

docs/paper.md

@@ -0,0 +1,53 @@
+---
+title: 'arcesetc: ARC Echelle Spectroscopic Exposure Time Calculator'
+tags:
+  - Python
+  - astronomy
+  - spectroscopy
+authors:
+  - name: Brett M. Morris
+    orcid: 0000-0003-2528-3409
+    affiliation: 1
+  - name: Trevor Dorn-Wallenstein
+    orcid: 0000-0003-3601-3180
+    affiliation: 1
+affiliations:
+ - name: Astronomy Department, University of Washington, Seattle, WA, USA
+   index: 1
+date: 1 Jan 2019
+bibliography: paper.bib
+--- 
+
+# Summary
+
+The ARC Echelle Spectroscopic (ARCES) Exposure Time Calculator, or ``arcesetc``,
+is a simple exposure time calculator for the ARCES instrument on the 
+Astrophysical Research Consortium (ARC) 3.5 m Telescope at Apache Point 
+Observatory for stellar spectroscopy. Users can supply ``arcesetc`` functions 
+with the spectral type of their target star, the V band magnitude, and either: 
+the desired exposure time in order to determine the counts and signal-to-noise
+ratio as a function of wavelength; or the desired signal-to-noise ratio at a 
+given wavelength to determine the required exposure time. 
+
+We estimates the count rates for stars as a function of wavelength by fitting 
+15th-order polynomials to each spectral order of real observations of a star of 
+each spectral type. These polynomial coefficients and some wavelength metadata
+are stored in an HDF5 archive for compactness and easy of reconstruction. Then
+upon calling ``arcesetc``, the archive is opened and the spectral order closest
+to the wavelength of interest is reconstructed from the polynomial 
+coeffiecients.
+
+At present, the stellar spectral types included in the ``arcesetc`` library
+span from late F to early M stars on the main sequence, and one each of an 
+O, B, and Wolf-Rayet star. Contributions from the community are welcome to 
+expand the library to include other spectral types.
+
+``arcesetc`` was built from the Astropy package-template, and thus includes 
+self-building documentation and continuous integration [@astropy:2018].
+
+# Acknowledgements
+
+We acknowledge guidance from Suzanne L. Hawley and Emily Levesque, and the invaluable 
+framework and dev team behind the astropy package-template.
+
+# References