Output Docs Review #1152

Gerenjie · 2025-06-01T03:06:20Z

Finally getting around to my output docs job…

The columns object_linked and date_linked_MJD are missing from the [] but incorrectly present in the The Basic Output Column Names table lists, so I’ve moved them.
fieldID was missing from the ‘all’ and ephemeris output columns, so I’ve added it.
The Example Detections File in Basic Format appear quite different from what I get in the recent run, so I’ve replaced it with the top ten lines of the demo output.
The stats file does not appear to include object_linked so I’ve updated the docs to match. It does include date_linked_MJD, though.
A description of -ew output columns is missing both from this and from the “Ephemeris Generation” page, so I’ve added it here.

Review Checklist for Source Code Changes

Does pip install still work?
Have you written a unit test for any new functions?
Do all the units tests run successfully?
Does Sorcha run successfully on a test set of input files/databases?
Have you used black on the files you have updated to confirm python programming style guide enforcement?

mschwamb · 2025-06-01T07:23:43Z

docs/outputs.rst

@@ -305,8 +309,6 @@ Statistics (Tally) File Column Names, Formats, and Descriptions
 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
 | min_phase                          | Float        | Maximum calculated phase angle for this object in this filter (degrees)                                  |
 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
-| object_linked                      | Boolean      | True/False whether the object was linked by SSP (only included if linking is on)                         |
-+------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
 | date_linked_MJD                    | Float        | Date the object was linked (if it was linked) in MJD (only included if linking is on)                    |


So this stays in it shows up if the drop_unlinked = False

mschwamb · 2025-06-01T07:24:53Z

docs/outputs.rst

@@ -189,19 +189,19 @@ Detections File: Full Output Column Names, Formats, and Descriptions
 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
 | phase_deg                          | Float        | The sun-object-observer angle (degrees)                                                                  |
 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
-| epochMJD_TDB                       | Float        | Epoch of orbit (MJD) in Barycentric Dynamical Time                                                       |
+| q                                  | Float        | Object perihelion (au)                                                                                   |


this depends on what you're doing - I don't have a q because I inputted Keplerian orbit - so I think we need to say orbital elements

mschwamb · 2025-06-01T07:25:00Z

docs/outputs.rst

 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
-| t_p_MJD_TDB                        | Float        | Time of periapsis (MJD)  in Barycentric Dynamical Time                                                   |
+| e                                  | Float        | Orbital eccentricity                                                                                     |


this depends on what you're doing - I don't have a q because I inputted Keplerian orbit - so I think we need to say orbital elements

mschwamb · 2025-06-01T07:25:05Z

docs/outputs.rst

 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
-| argPeri                            | Float        | Argument of periaspsis of the object (degrees)                                                           |
+| inc                                | Float        | Orbital inclination (degrees)                                                                            |


this depends on what you're doing - I don't have a q because I inputted Keplerian orbit - so I think we need to say orbital elements

mschwamb · 2025-06-01T07:25:11Z

docs/outputs.rst

 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
 | node                               | Float        | Longitude of the ascending node of the object (degrees)                                                  |
 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
-| inc                                | Float        | Orbital inclination (degrees)                                                                            |
+| argPeri                            | Float        | Argument of periaspsis of the object (degrees)                                                           |


this depends on what you're doing - I don't have a q because I inputted Keplerian orbit - so I think we need to say orbital elements

mschwamb · 2025-06-01T07:25:15Z

docs/outputs.rst

 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
-| e                                  | Float        | Orbital eccentricity                                                                                     |
+| t_p_MJD_TDB                        | Float        | Time of periapsis (MJD)  in Barycentric Dynamical Time                                                   |


this depends on what you're doing - I don't have a q because I inputted Keplerian orbit - so I think we need to say orbital elements

mschwamb · 2025-06-01T07:25:32Z

docs/outputs.rst

 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
-| q                                  | Float        | Object perihelion (au)                                                                                   |
+| epochMJD_TDB                       | Float        | Epoch of orbit (MJD) in Barycentric Dynamical Time                                                       |


This is always there, but part of orbital elements

