Skip to content

Commit 92118a7

Browse files
committed
updates to docs and JOSS submission
- updates to docs and JOSS submission - also removing temp file that should not have been added to the last push to this PR
1 parent 642f8c3 commit 92118a7

File tree

5 files changed

+13
-611
lines changed

5 files changed

+13
-611
lines changed

JOSS_submission/paper.bib

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ @article{petit2011
465465

466466

467467
@ARTICLE{rein2012,
468-
author = {{Rein}, H. and {Liu}, S. -F.},
468+
author = {Rein, H. and Liu, S.-F.},
469469
title = "{REBOUND: an open-source multi-purpose N-body code for collisional dynamics}",
470470
journal = {A\&A},
471471
keywords = {methods: numerical, planets and satellites: rings, protoplanetary disks, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics, Mathematics - Dynamical Systems, Physics - Computational Physics},
@@ -484,7 +484,7 @@ @ARTICLE{rein2012
484484

485485

486486
@ARTICLE{rein2015,
487-
author = {{Rein}, Hanno and {Spiegel}, David S.},
487+
author = {Rein, H. and Spiegel, D. S.},
488488
title = "{IAS15: a fast, adaptive, high-order integrator for gravitational dynamics, accurate to machine precision over a billion orbits}",
489489
journal = {Monthly Notices of the Royal Astronomical Society},
490490
keywords = {gravitation, methods: numerical, planets and satellites: dynamical evolution and stability, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics, Mathematics - Numerical Analysis},

JOSS_submission/paper.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,15 @@ aas-journal: Astronomical Journal
120120

121121
# Statement of Need
122122

123-
The upcoming Legacy Survey of Space and Time (LSST) at the Vera C. Rubin Observatory [@lsstsciencebook2009; @ivezic2019; @bianco2022] is expected to revolutionize solar system astronomy. Unprecedented in scale, this ten-year wide-field survey will take ~2 million exposures split between 6 filters while also discovering and monitoring millions more solar system objects than are currently known [@jones2009; @jones2018; @lsstsciencebook2009; @solontoi2010; @shannon2015; @grav2016; @silsbee2016; @veres2017; @schwamb2018; @ivezic2019; @fedorets2020; @hoover2022; @kurlander2025; @murtagh2025]. This wealth of new information surpasses any survey to date in its combination of depth, sky coverage and sheer number of observations, The LSST will enable planetary astronomers to probe the dynamics and formation history of the solar system on a scale never before attempted. However, all astronomical surveys are affected by a complex set of intertwined observational biases, including observational strategy and cadence, limiting magnitude, instrumentation effects and observing conditions. The small body discoveries from an astronomical survey therefore provide a biased and distorted view of the actual underlying population. To help address this, survey simulators have emerged as powerful tools for assessing the impact of observational biases and aiding in the study of the target population. Survey simulators have long been used in smaller population-specific surveys such as the Canada–France Ecliptic Plane Survey (CFEPS) [@jones2006; @kavelaars2009; @petit2011] and the Outer Solar System Origins Survey (OSSOS) [@bannister2016; @bannister2018; @lawler2018] to forward-model the effects of biases on a given population, allowing for a direct comparison to real discoveries. However, the scale and tremendous scope of the LSST requires the development of a new tool capable of handling the scale of the Rubin Observatory’s LSST and all solar system small body populations.
123+
The upcoming Legacy Survey of Space and Time (LSST) at the Vera C. Rubin Observatory [@lsstsciencebook2009; @ivezic2019; @bianco2022] is expected to revolutionize solar system astronomy. Unprecedented in scale, this ten-year wide-field survey will take ~2 million exposures split between 6 filters while also discovering and monitoring millions more solar system objects than are currently known [@jones2009; @jones2018; @lsstsciencebook2009; @solontoi2010; @shannon2015; @grav2016; @silsbee2016; @veres2017; @schwamb2018; @ivezic2019; @fedorets2020; @hoover2022; @kurlander2025; @murtagh2025]. This wealth of new information surpasses any survey to date in its combination of depth, sky coverage and sheer number of observations, The LSST will enable planetary astronomers to probe the dynamics and formation history of the solar system on a scale never before attempted. However, all astronomical surveys are affected by a complex set of intertwined observational biases, including observational strategy and cadence, limiting magnitude, instrumentation effects and observing conditions. The small body discoveries from an astronomical survey therefore provide a biased and distorted view of the actual underlying population. To help address this, survey simulators have emerged as powerful tools for assessing the impact of observational biases and aiding in the study of the target population. Open source survey simulators have long been used in smaller population-specific surveys such as the Canada–France Ecliptic Plane Survey (CFEPS) [@jones2006; @kavelaars2009; @petit2011] and the Outer Solar System Origins Survey (OSSOS) [@bannister2016; @bannister2018; @lawler2018] to forward-model the effects of biases on a given population, allowing for a direct comparison to real discoveries. However, there is no commonly-used package available already suitable for the job for future petatybe Solar System discovery surveys. The CFEPS and OSSOS survey simulators are specifically designed for their bespoke surveys. The scale and tremendous scope of the LSST requires the development of a new tool capable of handling the scale of the Rubin Observatory’s LSST and all solar system small body populations.
124124

125-
Probing the orbital/size/brightness distributions and surface composition in each of the solar system's small body reservoirs is the top science priority in the Rubin Observatory LSST Solar System Science Collaboration (SSSC) Science Roadmap [@schwamb2018]. In order to perform these detailed population studies, one must account for all the survey biases (the complex and often intertwined detection biases – brightness limits, pointing, cadence, on-sky motion limits, software detection efficiencies) in the discovery survey (see @lawler2018 for a more detailed discussion). The SSSC’s Software Roadmap has identified a solar system survey simulator as one of the key software tools that must be developed in order to achieve the collaboration’s top science goals [@schwamb2019]. A survey simulator takes an input model small body population and outputs (biases the population to) what LSST should have detected by utilizing the LSST pointing history, observation metadata, and Rubin Observatory Solar System Processing (SSP) pipeline’s detection efficiency so one can compare those simulated LSST detections to what was actually found by Rubin Observatory.
125+
Probing the orbital/size/brightness distributions and surface composition in each of the solar system's small body reservoirs is the top science priority in the Rubin Observatory LSST Solar System Science Collaboration (SSSC) Science Roadmap [@schwamb2018]. In order to perform these detailed population studies, one must account for all the survey biases (the complex and often intertwined detection biases – brightness limits, pointing, cadence, on-sky motion limits, software detection efficiencies) in the discovery survey (see [@lawler2018] for a more detailed discussion). The SSSC’s Software Roadmap has identified a solar system survey simulator as one of the key software tools that must be developed in order to achieve the collaboration’s top science goals [@schwamb2019]. A survey simulator takes an input model small body population and outputs (biases the population to) what LSST should have detected by utilizing the LSST pointing history, observation metadata, and Rubin Observatory Solar System Processing (SSP) pipeline’s detection efficiency so one can compare those simulated LSST detections to what was actually found by Rubin Observatory.
126126

127127
# Summary
128128

129129
`Sorcha` is a multipurpose, open-source solar system survey simulator for the LSST. Its modular design and configuration file allows each simulation to be finely customized by the user for their specific needs. `Sorcha` was designed to work at the large scale demanded by the large data rate from the LSST, and simulations can be run on high-performance computing clusters or on a researcher's laptop/desktop machine. The simulator can be used to facilitate predictions before the LSST begins science operations and to achieve a wide range of science goals when the LSST solar system discoveries are available.
130130

131-
Built in Python to be flexible, easy-to-use, and applicable to all solar system small body populations, 'Sorcha’ runs on the command-line, ingesting files which describe the input population and the input survey. To predict the position of millions of solar system objects over ten years and over ~billion observations in a reasonable timescale, `Sorcha` makes use of an ephemeris generator (described in @holman2025) powered by ASSIST [@holman2023], an open-source Python and C99 software package for producing ephemeris-quality integrations of solar system test particles using the the IAS15 (15th order Gauss-Radau) integrator [@rein2015] within the REBOUND N-body integrator package [@rein2012] to model the motion of the particles under the influence of gravity. `Sorcha` also makes use of a per-module randomization approach, as described in @schwamb2024, allowing for deterministic random number generation during testing regardless of the order in which modules are executed. Additionally, in order to facilitate the use of customisable, community-built classes to describe cometary activity or light-curve modulation effects, `Sorcha` provides abstract base classes from which custom implementations can inherit, allowing a high level of customisation of the code without requiring the user to modify the source code directly.
131+
Built in Python to be flexible, easy-to-use, and applicable to all solar system small body populations, 'Sorcha’ runs on the command-line, ingesting files which describe the input population and the input survey. To predict the position of millions of solar system objects over ten years and over ~billion observations in a reasonable timescale, `Sorcha` makes use of an ephemeris generator (described in [@holman2025]) powered by ASSIST [@holman2023], an open-source Python and C99 software package for producing ephemeris-quality integrations of solar system test particles using the the IAS15 (15th order Gauss-Radau) integrator [@rein2015] within the REBOUND N-body integrator package [@rein2012] to model the motion of the particles under the influence of gravity. `Sorcha` also makes use of a per-module randomization approach, as described in [@schwamb2024], allowing for deterministic random number generation during testing regardless of the order in which modules are executed. Additionally, in order to facilitate the use of customisable, community-built classes to describe cometary activity or light-curve modulation effects, `Sorcha` provides abstract base classes from which custom implementations can inherit, allowing a high level of customisation of the code without requiring the user to modify the source code directly.
132132

133133
`Sorcha` is expected to be a key community tool for solar system science with the LSST. The software package has already enabled predictive work to be made ahead of the start of the LSST, with predictions made of the overall yield of new the asteroid and trans-Neptunian object discoveries [@kurlander2025] and of Centaurs, a class of small, icy bodies that orbit the Sun on giant planet-crossing paths [@murtagh2025]. We expect that future upgrades to `Sorcha` will include adding the capability to simulate past well characterized wide-field discovery surveys in addition to the LSST.
134134

docs/notebooks.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,13 @@ Demo Notebooks
4545
miniDifi Validation <notebooks/demo_miniDifiValidation>
4646
Sorcha End-to-End Verification <notebooks/demo_Verification>
4747

48-
Files to Download To Run the Notebooks Individually
49-
------------------------------------------------------
48+
Supplementary Files Required To Run the Notebooks Individually
49+
--------------------------------------------------------------------
50+
51+
.. tip::
52+
53+
The easiest way to run the notebooks is to clone the repository and install ``Sorcha`` from the source code via pip in editable development mode as described in the :ref:`dev_mode` page. Then move to the docs/notebooks directory and run the notebooks from the there. We also provide the data files used below so you can try individual notebooks out without running them all or cloning the full repository.
54+
5055

5156
* LSST Camera Footprint and Various Other Sorcha Related Fields-of-View
5257

docs/postprocessing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,7 @@ the observation is of a linked object or not. To enable this functionality, add
498498
drop_unlinked = False
499499

500500
.. note::
501-
If **drop_unlinked** is not present in the configuration file, ``Sorcha`` will go to its default setting of dropping all observations of unlinked objects. The Rubin Full Footprint and the Rubin Circular Approximation :ref:`configuration file<configs>` are set up this way,
501+
If **drop_unlinked** is not present in the configuration file, ``Sorcha`` will go to its default setting of dropping all observations of unlinked objects. The Rubin Full Footprint and the Rubin Circular Approximation :ref:`configuration file<configs>` are set up this way.
502502

503503
.. seealso::
504504
See our `Jupyter notebook <notebooks/demo_miniDifiValidation.ipynb>`__ that validates the linking filter.

0 commit comments

Comments
 (0)