Skip to content

Commit 104b1e9

Browse files
MelissaGrahamMelissaGraham
authored
SP-2928: CST contributions to PP docs (#5)
* add tutorials * fix link * fix filename * small edits to tutorials page * minor edit * reset alerts page to standard format * rm dp1 placeholder text * fill in the access page * update citations, add bib * fix bib links * take dl out of epilog * fix bib ref * adopt standard text citation refs
1 parent 6b3645b commit 104b1e9

35 files changed

Lines changed: 24691 additions & 447 deletions

‎docs/access/index.rst‎

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
#####################
2-
Data Access & Brokers
3-
#####################
1+
###########
2+
Data access
3+
###########
44

5-
Accessing prompt data products.
5+
Services and tools for accessing the alerts and the Prompt data products.
66

7-
Community Alert Brokers
8-
=======================
7+
Alert brokers
8+
=============
99

10-
Services that receive alerts in realtime.
10+
Software systems that ingest and process astronomical alerts from the LSST (and other surveys).
1111

1212
.. toctree::
1313
:maxdepth: 1
@@ -16,15 +16,29 @@ Services that receive alerts in realtime.
1616
brokers
1717

1818

19-
Alert Archive
20-
=============
19+
Rubin Science Platform (RSP)
20+
============================
21+
22+
.. important::
23+
24+
The alert archive, PPDB, and prompt images are not yet available.
25+
26+
27+
Past alerts and Prompt data products will be accessable via the RSP, as demonstrated in the :doc:`/tutorials/index`.
28+
29+
Alert archive
30+
-------------
31+
32+
An archive of all past alerts will be available via the Rubin Science Platform.
33+
This archive will be queryable by the ``DIA Object`` identifier.
2134

22-
Image Access
23-
============
35+
Prompt Products Database (PPDB)
36+
-------------------------------
2437

25-
Catalog Access
26-
==============
38+
The PPDB will be updated within 24 hours of alert distribution.
39+
The same data that is streamed in alert packets is available for query and analysis via the RSP.
2740

28-
Solar System Data Products
29-
==========================
41+
Prompt images
42+
-------------
3043

44+
The promptly-processed visit and difference images will be available after an 80 hour embargo period via the RSP.

‎docs/bib/lsstcam.bib‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
@misc{10.71929/rubin/2571927,
2+
author = "{SLAC National Accelerator Laboratory} and {NSF-DOE Vera C. Rubin Observatory}",
3+
doi = "10.71929/rubin/2571927",
4+
url = "https://www.osti.gov//servlets/purl/2571927",
5+
keywords = "79 ASTRONOMY AND ASTROPHYSICS",
6+
language = "en",
7+
title = "{The LSST Camera (LSSTCam)}",
8+
publisher = "SLAC National Accelerator Laboratory (SLAC), Menlo Park, CA (United States)",
9+
year = "2025"
10+
}

‎docs/bib/osprae.bib‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
@TechReport{PSTN-019,
2+
author = "{Rubin Observatory Science Pipelines Developers}",
3+
title = "{The LSST Science Pipelines Software: Optical Survey Pipeline Reduction and Analysis Environment}",
4+
institution = "{NSF-DOE Vera C. Rubin Observatory}",
5+
year = "2025",
6+
month = "July",
7+
handle = "PSTN-019",
8+
type = "{Project Science Technical Note}",
9+
number = "PSTN-019",
10+
doi = "10.71929/rubin/2570545",
11+
url = "https://pstn-019.lsst.io/"
12+
}

‎docs/bib/tutorials.bib‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@misc{ 10.11578/rubin/dc.20250909.20,
2+
author = "{NSF-DOE Vera C.\ Rubin Observatory}",
3+
doi = "10.11578/rubin/dc.20250909.20",
4+
url = "https://doi.org/10.11578/rubin/dc.20250909.20",
5+
keywords = "79 ASTRONOMY AND ASTROPHYSICS",
6+
title = "{Rubin Observatory LSST Tutorials [Computer Software]},"
7+
publisher = "NSF-DOE Vera C. Rubin Observatory",
8+
year = "2021"
9+
}

‎docs/cite.rst‎

Lines changed: 43 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,60 @@
44
How to cite
55
###########
66

7-
`How to cite Rubin Observatory <https://rubinobservatory.org/for-scientists/documentation/cite>`_.
7+
For general information, see `How to cite Rubin Observatory <https://rubinobservatory.org/for-scientists/documentation/cite>`_ and `citations.lsst.io <https://citations.lsst.io/>`_.
88

9-
When citing the Prompt Products please reference this paper: |pp_paper|.
109

11-
For AAS publications please refer to the `facility <https://journals.aas.org/facility-keywords/>`_ as "Rubin:Simonyi".
10+
DOI and publications
11+
====================
1212

13-
The `Minor Planet Center <https://minorplanetcenter.net/iau/lists/ObsCodesF.html>`_ has allocated the telescope code X05.
13+
Data products
14+
-------------
1415

15-
The instrument (LSST Science Camera) can be formally cited as
16+
When citing the Prompt Products please reference this paper:
1617

17-
|lsstcam_doi|
18+
|pp_paper|
1819

19-
and that page includes additional references describing the camera.
2020

21-
When asked to cite the Prompt Products dataset as a whole please use:
21+
When citing the Prompt Products dataset as a whole please use:
2222

2323
|prompt_doi|
2424

25-
If you only use a specific subset, such as only the alerts, or a specific catalog table or image type, you may cite the DOI explicitly assigned to that subset.
26-
Each individual page in :doc:`/products/index` includes the relevant DOI.
2725

28-
`citations.lsst.io <http://citations.lsst.io/>`_ provides a single point of reference for Rubin citations.
26+
If you only use a specific data product (e.g., alerts, or a specific catalog or image type), you may cite the DOI explicitly assigned to that subset.
27+
These DOI will appear on the individual pages under :doc:`/products/index`.
28+
29+
30+
Science pipelines software
31+
--------------------------
32+
33+
The `Rubin Science Pipelines <https://pipelines.lsst.io/>`_ can be formally cited as:
34+
35+
|osprae_doi| [:download:`BibTeX </bib/osprae.bib>`]
36+
37+
38+
Telescope and instrument
39+
------------------------
40+
41+
For AAS publications please refer to the `facility <https://journals.aas.org/facility-keywords/>`_ as ``Rubin:Simonyi``.
42+
43+
Note that the `Minor Planet Center <https://minorplanetcenter.net/iau/lists/ObsCodesF.html>`_ has allocated the telescope code X05.
44+
45+
The `LSST Camera <https://lsstcam.lsst.io/>`_ should be citing using:
46+
47+
|lsstcam_doi| [:download:`BibTeX </bib/lsstcam.bib>`]
48+
49+
50+
Rubin Science Platform
51+
----------------------
52+
53+
If you accessed data via the RSP, for AAS publications please also add the facility ``Rubin:USDAC``.
54+
55+
Tutorials
56+
---------
57+
58+
When citing the tutorials please use:
59+
60+
|tutorials_doi| [:download:`BibTeX </bib/tutorials.bib>`]
2961

3062

3163
How to refer to single objects

‎docs/index.rst‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Vera C. Rubin Observatory Prompt Products
1010

1111
This website is currently under development.
1212

13-
Observations and Status
13+
Observations and status
1414
=======================
1515

1616
Information and live status for the Rubin observations producing alerts.
@@ -21,39 +21,42 @@ Information and live status for the Rubin observations producing alerts.
2121

2222
Observations <observations/index>
2323

24-
Data processing
25-
===============
2624

27-
Summary of the data processing steps that generate the data products.
25+
Data products
26+
=============
27+
28+
Descriptions and schemas for the alert packets, catalogs, and images.
2829

2930
.. toctree::
30-
:maxdepth: 1
31+
:maxdepth: 2
3132
:titlesonly:
3233

33-
Data Processing <processing/index>
34+
Data products <products/index>
3435

3536

36-
Data products
37-
=============
37+
Data processing
38+
===============
3839

39-
Descriptions and schemas for the alert packets, catalogs, and images.
40+
Summary of the data processing steps that generate the data products.
4041

4142
.. toctree::
42-
:maxdepth: 2
43+
:maxdepth: 1
4344
:titlesonly:
4445

45-
Data Products <products/index>
46+
Data processing <processing/index>
4647

47-
Data Access and Brokers
48-
=======================
48+
49+
50+
Data access
51+
===========
4952

5053
How to access Prompt Products through community alert brokers and the Rubin Science Platform.
5154

5255
.. toctree::
5356
:maxdepth: 2
5457
:titlesonly:
5558

56-
Data Access <access/index>
59+
Data access <access/index>
5760

5861

5962
Tutorials
@@ -62,11 +65,12 @@ Tutorials
6265
Tutorials demonstrating how to access and analyze data.
6366

6467
.. toctree::
65-
:maxdepth: 2
68+
:maxdepth: 1
6669
:titlesonly:
6770

6871
Tutorials <tutorials/index>
6972

73+
7074
Citing Prompt Products
7175
======================
7276

‎docs/observations/index.rst‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
#######################
2-
Observations and Status
2+
Observations and status
33
#######################
44

55
.. important::
66

7-
**Placeholder.** Rubin Observatory is still in an early operations optimization phase.
7+
Rubin Observatory is still in an early operations phase.
88

99
The key objective is to improve the image quality and survey efficiency in order to start the ten-year LSST survey.
10-
The amount of science-grade data collected during this phase will vary.
11-
10+
The amount of science-grade data collected during this early phase will vary.
11+
For the general timeline during this phase, read more about the `Early Science Program <https://rubinobservatory.org/for-scientists/resources/early-science>`_.
1212

1313

1414
Survey strategy
1515
===============
1616

1717
Information about the strategy and cadence for the Legacy Survey of Space and Time can be found at `survey-strategy.lsst.io <https://survey-strategy.lsst.io/>`_.
1818

19+
1920
Nightly projection
2021
------------------
2122

22-
The projected Rubin schedule can be obtained via ObsLocTAP `programatically <https://usdf-rsp.slac.stanford.edu/obsloctap/schedule?time=24>`_ or with a `viewer <https://usdf-rsp.slac.stanford.edu/obsloctap/static/viewer.html>`_.
23-
A `tutorial <https://github.com/lsst/tutorial-notebooks/blob/main/Commissioning/102_rubin_schedule_viewer.ipynb>`_ is available.
23+
The projected Rubin schedule can be obtained via ObsLocTAP `programatically <https://usdf-rsp.slac.stanford.edu/obsloctap/schedule?time=24>`_ or with the browser-based `viewer <https://usdf-rsp.slac.stanford.edu/obsloctap/static/viewer.html>`_.
24+
A :ref:`tutorial notebook <tutorials-notebook>` for the Rubin Schedule Viewer is available.
2425

2526

2627
Alert stream status

‎docs/processing/alert-gen/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Alert generation
66

77
.. important::
88

9-
**Placeholder.** Prompt data processing is under construction.
9+
Prompt data processing is under construction.
1010

1111

1212
This includes the creation of packets from the APDB, and alert distribution to brokers.

‎docs/processing/dia/index.rst‎

Lines changed: 14 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,32 @@ Difference image analysis (DIA)
66

77
.. important::
88

9-
**Placeholder.** Prompt data processing is under construction.
9+
Prompt data processing is under construction.
1010

1111

12-
DIA uses the decorrelated `Alard and Lupton (1998) <https://ui.adsabs.harvard.edu/abs/1998ApJ...503..325A/abstract>`_
13-
image differencing algorithm,
14-
as described in "Implementation of Image Difference Decorrelation" (`dmtn-021.lsst.io <https://dmtn-021.lsst.io/>`_)
15-
and in the LSST Science Pipelines documentation for
16-
the `Alard-Lupton implementation <https://pipelines.lsst.io/modules/lsst.ip.diffim/AL_implementation.html>`_.
12+
DIA uses the decorrelated `Alard and Lupton (1998) <https://ui.adsabs.harvard.edu/abs/1998ApJ...503..325A/abstract>`_ image differencing algorithm, as described in "Implementation of Image Difference Decorrelation" (`dmtn-021.lsst.io <https://dmtn-021.lsst.io/>`_) and in the LSST Science Pipelines documentation for the `Alard-Lupton implementation <https://pipelines.lsst.io/modules/lsst.ip.diffim/AL_implementation.html>`_.
1713

1814
Key terminology:
1915

2016
* ``DiaSource``: a detection, positive or negative, in a single difference image
2117
* ``DiaObject``: the astrophysical transient or variable object at a static sky coordinate
2218

2319

24-
**Light curves:** the forced photometry fluxes should be used for light curves.
25-
26-
All measurements are stored in the catalog :doc:`/products/index`.
27-
28-
2920
Difference images
3021
=================
3122

32-
Template coadd images are warped, scaled, and PSF-matched to a visit image,
33-
and then subtracted from the visit image to create a difference image.
23+
Template coadd images are warped, scaled, and PSF-matched to a visit image, and then subtracted from the visit image to create a difference image.
3424

35-
In the context of DIA, the visit image is sometimes referred to as the
36-
"direct" or "science" image.
25+
In the context of DIA, the visit image is sometimes referred to as the "direct" or "science" image.
3726

3827

3928
DIA source detection
4029
====================
4130

42-
DIA source detection refers to the process of finding regions with above-threshold
43-
absolute flux in difference images, where the threshold is a signal-to-noise ratio of 5.
31+
DIA source detection refers to the process of finding regions with above-threshold absolute flux in difference images, where the threshold is a signal-to-noise ratio of 5.
4432

45-
Difference images contain sources of residual flux from the subtraction, both
46-
positive and negative.
47-
Real astrophysical transients, variables, and moving objects appear as sources with
48-
a flux that is equal to the difference between their flux in the template and visit images.
33+
Difference images contain sources of residual flux from the subtraction, both positive and negative.
34+
Real astrophysical transients, variables, and moving objects appear as sources with a flux that is equal to the difference between their flux in the template and visit images.
4935

5036
Spurious sources are also present due to unavoidably imperfect template matching.
5137

@@ -63,19 +49,13 @@ An estimate of how likely a source is to be real is provided to enable filtering
6349
Dipoles
6450
-------
6551

66-
Sources with footprints containing both positive and negative peaks are fit with a
67-
dipole centroid code.
68-
Dipoles represent sources that have moved only slightly (e.g., less than the PSF)
69-
between template and visit image.
52+
Sources with footprints containing both positive and negative peaks are fit with a dipole centroid code.
53+
Dipoles represent sources that have moved only slightly (e.g., less than the PSF) between template and visit image.
7054

7155
Pixel flags
7256
-----------
7357

74-
If the footprint contains one or more flagged pixels,
75-
e.g., for cosmic rays, detector edge, bad pixels,
76-
known artifacts, non-astrophysical trails,
77-
the source is also flagged.
78-
58+
If the footprint contains one or more flagged pixels, e.g., for cosmic rays, detector edge, bad pixels, known artifacts, non-astrophysical trails, the source is also flagged.
7959

8060

8161
DIA object association
@@ -89,19 +69,15 @@ The DIA objects are stored in the ``DiaObject`` catalog.
8969
Variability characterization
9070
----------------------------
9171

92-
Light curve characterization parameters are calculated for all DIA objects,
93-
such as the minimum, mean, maximum, standard deviation, and skew in the
94-
difference image fluxes, the light curve's slope, percentiles, and ``StetsonJ``
95-
parameter.
72+
Light curve characterization parameters (timeseries features) are calculated for all DIA objects.
73+
In the future this set of parameters will extend to include measurements such as standard deviation, skew slope, percentiles, the ``StetsonJ`` parameter and more.
9674

9775

9876
DIA forced photometry
9977
=====================
10078

101-
In general, "forced" photometry means a measurement made at a fixed coordinate in an image,
102-
regardless of whether an above-threshold region was detected in that particular image.
79+
In general, "forced" photometry means a measurement made at a fixed coordinate in an image, regardless of whether an above-threshold region was detected in that particular image.
10380

104-
Forced PSF photometry measurements are made on all visit and difference images
105-
at the locations of all DIA objects.
81+
Forced PSF photometry measurements are made on all visit and difference images at the locations of all DIA objects.
10682
The results are stored in the ``ForcedSourceOnDiaObject`` catalog.
10783

‎docs/processing/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Data processing
44

55
.. important::
66

7-
**Placeholder.** Prompt data processing is under construction.
7+
Prompt data processing is under construction.
88

99

1010
A high-level overview of the Prompt Processing steps which generated the data products.

0 commit comments

Comments
 (0)