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.

Sign up for GitHub

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

doc review updates #1121

Merged
merged 1 commit into from
Feb 2, 2025
Merged

doc review updates #1121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions docs/inputs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Inputs
==========

``Sorcha`` requires two input files describing the synthetic solar system objects to simulate -- one for the orbital parameters and one for the physical parameters -- as well as survey pointing database. Optionally, the user can provide a pre-generated ephemeris with the positions of each object near the survey pointings and a complex physical parameter file for rotational light curves and cometary activity. Each of these files are described within this section and example files are shown.
``Sorcha`` requires two input files describing the synthetic solar system objects to simulate -- one for the orbital parameters and one for the physical parameters -- as well as a survey pointing database. Optionally, the user can provide a pre-generated ephemeris file with the positions of each object and a complex physical parameter file for rotational light curves and cometary activity. Each of these files are described within this section and example files are shown.


.. image:: images/survey_simulator_flow_chart.png
Expand Down Expand Up @@ -74,9 +74,9 @@ Cometary Orbit Format Required Columns
+=============+==================================================================================+
| ObjID | Object identifier for each synthetic planetesimal simulated (string) |
+-------------+----------------------------------------------------------------------------------+
| FORMAT | Orbit format string (COM for heliocentric or BCOM for barycentric) |
| FORMAT | Orbit format string (COM for heliocentric or BCOM for barycentric) |
+-------------+----------------------------------------------------------------------------------+
| q | Perihelion distance(au) |
| q | Perihelion distance (au) |
+-------------+----------------------------------------------------------------------------------+
| e | Eccentricity |
+-------------+----------------------------------------------------------------------------------+
Expand All @@ -86,7 +86,7 @@ Cometary Orbit Format Required Columns
+-------------+----------------------------------------------------------------------------------+
| argPeri | Argument of perihelion (degrees) |
+-------------+----------------------------------------------------------------------------------+
| t_p_MJD_TDB | Time of periapsis (years, MJD) |
| t_p_MJD_TDB | Time of periapsis (MJD) |
+-------------+----------------------------------------------------------------------------------+
| epochMJD_TDB| Epoch (MJD) |
+-------------+----------------------------------------------------------------------------------+
Expand Down Expand Up @@ -249,7 +249,7 @@ Example Physical Parameters File (a HG value is specified for each observing fil
St500003a 6.67 1.72 0.48 -0.11 -0.12 -0.12 0.15 0.16 0.12 0.20 0.15 0.19
St500004a 10.2 1.90 0.58 -0.21 -0.30 -0.39 0.15 0.15 0.16 0.15 0.14 0.16

Rubin Observatory will survey the sky in six broadband (optical filters), *u, g, r, i, z,* and *y* . In the physical parameters file, you will specify the object's absolute magnitude in the main filter (as specified in the :ref:`configuration file<configs>` (sually this is g or r band) and then provide the synthetic planetesimal's color in other filters relative to the main filter.
Rubin Observatory will survey the sky in six broadband (optical filters), *u, g, r, i, z,* and *y* . In the physical parameters file, you will specify the object's absolute magnitude in the main filter as specified in the :ref:`configuration file<configs>` (usually this is g or r band) and then provide the synthetic planetesimal's color in other filters relative to the main filter.


Required Physical Parameters File Columns and Format
Expand All @@ -268,7 +268,7 @@ Required Physical Parameters File Columns and Format
+------------------+----------------------------------------------------------------------------------+

.. note::
The Phase curve parameters(s) column will not be present if the phase curve function/calculation is set to None in the :ref:`configuration file<configs>'.
The Phase curve parameters(s) column will not be present if the phase curve function/calculation is set to None in the :ref:`configuration file<configs>`.

.. note::
In the :ref:`configuration file<configs>` you can decide which filters you want to have ``Sorcha`` run on and specify which filter is the main filter that the absolute magnitude is defined for. You only need to provide colors for those filters specified in the :ref:`configuration file<configs>`.
Expand All @@ -284,7 +284,7 @@ Required Physical Parameters File Columns and Format
Physical Parameters File Configuration Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``Sorcha`` is initialized for the format of the input physical parameters file through the :ref:`configuration file<configs>` INPUT, FILTERS. and PHASECURVES sections:
``Sorcha`` is initialized for the format of the input physical parameters file through the :ref:`configuration file<configs>` INPUT, FILTERS, and PHASECURVES sections:

.. code-block::

Expand Down
8 changes: 4 additions & 4 deletions docs/troubleshooting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ Troubleshooting

Have You Checked the Error Log File?
---------------------------------------------------------------
If ``Sorcha`` runs successfully the .err log file created will be empty. If the software exited gracefully with an error it will print error statements to the error log file. If ``Sorcha'' looks like it completed but you're not getting the expected output, the .err log file is the first place to check.
If ``Sorcha`` runs successfully the .err log file created will be empty. If the software exited gracefully with an error it will print error statements to the error log file. If ``Sorcha`` looks like it completed but you're not getting the expected output, the .err log file is the first place to check.

.. tip::
You can also usee the **-l** flag to set get more detailed and informative messages in the log file produced by **sorcha run**.

Using Relative File Paths
---------------------------------------------------------------

If you're using relative paths (e.g. '../this_directory') and those do not seem to be working, try using the full directory/file paths.
If you're using relative paths (e.g. '../this_directory') and those do not seem to be working, try using the absolute directory/file paths.

Running Multiple Instances With the Same Output Directories
---------------------------------------------------------------
Expand Down Expand Up @@ -42,7 +42,7 @@ If you see an error like::

ERROR: PPReadPointingDatabase: SQL query on pointing database failed. Check that the query is correct in the config file.

it might be your computer setup. SQLite uses a temporary store to hold temporary files, and if it configured on your machine with a small quota you might get an error. You can fix this by setting the SQLITE_TEMPDIR environment variable to a folder in your working directory. Then if this variable is defined, SQLite will automatically default to using this pathway for its temporary store.
The issue may be your computer setup. SQLite uses a temporary store to hold temporary files, and if it configured on your machine with a small quota you might get an error. You can fix this by setting the SQLITE_TEMPDIR environment variable to a folder in your working directory. Then if this variable is defined, SQLite will automatically default to using this pathway for its temporary store.

Mismatch in Inputs
---------------------
Expand All @@ -55,7 +55,7 @@ physical/complex physical parameter value, so if you get an error like::

ERROR: PPCheckOrbitAndColourMatching: input colour/cometary parameter and orbit files do not match.

then make sure to check that you have entries in all the input files for each object you wish to simulate.
Check that you have entries in all the input files for each object you wish to simulate.


ERROR: Unable to find ObjID column headings (OrbitAuxReader:....)
Expand Down