Skip to content
44 changes: 29 additions & 15 deletions docs/access/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
#####################
Data Access & Brokers
#####################
###########
Data access
###########

Accessing prompt data products.
Services and tools for accessing the alerts and the Prompt data products.

Community Alert Brokers
=======================
Alert brokers
=============

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

.. toctree::
:maxdepth: 1
Expand All @@ -16,15 +16,29 @@ Services that receive alerts in realtime.
brokers


Alert Archive
=============
Rubin Science Platform (RSP)
============================

.. important::

The alert archive, PPDB, and prompt images are not yet available.


Past alerts and Prompt data products will be accessable via the RSP, as demonstrated in the :doc:`/tutorials/index`.

Alert archive
-------------

An archive of all past alerts will be available via the Rubin Science Platform.
This archive will be queryable by the ``DIA Object`` identifier.

Image Access
============
Prompt Products Database (PPDB)
-------------------------------

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

Solar System Data Products
==========================
Prompt images
-------------

The promptly-processed visit and difference images will be available after an 80 hour embargo period via the RSP.
10 changes: 10 additions & 0 deletions docs/bib/lsstcam.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
@misc{10.71929/rubin/2571927,
author = "{SLAC National Accelerator Laboratory} and {NSF-DOE Vera C. Rubin Observatory}",
doi = "10.71929/rubin/2571927",
url = "https://www.osti.gov//servlets/purl/2571927",
keywords = "79 ASTRONOMY AND ASTROPHYSICS",
language = "en",
title = "{The LSST Camera (LSSTCam)}",
publisher = "SLAC National Accelerator Laboratory (SLAC), Menlo Park, CA (United States)",
year = "2025"
}
12 changes: 12 additions & 0 deletions docs/bib/osprae.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
@TechReport{PSTN-019,
author = "{Rubin Observatory Science Pipelines Developers}",
title = "{The LSST Science Pipelines Software: Optical Survey Pipeline Reduction and Analysis Environment}",
institution = "{NSF-DOE Vera C. Rubin Observatory}",
year = "2025",
month = "July",
handle = "PSTN-019",
type = "{Project Science Technical Note}",
number = "PSTN-019",
doi = "10.71929/rubin/2570545",
url = "https://pstn-019.lsst.io/"
}
9 changes: 9 additions & 0 deletions docs/bib/tutorials.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
@misc{ 10.11578/rubin/dc.20250909.20,
author = "{NSF-DOE Vera C.\ Rubin Observatory}",
doi = "10.11578/rubin/dc.20250909.20",
url = "https://doi.org/10.11578/rubin/dc.20250909.20",
keywords = "79 ASTRONOMY AND ASTROPHYSICS",
title = "{Rubin Observatory LSST Tutorials [Computer Software]},"
publisher = "NSF-DOE Vera C. Rubin Observatory",
year = "2021"
}
54 changes: 43 additions & 11 deletions docs/cite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,60 @@
How to cite
###########

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

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

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

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

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

|lsstcam_doi|
|pp_paper|

and that page includes additional references describing the camera.

When asked to cite the Prompt Products dataset as a whole please use:
When citing the Prompt Products dataset as a whole please use:

|prompt_doi|

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.
Each individual page in :doc:`/products/index` includes the relevant DOI.

`citations.lsst.io <http://citations.lsst.io/>`_ provides a single point of reference for Rubin citations.
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.
These DOI will appear on the individual pages under :doc:`/products/index`.


Science pipelines software
--------------------------

The `Rubin Science Pipelines <https://pipelines.lsst.io/>`_ can be formally cited as:

|osprae_doi| [:download:`BibTeX </bib/osprae.bib>`]


Telescope and instrument
------------------------

For AAS publications please refer to the `facility <https://journals.aas.org/facility-keywords/>`_ as ``Rubin:Simonyi``.

Note that the `Minor Planet Center <https://minorplanetcenter.net/iau/lists/ObsCodesF.html>`_ has allocated the telescope code X05.

The `LSST Camera <https://lsstcam.lsst.io/>`_ should be citing using:

|lsstcam_doi| [:download:`BibTeX </bib/lsstcam.bib>`]


Rubin Science Platform
----------------------

If you accessed data via the RSP, for AAS publications please also add the facility ``Rubin:USDAC``.

