Skip to content

Commit

Permalink
Update Sonora and Telluric docstrings
Browse files Browse the repository at this point in the history
New style looks good
  • Loading branch information
Sujay-Shankar committed May 15, 2024
1 parent 82179c4 commit 58cc002
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 12 deletions.
8 changes: 2 additions & 6 deletions src/gollum/sonora.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
r"""
Sonora Spectrum
**Sonora**
-----------------
A container for a single grid-point of the Sonora precomputed synthetic model spectrum of brown dwarfs and free-floating Gas Giant planets. The spectrum is a vector with coordinates wavelength and flux :math:`F(\lambda)`.
SonoraSpectrum
###############
Functionality pertaining to the Sonora series of substellar model grids (Marley et al. 2021, Morley et al. 2024)
"""

import os
Expand Down
8 changes: 2 additions & 6 deletions src/gollum/telluric.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
r"""
Telluric Spectrum
**Telluric**
-----------------
An experimental container for a single grid-point of a pre-computed telluric atmosphere model. The spectrum is a vector with coordinates wavelength and flux :math:`F(\lambda)`.
TelluricSpectrum
################
Functionality pertaining to telluric synthetic spectra from skycalc (Noll et al. 2012, Jones et al. 2013) and TelFit (Gullikson et al. 2014).
"""

from warnings import filterwarnings
Expand Down

0 comments on commit 58cc002

Please sign in to comment.