Skip to content

Commit 6b3645b

Browse files
Merge pull request #4 from lsst/u/ebellm/initial_draft
Restructure prompt products docs
2 parents d4075ce + 19f11cb commit 6b3645b

13 files changed

Lines changed: 120 additions & 200 deletions

File tree

File renamed without changes.

docs/access/index.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#####################
2+
Data Access & Brokers
3+
#####################
4+
5+
Accessing prompt data products.
6+
7+
Community Alert Brokers
8+
=======================
9+
10+
Services that receive alerts in realtime.
11+
12+
.. toctree::
13+
:maxdepth: 1
14+
:glob:
15+
16+
brokers
17+
18+
19+
Alert Archive
20+
=============
21+
22+
Image Access
23+
============
24+
25+
Catalog Access
26+
==============
27+
28+
Solar System Data Products
29+
==========================
30+

docs/cite.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ When asked to cite the Prompt Products dataset as a whole please use:
2525
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.
2626
Each individual page in :doc:`/products/index` includes the relevant DOI.
2727

28+
`citations.lsst.io <http://citations.lsst.io/>`_ provides a single point of reference for Rubin citations.
29+
2830

2931
How to refer to single objects
3032
==============================

docs/index.rst

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,75 +4,76 @@
44
Vera C. Rubin Observatory Prompt Products
55
#########################################
66

7-
**Anticipated start of Alert Production**: July 2025
7+
**Anticipated start of Alert Production**: February 2026
88

99
.. important::
1010

1111
This website is currently under development.
1212

13-
Overview
14-
========
13+
Observations and Status
14+
=======================
1515

16-
General information about the observations and data products.
16+
Information and live status for the Rubin observations producing alerts.
1717

1818
.. toctree::
19-
:maxdepth: 2
19+
:maxdepth: 1
2020
:titlesonly:
2121

22-
Overview <overview/index>
23-
22+
Observations <observations/index>
2423

25-
Brokers
26-
=======
24+
Data processing
25+
===============
2726

28-
Software to process and serve alerts to scientists.
27+
Summary of the data processing steps that generate the data products.
2928

3029
.. toctree::
31-
:maxdepth: 2
30+
:maxdepth: 1
3231
:titlesonly:
3332

34-
Brokers <brokers/index>
33+
Data Processing <processing/index>
34+
3535

3636
Data products
3737
=============
3838

39-
Descriptions and schema for the alert packets, catalogs, and images.
39+
Descriptions and schemas for the alert packets, catalogs, and images.
4040

4141
.. toctree::
4242
:maxdepth: 2
4343
:titlesonly:
4444

45-
Data products <products/index>
45+
Data Products <products/index>
4646

47-
Data processing
48-
===============
47+
Data Access and Brokers
48+
=======================
4949

50-
Summaries of the data processing steps that generate the data products.
50+
How to access Prompt Products through community alert brokers and the Rubin Science Platform.
5151

5252
.. toctree::
5353
:maxdepth: 2
5454
:titlesonly:
5555

56-
Processing <processing/index>
56+
Data Access <access/index>
57+
5758

58-
Data access and analysis
59-
========================
59+
Tutorials
60+
=========
6061

61-
Tutorials demonstrating how to access and analyze data via the Rubin Science Platform (RSP).
62+
Tutorials demonstrating how to access and analyze data.
6263

6364
.. toctree::
6465
:maxdepth: 2
6566
:titlesonly:
6667

6768
Tutorials <tutorials/index>
6869

69-
How to cite
70-
===========
70+
Citing Prompt Products
71+
======================
7172

7273
How to cite Rubin Observatory and the Prompt data products.
7374

7475
.. toctree::
7576
:maxdepth: 1
76-
:glob:
77+
:titlesonly:
7778

78-
cite
79+
Citing Prompt Products <cite>

docs/observations/index.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#######################
2+
Observations and Status
3+
#######################
4+
5+
.. important::
6+
7+
**Placeholder.** Rubin Observatory is still in an early operations optimization phase.
8+
9+
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+
12+
13+
14+
Survey strategy
15+
===============
16+
17+
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/>`_.
18+
19+
Nightly projection
20+
------------------
21+
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.
24+
25+
26+
Alert stream status
27+
===================
28+
29+
A live dashboard showing alert processing over the last twelve hours is available at `ls.st/alert-stream-status <https://ls.st/alert-stream-status>`_.
-870 KB
Binary file not shown.

docs/overview/index.rst

Lines changed: 0 additions & 33 deletions
This file was deleted.

docs/overview/lsstcam.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/overview/observations.rst

Lines changed: 0 additions & 70 deletions
This file was deleted.

docs/processing/templates/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
Template generation
55
###################
66

7-
.. important::
7+
Template coadded images are created by combining multiple calibrated images obtained in the same filter and of the same region of the sky.
8+
This coaddition reduces noise, gaps, and artifacts.
89

9-
**Placeholder.** Prompt data processing is under construction.
10+
Incremental Template Generation
11+
===============================
1012

11-
12-
Template coadded images are created by combining multiple calibrated images obtained in the
13-
same filter and of the same region of the sky to achieve a sharper image
14-
(i.e., by selecting images with good seeing).
13+
Template Availability
14+
=====================
1515

1616

1717
Coadds by patch

0 commit comments

Comments
 (0)