Skip to content

Commit

Permalink
Add documentation about phase dependant effects
Browse files Browse the repository at this point in the history
  • Loading branch information
benjaminrose committed Apr 25, 2023
1 parent 9a61b64 commit f2ca708
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,17 @@ this value is perfectly known from the dust map. Therefore, when using
a function such as `~sncosmo.fit_lc` to fit the parameters, be sure *not* to
include ``'mwebv'`` in the list of parameters to vary.

Phase Dependant effects
=======================

Primarily to simulate lensed transients, phase dependant effects can also be
applied. Derived classes of `~sncosmo.PropagationEffect` can add the
```self._minphase`` and ``self._maxphase`` parameters. Once your phase dependant
effect is defined, it can be added to a model in the same way as chromatic
effects, by specifying the appropriate ``effects``, ``effect_frames``, and
``effect_names`` when defining your `~sncosmo.Model`.


Model spectrum
==============

Expand Down
1 change: 1 addition & 0 deletions sncosmo/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -1943,6 +1943,7 @@ class PropagationEffect(_ModelBase):
"""Abstract base class for propagation effects.
Derived classes must define _minwave (float), _maxwave (float).
They may also define _minphase (float), and _maxphase (float).
"""

__metaclass__ = abc.ABCMeta
Expand Down

0 comments on commit f2ca708

Please sign in to comment.