Skip to content

DOC: Describe speclite filters in documentation #457

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.

Sign up for GitHub

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

Merged
rrjbca merged 4 commits into from
Apr 27, 2021
Merged

DOC: Describe speclite filters in documentation #457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9732f18
Adding link of speclite filters to documentation.
philipp128 Apr 22, 2021
9507f2f
Addressed suggestions
philipp128 Apr 22, 2021
d419a07
Adding speclite information also to galaxies #spectrum docs
philipp128 Apr 22, 2021
a0e7353
Merge branch 'main' into speclite_doc
philipp128 Apr 22, 2021
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
7 changes: 7 additions & 0 deletions docs/galaxies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@ Spectrum

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

SkyPy uses the `speclite <https://speclite.readthedocs.io/>`_ package for
photometric calculations. Some of the following functions take the names of
photometric filters as an input parameter. Users can choose from the available
`Speclite Filters <https://speclite.readthedocs.io/en/latest/filters.html>`_
following the naming syntax described in `speclite.filters.load_filters`, or
create their own named `speclite.filters.FilterResponse`.

.. currentmodule:: skypy.galaxies.spectrum
.. autosummary::
:nosignatures:
Expand Down
8 changes: 8 additions & 0 deletions docs/utils/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,14 @@ Photometry (`skypy.utils.photometry`)
This module contains methods that model spectral energy distributions and
calculate photometric properties.

SkyPy uses the `speclite <https://speclite.readthedocs.io/>`_ package for
photometric calculations. Some of the following functions take the names of
photometric filters as an input parameter. Users can choose from the available
`Speclite Filters <https://speclite.readthedocs.io/en/latest/filters.html>`_
following the naming syntax described in `speclite.filters.load_filters`, or
create their own named `speclite.filters.FilterResponse`.


.. currentmodule:: skypy.utils.photometry
.. autosummary::
:nosignatures:
Expand Down