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

update for change of sorcha community utils rename #707

Merged
merged 1 commit into from
Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion docs/complexparameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Cometary Activity or Simulating Other Active Objects
Rotational Light Curve Effects
-----------------------------------

The base lightcurve class is `AbstractLightCurve <https://github.com/dirac-institute/sorcha/blob/04baa79a7d67e1647b839a2d3880d8bfd9ce4624/src/sorcha/lightcurves/base_lightcurve.py#L10>`_ (see below). Inside the `Sorcha Community Utils github repository <https://github.com/dirac-institute/sorcha_community_utils>`_, we provide a simple example implementation where the apparent magnitude of the object (that is, the magnitude after all geometric effects have been taken into account), has a sinusoidal term added to it. To use this function, in the :ref:`CPP` file, the user must provide a light curve amplitude (`LCA`), corresponding to half the peak-to-peak amplitude for the magnitude changes, a period `Period`, and a reference time `Time0` where the light curve is at 0 - if these are not provided, the software will produce an error message. Despite being simple, that implementation shows all the class methods that need to be implemented for a custom light curve function.
The base lightcurve class is `AbstractLightCurve <https://github.com/dirac-institute/sorcha/blob/04baa79a7d67e1647b839a2d3880d8bfd9ce4624/src/sorcha/lightcurves/base_lightcurve.py#L10>`_ (see below). Inside the `sorcha addons github repository <https://github.com/dirac-institute/sorcha-addons>`_, we provide a simple example implementation where the apparent magnitude of the object (that is, the magnitude after all geometric effects have been taken into account), has a sinusoidal term added to it. To use this function, in the :ref:`CPP` file, the user must provide a light curve amplitude (`LCA`), corresponding to half the peak-to-peak amplitude for the magnitude changes, a period `Period`, and a reference time `Time0` where the light curve is at 0 - if these are not provided, the software will produce an error message. Despite being simple, that implementation shows all the class methods that need to be implemented for a custom light curve function.

.. literalinclude:: ../src/sorcha/lightcurves/base_lightcurve.py
:language: python
Expand Down
2 changes: 1 addition & 1 deletion docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Release History
See what's in the latest Sorcha release and the contents of past Sorcha releases `here <https://github.com/dirac-institute/sorcha/releases>`__.


See what's in each Sorcha Community Utilities release and in past releases `here <https://github.com/dirac-institute//sorcha_community_utils/releases>`__.
See what's in each Sorcha addons release and in past releases `here <https://github.com/dirac-institute//sorcha-addons/releases>`__.

2 changes: 1 addition & 1 deletion docs/whatsorchadoesnotdo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Here is a short summary of the key effects not accounted for in Sorcha:
magnitude of the simulated objects due to cometary activity, rotational light curves, cometary
outbursts, etc. We have some basic functionality already built for simple sinusoidal rotational
light curves and cometary activity. Further details can be found in the
`Sorcha community tools <https://sorcha-community-utils.readthedocs.io/en/latest/?badge=latest>`_.
`sorcha addons <https://sorcha-addons.readthedocs.io/en/latest/?badge=latest>`_.
2 changes: 1 addition & 1 deletion src/sorcha/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# desired, the user should install SCU manually in their virtual environment
# prior to executing Sorcha.
try:
from sorcha_community_utils import *
from sorcha_addons import *
except ModuleNotFoundError:
pass

Expand Down