Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Describe speclite filters in documentation #457

Merged
merged 4 commits into from
Apr 27, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Adding link of speclite filters to documentation.
philipp128 committed Apr 22, 2021
commit 9732f18abd024b0e565dfa4bc1309c3ae2415c92
9 changes: 9 additions & 0 deletions docs/utils/index.rst
Original file line number Diff line number Diff line change
@@ -126,6 +126,15 @@ Photometry (`skypy.utils.photometry`)
This module contains methods that model spectral energy distributions and
calculate photometric properties.

Some of the following functions require a photometric filter as an input
parameter. In SkyPy, we included the
`speclite <https://speclite.readthedocs.io/>`_ package to enable different
spectroscopic tasks
(see `Dependencies <https://skypy.readthedocs.io/en/latest/install.html#dependencies>`_).
One can choose between the available filters described
`here <https://speclite.readthedocs.io/en/latest/filters.html>`_ by using the
same syntax (see `speclite.filters.load_filters`).

rrjbca marked this conversation as resolved.
Show resolved Hide resolved
.. currentmodule:: skypy.utils.photometry
.. autosummary::
:nosignatures: