Skip to content

Commit 67aaf6b

Browse files
authored
Spectra docs (#146)
* new submod pointer * spectra docs
1 parent 5a5a6bc commit 67aaf6b

File tree

5 files changed

+24
-0
lines changed

5 files changed

+24
-0
lines changed

docs/pages/ingesting/getting_started_ingesting.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ Ingesting and Modifying Data
22
====================================
33

44
.. toctree::
5+
:glob:
56
ingesting_publications
67
ingest_scripts
8+
spectra
79

810

911
.. note::
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Spectra
2+
#######
3+
4+
.. toctree::
5+
:glob:
6+
spectra/*
7+
8+
9+
Check if spectra are plottable
10+
------------------------------
11+
12+
Use the :py:mod:`check_spectrum_plottable<astrodb_utils.spectra.check_spectrum_plottable>` function
13+
to check if a spectrum is loadable by `astropy.specutils` and plottable.
14+
The `matplotlib` package needs to be installed to display the spectrum using `show_plot=True`.
15+
16+
.. code-block:: python
17+
from astrodb_utils.spectra import check_spectrum_plottable
18+
file = <path to file>
19+
plottable = check_spectrum_plottable(file, show_plot=True)
20+
print plottable
21+
22+
> True

0 commit comments

Comments
 (0)