doc updates

- update sql query - fix typos - fix some sphinx errors and warnings
dirac-institute · Oct 28, 2023 · 293b397 · 293b397
1 parent 9951715
commit 293b397
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 10 deletions.
diff --git a/docs/configfiles.rst b/docs/configfiles.rst
@@ -49,11 +49,11 @@ Sorcha's **ppsqldbquery** config file parameter contain the sql query for obtain
 
 From rubin_sim v2.0 simulations onward use the query::
 
-  SELECT observationId, observationStartMJD as observationStartMJD_TAI, filter, seeingFwhmGeom, seeingFwhmEff, fiveSigmaDepth, fieldRA, fieldDec, rotSkyPos FROM observations order by observationId
+  SELECT observationId, observationStartMJD as observationStartMJD_TAI, visitTime, filter, seeingFwhmGeom, seeingFwhmEff, fiveSigmaDepth, fieldRA, fieldDec, rotSkyPos FROM observations order by observationId
 
 For past rubin_sim/OpSim simulations pre-v2.0 use the query::
 
-  SELECT observationId, observationStartMJD as observationStartMJD_TAI, filter, seeingFwhmGeom, seeingFwhmEff, fiveSigmaDepth, fieldRA, fieldDec, rotSkyPos FROM SummaryAllProps order by observationId
+  SELECT observationId, observationStartMJD as observationStartMJD_TAI, visitTime, filter, seeingFwhmGeom, seeingFwhmEff, fiveSigmaDepth, fieldRA, fieldDec, rotSkyPos FROM SummaryAllProps order by observationId
 
 .. _makeConfigPP:
 

diff --git a/docs/ephemerisgen.rst b/docs/ephemerisgen.rst
@@ -26,6 +26,7 @@ For each survey visit, the generator calculates the location of the observatory
   For further details, we recommend you read the `ASSIST <https://ui.adsabs.harvard.edu/abs/2023PSJ.....4...69H/abstract>`__ and `REBOUND <https://ui.adsabs.harvard.edu/abs/2012A%26A...537A.128R/abstract>`__ papers. 
 
 .. _MAP:
+
 Massive Asteroid Perturbers
 --------------------------------------------------------
 Here's the list of asteroid pertubers that are included in the ASSIST+REBOUND integrations.
@@ -48,7 +49,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 epehmeris generator because of how the n-body integration is setup. 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 epehmeris generator because of how the n-body integration is setup. We recommend getting the positions of these asteroids from some other source and inputting them as an external ephemeris file. 
 
 Tuning the Ephemeris Generator
 -----------------------------------
@@ -78,5 +79,5 @@ A number of auxillary file available from the `Minor Planet Center <https://www.
 - **obscodes_extended.json** - observatory position information and Minor Planet Center (MPC) observatory codes.
 
 .. tip::
-  See our :ref:`installation_aux` instructions to find out how to download and install these auxillary files automaticlal using our download utility. 
+  See our :ref:`installation_aux` instructions to find out how to download and install these auxillary files automatically using our download utility. 
 
diff --git a/docs/filters.rst b/docs/filters.rst
@@ -48,8 +48,7 @@ To include this filter, the following options should be set in the configuration
 
 .. image:: images/fading_function.png
   :width: 400
-  :alt: Graph showing the fading function. Detection probability is plotted against magnitude - limiting magnitude,
-  showing three smoothed step-functions centred on 0.0 on the x axis for three different widths.
+  :alt: Graph showing the fading function. Detection probability is plotted against magnitude - limiting magnitude, showing three smoothed step-functions centred on 0.0 on the x axis for three different widths.
   :align: center
 
 
@@ -87,8 +86,7 @@ gaps between the chips. The LSST detector shape is included in the repo and desc
 
 .. image:: images/Footprint.png
   :width: 600
-  :alt: Plot of the LSST camera footprint where x and y are x and y distance from the pupil in degrees. The footprint also shows
-  two overplotted circle radii of 1.75deg (corresponding to a 75% fill factor) and 2.06deg.
+  :alt: Plot of the LSST camera footprint where x and y are x and y distance from the pupil in degrees. The footprint also shows two overplotted circle radii of 1.75deg (corresponding to a 75% fill factor) and 2.06deg.
 
 However, the full camera footprint is most relevant for slow-moving objects, where an 
 object may move only a small amount per night and could thus in a subsequent observation fall into a chip gap. This is less concerning for 
@@ -208,4 +206,4 @@ The defaults given below are those used by SSP and are explained in the comments
     # complete track/detection.
     SSP_track_window = 15
 
- 
+ 
diff --git a/docs/support.rst b/docs/support.rst
@@ -37,7 +37,7 @@ You will need to install the development version of Sorcha from a clone of the S
 
 You will also  install the pandoc package (either via conda/pip or `direct download <https://pandoc.org/installing.html>`_ . 
 
-If you move to the docs directory (cd sorcha/docs/), edit the *.rst files, and run::
+If you move to the docs directory (cd sorcha/docs/), edit the .rst files, and run::
 
    make html