mschwamb · 2025-06-01T07:25:54Z

docs/outputs.rst

 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
-| q                                  | Float        | Object perihelion (au)                                                                                   |
+| epochMJD_TDB                       | Float        | Epoch of orbit (MJD) in Barycentric Dynamical Time                                                       |
 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
 | FORMAT                             | Float        | Orbit format string (COM for heliocentric, BCOM for barycentric, KEP for Keplerian, CART for Cartesian)  |
 +------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+


Same thing as above we might want to say orbits

mschwamb · 2025-06-01T07:31:34Z

docs/outputs.rst

+| object_linked                      | Boolean      | True/False whether the object passed the linking filter. See note below                                  |
+------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+
+| date_linked_MJD                    | Boolean      | MJD (TAI) Date the object was linked (if it was linked) See note below                                   |
+------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+

 .. note::
   All positions, positions, and velocities are in respect to J2000.


Let's have a note about object_linked and date_linked_MJD here - object_linked only shows up if the user has drop_unlinked=True in full output

After some tests, I see them both showing up for both values of object_linked and have changed the docs to match.

mschwamb · 2025-06-01T07:45:59Z

docs/outputs.rst

+
+.. note::
+   All columns in the comple physicalx parameters file will also be included in the full output.
+


We have this under the inputs section - we should directly link there, but I think better to not duplicate here otherwise we have things to maintain - check the inputs is correct - I am pretty sure it is.

Not sure how to do links in documentation.

I can add it in once this PR goes in

I believe I've responded to / fixed according to all your comments -- is there anything else blocking this review?

Just me having waking hours to do it - working on it now

mschwamb

Thanks fort doing this and spotting typos and missing columns - a few suggested edits/clarifications and a request about the ephemeris output

Gerenjie · 2025-06-02T16:56:01Z

I've made changes in response to your comments.

fix typo

make updates/minor corrections

fix link

…ute/sorcha into jake_outputs_review

Jake's review

de22235

Gerenjie requested a review from mschwamb June 1, 2025 03:06

mschwamb reviewed Jun 1, 2025

View reviewed changes

mschwamb requested changes Jun 1, 2025

View reviewed changes

Edited to Meg's feedback

4cf64ea

mschwamb added 10 commits June 3, 2025 10:25

Update outputs.rst

f7136cb

fix typo

Update outputs.rst

663b980

Update outputs.rst

4be9f6c

Update outputs.rst

69e39da

make updates/minor corrections

doc updates

29373b4

fix typo

c205353

fix typos

b7de273

fix typo

e42c1df

fix link

67b949d

fix link

last typo

d106d9f

mschwamb self-requested a review June 3, 2025 09:51

mschwamb added 4 commits June 3, 2025 11:51

Delete sorcha_config_demo.ini

9d70ef8

Delete testrun_stats.csv

a3ee374

Delete sspp_testset_orbits.des

cb66978

Delete sspp_testset_colours.txt

4bbdc3e

mschwamb added 3 commits June 3, 2025 11:53

Delete testrun_e2e.csv

5f033dc

Delete baseline_v2.0_1yr.db

85d5a15

Merge branch 'jake_outputs_review' of https://github.com/dirac-instit…

4cbe879

…ute/sorcha into jake_outputs_review

mschwamb approved these changes Jun 3, 2025

View reviewed changes

mschwamb merged commit 89208b1 into main Jun 3, 2025
7 checks passed

mschwamb deleted the jake_outputs_review branch June 3, 2025 09:56


		.. note::
		All columns in the comple physicalx parameters file will also be included in the full output.

Output Docs Review #1152

Output Docs Review #1152

Uh oh!

Conversation

Gerenjie commented Jun 1, 2025 • edited by mschwamb Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review Checklist for Source Code Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mschwamb Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mschwamb left a comment

Choose a reason for hiding this comment

Uh oh!

Gerenjie commented Jun 2, 2025

Uh oh!

Uh oh!

Uh oh!

Gerenjie commented Jun 1, 2025 •

edited by mschwamb

Loading

mschwamb Jun 1, 2025 •

edited

Loading