Skip to content

Commit

Permalink
better docs, adding Charli
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorris3 committed Dec 8, 2018
1 parent f61973d commit 59c2459
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 18 deletions.
18 changes: 18 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,24 @@ stellar spectroscopy with the `ARC Echelle Spectrograph (ARCES)
`ARC 3.5 m Telescope <https://www.apo.nmsu.edu/arc35m/>`_ at
`Apache Point Observatory <https://www.apo.nmsu.edu>`_.

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 estimate 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
coefficients, for a star of the closest available spectral type to the one
requested.

For more information, `read the docs <https://arcesetc.readthedocs.io/>`_.

License
Expand Down
2 changes: 1 addition & 1 deletion arcesetc/data/sptype_dict.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"G5V": "Kepler-17", "K2V": "HD 73667", "G0V": "KIC 9652680", "K3V": "HR 8832", "M0V": "HD 209290", "K7V": "61CygB", "G2IV": "51 Peg", "sdO2VIIIHe5": "BD+28 4211", "B3V": "HR 3454", "F3V": "KIC8462852", "K8V": "HD151288", "G5V:": "HD134319", "K2V": "HD45088", "G2V": "HD98230", "B6IV": "HR 6943", "F7V": "HD 89744", "G5V": "Kepler-63", "M6V": "BD-03 3845", "A9V": "HD 8163", "M2V": "GJ4099", "G9V": "HD 42250", "K5V": "HD149957", "B9.5V": "HR5501", "K3.5V": "HD47752", "K4V": "HD 113827", "K7V": "GJ 9781A", "K2V": "GJ 705", "G3V": "HD86728", "K1V": "HD221639", "G8IVk": "HD 222107", "K5V": "EQ Vir", "K6V": "HD148467", "K2III-IV": "HD 6497", "G1.5V": "HD 129333", "K0V": "HD 145742", "K0V": "HD87884", "G3Va": "HD 10697", "G7V": "HD 67767", "G8V": "HD62613", "WN8h": "WR124", "K0V": "sigma Draconis", "G1.5IV-VFe-1": "HD34411"}
{"G5V": "Kepler-17", "K2V": "HD 73667", "G0V": "KIC 9652680", "K3V": "HR 8832", "M0V": "HD 209290", "K7V": "61CygB", "G2IV": "51 Peg", "sdO2VIIIHe5": "BD+28 4211", "B3V": "HR 3454", "F3V": "KIC8462852", "K8V": "HD151288", "G5V:": "HD134319", "K2V": "HD45088", "G2V": "HD98230", "B6IV": "HR 6943", "F7V": "HD 89744", "G5V": "Kepler-63", "M6 D": "BD-03 3845", "A9V": "HD 8163", "M2V": "GJ4099", "G9V": "HD 42250", "K5V": "HD149957", "B9.5V": "HR5501", "K3.5V": "HD47752", "K4V": "HD 113827", "K7V": "GJ 9781A", "K2V": "GJ 705", "G3V": "HD86728", "K1V": "HD221639", "G8IVk": "HD 222107", "K5V": "EQ Vir", "K6V": "HD148467", "K2III-IV": "HD 6497", "G1.5V": "HD 129333", "K0V": "HD 145742", "K0V": "HD87884", "G3Va": "HD 10697", "G7V": "HD 67767", "G8V": "HD62613", "WN8h": "WR124", "K0V": "sigma Draconis", "G1.5IV-VFe-1": "HD34411"}
3 changes: 3 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ stellar spectroscopy with the `ARC Echelle Spectrograph (ARCES)
`ARC 3.5 m Telescope <https://www.apo.nmsu.edu/arc35m/>`_ at
`Apache Point Observatory <https://www.apo.nmsu.edu>`_.

You can view the source code and/or contribute to ``arcesetc`` via
`GitHub <https://github.com/bmorris3/arcesetc>`_.

.. toctree::
:maxdepth: 2

Expand Down
3 changes: 3 additions & 0 deletions docs/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ authors:
- name: Trevor Dorn-Wallenstein
orcid: 0000-0003-3601-3180
affiliation: 1
- name: Charli Sakari
orcid: 0000-0002-5095-4000
affiliation: 1
affiliations:
- name: Astronomy Department, University of Washington, Seattle, WA, USA
index: 1
Expand Down
35 changes: 18 additions & 17 deletions notebooks/example.ipynb

Large diffs are not rendered by default.

0 comments on commit 59c2459

Please sign in to comment.