Skip to content

Commit f9940ed

Browse files
authored
DOC: Describe speclite filters in documentation (#457)
1 parent 1281106 commit f9940ed

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

docs/galaxies.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,13 @@ Spectrum
6363

6464
The following models are found in the `skypy.galaxies.spectrum` package.
6565

66+
SkyPy uses the `speclite <https://speclite.readthedocs.io/>`_ package for
67+
photometric calculations. Some of the following functions take the names of
68+
photometric filters as an input parameter. Users can choose from the available
69+
`Speclite Filters <https://speclite.readthedocs.io/en/latest/filters.html>`_
70+
following the naming syntax described in `speclite.filters.load_filters`, or
71+
create their own named `speclite.filters.FilterResponse`.
72+
6673
.. currentmodule:: skypy.galaxies.spectrum
6774
.. autosummary::
6875
:nosignatures:

docs/utils/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,14 @@ Photometry (`skypy.utils.photometry`)
126126
This module contains methods that model spectral energy distributions and
127127
calculate photometric properties.
128128

129+
SkyPy uses the `speclite <https://speclite.readthedocs.io/>`_ package for
130+
photometric calculations. Some of the following functions take the names of
131+
photometric filters as an input parameter. Users can choose from the available
132+
`Speclite Filters <https://speclite.readthedocs.io/en/latest/filters.html>`_
133+
following the naming syntax described in `speclite.filters.load_filters`, or
134+
create their own named `speclite.filters.FilterResponse`.
135+
136+
129137
.. currentmodule:: skypy.utils.photometry
130138
.. autosummary::
131139
:nosignatures:

0 commit comments

Comments
 (0)