Merge pull request #1120 from fedorets/main

Docreview, Grigori's part

docs/ephemerisgen.rst

@@ -10,7 +10,7 @@ Ephemeris Generator
 
 
 .. seealso::
-   For a more detailed description of ``Sorcha``'s ephemeris generation stage  please see Holman et al. (submitted).
+   For a more detailed description of ``Sorcha``'s ephemeris generation stage  please see `Holman et al. (submitted)<https://www.dropbox.com/scl/fi/lz1lmua2s0yf9t9a2gpmm/sorcha_ephemeris_generation_paper.pdf?rlkey=blm9u4zbk0ci1i4lc5yqz8dbs&e=1&dl=0>`.
 
 How It Works
 --------------------------------------------------------
@@ -72,7 +72,7 @@ There are several tunable options for the ephemeris generation which are describ
 - Field of view of our search field (in degrees) (**ar_ang_fov** configuration parameter)
 - Buffer zone around the field of view we want to include (in degrees) (**ar_fov_buffer** configuration parameter)
 - Picket length (in days) (**ar_picket** configuration parameter) 
-- Order of healpix used by healpy (*ar_healpix_order** configuration parameter)
+- Order of healpix used by healpy (**ar_healpix_order** configuration parameter)
 
 To use ``Sorcha``'s internal ephemeris generation engine, the configuration file should contain::
 
@@ -103,7 +103,7 @@ Required Auxiliary Files
 A number of auxiliary files available from the `Minor Planet Center <https://www.minorplanetcenter.net/data>`_  and `NASA's Navigation and Ancillary Information Facility (NAIF) <https://naif.jpl.nasa.gov/pub/naif/generic_kernels/>`_ are required for ephemeris generation:
 
 - **naif0012.tls** is the leap second file. This changes whenever there is a new leap second. The last was in 2017.
-- **"earth_620120_240827.bpc** is the historical Earth orientation specification. This should not change, unless there is a new model.
+- **earth_620120_240827.bpc** is the historical Earth orientation specification. This should not change, unless there is a new model.
 - **earth_200101_990827_predict.bpc** is a prediction of the Earth's future orientation. Likewise, this should not change.
 - **pck00010.tpc** contains orientation information and physical constants for other bodies. This should only change rarely.
 - **de440s.bsp** gets planetary ephemerides.

docs/overview.rst

@@ -18,10 +18,10 @@ The :ref:`inputs<Inputs>` that ``Sorcha`` requires are shown in the figure below
   :width: 800
   :alt: An overview of the inputs and outputs for Sorcha
 
-``Sorcha`` is split into two stages :ref:`ephemeris generation<ephemeris_gen>` and :ref:`post-processing<post_processing>`. **Ephemeris generation** calculates the on-sky position of the simulated objects and matches them to the survey observations in which they appear. **Post-Processing** performs the apparent magnitude calculations and apply the rest of the survey's observational biases (such as detection effiency) in order to identify which objects in the input small body population would have been discovered by the discovery and the observations the objects would have been detected in.  
+``Sorcha`` is split into two stages: :ref:`ephemeris generation<ephemeris_gen>` and :ref:`post-processing<post_processing>`. **Ephemeris generation** calculates the on-sky position of the simulated objects and matches them to the survey observations in which they appear. **Post-processing** performs the apparent magnitude calculations and apply the rest of the survey's observational biases (such as detection effiency) in order to identify which objects in the input small body population would have been discovered by the discovery and the observations the objects would have been detected in.  
 
 
-``Sorcha`` by default uses its own :ref:`ephemeris generator<ephemeris_gen>` to propagate the orbits and translate them to on-sky locations and rates. ``Sorcha``'s ephemeris generator is powered by `ASSIST  <https://github.com/matthewholman/assist>`_, a software package for ephemeris-quality integrations of test particles, and the `REBOUND <https://rebound.readthedocs.io/en/latest/>`_ N-body integrator.  If the user prefers to use a different generator, ``Sorcha`` can  be initialized with an external ephemeris file with pre-calculated ephemerides of the input synthetic orbital population.  
+``Sorcha`` by default uses its own :ref:`ephemeris generator<ephemeris_gen>` to propagate the orbits and translate them to on-sky locations and rates. ``Sorcha``'s ephemeris generator is powered by `ASSIST  <https://assist.readthedocs.io/en/latest/>`_, a software package for ephemeris-quality integrations of test particles, and the `REBOUND <https://rebound.readthedocs.io/en/latest/>`_ N-body integrator.  If the user prefers to use a different generator, ``Sorcha`` can  be initialized with an external ephemeris file with pre-calculated ephemerides of the input synthetic orbital population.  
 
 The default main steps, calculations, and filters within ``Sorcha`` that are used to estimate what the LSST would discover are shown below. 
 

docs/whatsorchadoesnotdo.rst

@@ -6,14 +6,14 @@ modular nature of the package, it should be straightforward to develop functions
 in the future. If you want to add any of these features into ``Sorcha``, please check out our 
 :ref:`reporting` page.
 
-Here is a short summary of the key effects not accounted for in ``Sorcha'':
+Here is a short summary of the key effects not accounted for in ``Sorcha``:
 
 - 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. 
+- Handling or including false detections/linkages
 
 
 .. seealso::