Skip to content

Commit e5684ba

Browse files
authored
Merge pull request #1149 from dirac-institute/pertrubers_doc_updates
additional doc reminder saying that massive asteroid perturbers are bad to simulate
2 parents bd9a143 + 61e25cc commit e5684ba

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

docs/ephemerisgen.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Here's the list of asteroid pertubers that are included in the ASSIST+REBOUND in
5959
- **(4) Vesta = A807 FA**
6060

6161
.. warning::
62-
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.
62+
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.
6363

6464
.. _tuneem:
6565

docs/postprocessing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Left and Right: The trailing losses for different values of the seeing θ, shown
129129
of the object’s on-sky velocity v, given in degrees per day on the bottom axis and pixels per 30 s visit on
130130
the upper axis. Right: A zoomed in version of the figure on the left for low v. Vertical lines represent the
131131
thresholds for typical on-sky motions of a TNO (Trans-Neptunian object), a Jupiter Trojan, and inner and
132-
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>`.
132+
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>`_.
133133

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

249249
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**.
250250

251-
.. _vignettting:
251+
.. _vignetting:
252252

253253
Calculating the 5σ Limiting Magnitude at the Source Location and Vignetting
254254
----------------------------------------------------------------------------------------------------

docs/whatsorchadoesnotdo.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,23 @@ in the future. If you want to add any of these features into ``Sorcha``, please
88

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

11+
- Properly simulating the locations of the 16 massive asteroid perturbers in the main belt. Further details can be found :ref:`here<MAP>`.
1112
- Changing phase curves due to changing viewing angles (impacts some inner Solar System objects)
1213
- Stellar crowding as a function of galactic latitude
1314
- 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.
1415
- Properly handling collisions between the planets and the simulated objects
1516
- Removing simulated objects due to small body collisions and breakup events
1617
- Handling or including false detections/linkages
18+
- 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.
1719

1820

1921
.. seealso::
2022
We do have methods for users to easily develop their own functions for adjusting the apparent
2123
magnitude of the simulated objects due to cometary activity, rotational light curves, cometary
2224
outbursts, etc. We have some basic functionality already built for simple sinusoidal rotational
2325
light curves and cometary activity. Further details can be found :ref:`here<addons>`.
26+
27+
.. warning::
28+
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.
29+
30+

0 commit comments

Comments
 (0)