Tutorials
---------

When citing the tutorials please use:

|tutorials_doi| [:download:`BibTeX </bib/tutorials.bib>`]


How to refer to single objects
Expand Down
34 changes: 19 additions & 15 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Vera C. Rubin Observatory Prompt Products

This website is currently under development.

Observations and Status
Observations and status
=======================

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

Observations <observations/index>

Data processing
===============

Summary of the data processing steps that generate the data products.
Data products
=============

Descriptions and schemas for the alert packets, catalogs, and images.

.. toctree::
:maxdepth: 1
:maxdepth: 2
:titlesonly:

Data Processing <processing/index>
Data products <products/index>


Data products
=============
Data processing
===============

Descriptions and schemas for the alert packets, catalogs, and images.
Summary of the data processing steps that generate the data products.

.. toctree::
:maxdepth: 2
:maxdepth: 1
:titlesonly:

Data Products <products/index>
Data processing <processing/index>

Data Access and Brokers
=======================


Data access
===========

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

.. toctree::
:maxdepth: 2
:titlesonly:

Data Access <access/index>
Data access <access/index>


Tutorials
Expand All @@ -62,11 +65,12 @@ Tutorials
Tutorials demonstrating how to access and analyze data.

.. toctree::
:maxdepth: 2
:maxdepth: 1
:titlesonly:

Tutorials <tutorials/index>


Citing Prompt Products
======================

Expand Down
13 changes: 7 additions & 6 deletions docs/observations/index.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
#######################
Observations and Status
Observations and status
#######################

.. important::

**Placeholder.** Rubin Observatory is still in an early operations optimization phase.
Rubin Observatory is still in an early operations phase.

The key objective is to improve the image quality and survey efficiency in order to start the ten-year LSST survey.
The amount of science-grade data collected during this phase will vary.

The amount of science-grade data collected during this early phase will vary.
For the general timeline during this phase, read more about the `Early Science Program <https://rubinobservatory.org/for-scientists/resources/early-science>`_.


Survey strategy
===============

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/>`_.


Nightly projection
------------------

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>`_.
A `tutorial <https://github.com/lsst/tutorial-notebooks/blob/main/Commissioning/102_rubin_schedule_viewer.ipynb>`_ is available.
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>`_.
A :ref:`tutorial notebook <tutorials-notebook>` for the Rubin Schedule Viewer is available.


Alert stream status
Expand Down
2 changes: 1 addition & 1 deletion docs/processing/alert-gen/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Alert generation

.. important::

**Placeholder.** Prompt data processing is under construction.
Prompt data processing is under construction.


This includes the creation of packets from the APDB, and alert distribution to brokers.
52 changes: 14 additions & 38 deletions docs/processing/dia/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,46 +6,32 @@ Difference image analysis (DIA)

.. important::

**Placeholder.** Prompt data processing is under construction.
Prompt data processing is under construction.


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>`_.
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>`_.

Key terminology:

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


**Light curves:** the forced photometry fluxes should be used for light curves.

All measurements are stored in the catalog :doc:`/products/index`.


Difference images
=================

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.
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.

In the context of DIA, the visit image is sometimes referred to as the
"direct" or "science" image.
In the context of DIA, the visit image is sometimes referred to as the "direct" or "science" image.


DIA source detection
====================

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.
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.

Difference images contain sources of residual flux from the subtraction, both
positive and negative.
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.
Difference images contain sources of residual flux from the subtraction, both positive and negative.
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.

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

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

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

Pixel flags
-----------

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.

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.


DIA object association
Expand All @@ -89,19 +69,15 @@ The DIA objects are stored in the ``DiaObject`` catalog.
Variability characterization
----------------------------

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


DIA forced photometry
=====================

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.
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.

Forced PSF photometry measurements are made on all visit and difference images
at the locations of all DIA objects.
Forced PSF photometry measurements are made on all visit and difference images at the locations of all DIA objects.
The results are stored in the ``ForcedSourceOnDiaObject`` catalog.

2 changes: 1 addition & 1 deletion docs/processing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Data processing

.. important::

**Placeholder.** Prompt data processing is under construction.
Prompt data processing is under construction.


A high-level overview of the Prompt Processing steps which generated the data products.
Expand Down
Loading