Skip to content
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/ephemerisgen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Here's the list of asteroid pertubers that are included in the ASSIST+REBOUND in
- **(4) Vesta = A807 FA**

.. warning::
If you simulate the orbits of these select asteroids you will get **POOR results** with the internal ``Sorcha`` ephemeris generator because of how the n-body integration is set up. We recommend getting the positions of these asteroids from some other source and inputting them as an external ephemeris file.
If you simulate the orbits of these select asteroids, you will get **POOR results** with the internal ``Sorcha`` ephemeris generator because of how the n-body integration is set up. We recommend getting the positions of these asteroids from some other source and inputting them as an external ephemeris file.

.. _tuneem:

Expand Down
4 changes: 2 additions & 2 deletions docs/postprocessing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Left and Right: The trailing losses for different values of the seeing θ, shown
of the object’s on-sky velocity v, given in degrees per day on the bottom axis and pixels per 30 s visit on
the upper axis. Right: A zoomed in version of the figure on the left for low v. Vertical lines represent the
thresholds for typical on-sky motions of a TNO (Trans-Neptunian object), a Jupiter Trojan, and inner and
outer MBAs (main-belt asteroids), a Jupiter Trojan, and inner and outer MBAs (main-belt asteroids) :ref:`(Luu & Jewitt 1988, Equation 1) <https://ui.adsabs.harvard.edu/abs/1988AJ.....95.1256L/abstract>`.
outer MBAs (main-belt asteroids), a Jupiter Trojan, and inner and outer MBAs (main-belt asteroids) `(Luu & Jewitt 1988, Equation 1) <https://ui.adsabs.harvard.edu/abs/1988AJ.....95.1256L/abstract>`_.

.. warning::
Right now ``Sorcha`` only has functions to compute the trailing losses for the LSST.
Expand Down Expand Up @@ -248,7 +248,7 @@ Sinusoidal Light Curve Class

Inside the `Sorcha add-ons 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. We have an `example Jupyter notebook <notebooks/demo_Lightcurve.ipynb>`_ demonstrating the SinusoidalLightCurve class built into `Sorcha add-ons package <https://github.com/dirac-institute/sorcha-addons>`_, To use this prescription, the **lc_model** :ref:`configuration file<configs>` variable should be set to **sinusoidal**.

.. _vignettting:
.. _vignetting:

Calculating the 5σ Limiting Magnitude at the Source Location and Vignetting
----------------------------------------------------------------------------------------------------
Expand Down
7 changes: 7 additions & 0 deletions docs/whatsorchadoesnotdo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,23 @@ in the future. If you want to add any of these features into ``Sorcha``, please

Here is a short summary of the key effects not accounted for in ``Sorcha``:

- Properly simulating the locations of the 16 massive asteroid perturbers in the main belt. Further details can be found :ref:`here<MAP>`.
- Changing phase curves due to changing viewing angles (impacts some inner Solar System objects)
- Stellar crowding as a function of galactic latitude
- Non-gravitational forces including cometary outgassing or Yarkovsky or YORP (Yarkovsky–O'Keefe–Radzievskii–Paddack) effect. Although not directly handled, you can input your own ephemeris files that account for these effects if required.
- Properly handling collisions between the planets and the simulated objects
- Removing simulated objects due to small body collisions and breakup events
- Handling or including false detections/linkages
- Using space-based or moving observatory locations. We currently require an observatory code for a stationary observatory on the Earth with a location that is reported to the Minor Planet Center.


.. seealso::
We do have methods for users to easily develop their own functions for adjusting the apparent
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 :ref:`here<addons>`.

.. warning::
If you simulate the orbits of 16 massive asteroid perturbers listed :ref:`here<MAP>`, you will get **POOR results** with the internal ``Sorcha`` ephemeris generator because of how the n-body integration is set up. We recommend getting the positions of these asteroids from some other source and inputting them as an external ephemeris file.