Skip to content

Commit c8390ad

Browse files
author
Leanne Guy
committed
Complete descriptions in schema:
1 parent 99b251f commit c8390ad

1 file changed

Lines changed: 51 additions & 47 deletions

File tree

Commissioning/rubin_schedule_viewer.ipynb

Lines changed: 51 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,66 @@
6262
"for planning observations. The Rubin Schedule Viewer provides a **nominal survey schedule** at least **24 hours** in advance, \n",
6363
"followed by **updated schedules** published at least **2 hours** before each observing visit.\n",
6464
"\n",
65-
"The Schedule Viewer is built using the **IVOA ObsLocTAP** standard (Salgado et al.) and incorporates information from \n",
66-
"the observatory’s scheduler, including both **forecasted observations** and the **historical record** of completed visits.\n",
6765
"\n",
6866
"The design of the service is described in <a href=\"https://dmtn-263.lsst.io/\">DMTN-263</a>"
6967
]
7068
},
69+
{
70+
"cell_type": "markdown",
71+
"id": "abd131cb-d4be-40d8-a979-321cd161eb08",
72+
"metadata": {},
73+
"source": [
74+
"### 1.1 ObsLocTAP - Observation Locator Table Access Protocol\n",
75+
"\n",
76+
"The Rubin Schedule Viewer is built using the **IVOA Observation Locator Table Access Protocol (ObsLocTAP henceforth)** standard (<a href=\"https://www.ivoa.net/documents/ObsLocTAP/\">Salgado et al.</a>) and incorporates information from an observatory's scheduler, including both **forecasted observations** and the **historical record** of completed visits.\n",
77+
"\n",
78+
"ObsLocTAP specifies in a standard format, services to retrieve information about planned, scheduled and performed observations of a given target (or coordinates) for a given astronomical observatory based on the existing ObsCore data model.\n",
79+
"This standard does not describe the access to data obtained after the processing of the observational activity, as that is the goal of ObsCore\n",
80+
"(archived observations), although the discovery could be done in a similar way. \n",
81+
"\n",
82+
"ObsLocTAP defines a data model for scheduled observations and a method to run queries over compliant data, using several Virtual Observatory technologies. "
83+
]
84+
},
85+
{
86+
"cell_type": "markdown",
87+
"id": "1989e1d3-fa07-462a-ad37-3c57087b72b9",
88+
"metadata": {},
89+
"source": [
90+
"### 1.2. Key columns\n",
91+
"\n",
92+
"The ObsLocTAP data model (table schema) for the scheduled observations is defined in the `ivoa.obsplan` table -- <a href=\"https://www.ivoa.net/documents/ObsLocTAP/20210609/PR-ObsLocTAP-1.0-20210609.pdf\">Observation Locator \n",
93+
"Table Access Protocol Version 1.0</a>\n",
94+
"\n",
95+
"The database contains 28 columns in total, but these are the key columns used in this tutorial.\n",
96+
"\n",
97+
"* `t_planning` : Time (MJD) when this observation has been added or modified into the planning log.\n",
98+
"* `target_name` : The name of the astronomical object observed, if any.\n",
99+
"* `obs_id` : The observation ID from the Camera.\n",
100+
"* `s_ra` : The Right Ascension of the visit or planned observation (degrees).\n",
101+
"* `s_dec` : The Declination of the visit or planned observation (degrees).\n",
102+
"* `s_fov` : The diameter (bounds) of the covered region\n",
103+
"* `s_region` : Sky region covered by the data product (expressed in ICRS frame)\n",
104+
"* `s_resolution` : The spatial resolution of the data expressed as FWHM\n",
105+
"* `t_min` : The start time (MJD).\n",
106+
"* `t_max` : The stop time (MJD).\n",
107+
"* `t_exptime` : The total exposure time = `t_max - t_min` \n",
108+
"* `t_resolution` : Temporal resolution\n",
109+
"* `facility_name` : Name of the facility used for this observation e.g Rubin Simonyi, AuxTel\n",
110+
"* `instrument_name` : Name of the instrument used for this observation e.g LSSTCam, LSSTComCam\n",
111+
"* `t_plan_exptime` : The planned or scheduled exposure time \n",
112+
"* `priority` : The Priority level { 0, 1, 2}. 0 = in the target queue as the next visit (meaning its execution is highly likely), 1 = in the 1 hour look-ahead summit queue (so likely), 2 = 24 hour pre-night simulation, meaning it is not in the summit queue and has a high degree of uncertainty. \n",
113+
"* `execution_status` : Execution status of the prediction: One of the following values: Planned, Scheduled, Unscheduled, Performed, Aborte\n",
114+
"* `tracking_type` : One of the following values: Sidereal, Solar-system-object-tracking, Fixed-az-el-transit\n",
115+
"\n",
116+
"See <a href=\"https://dmtn-263.lsst.io/\">DMTN-263</a> for a description of all fields in the schema. this table will be completed in time in this tutorial."
117+
]
118+
},
71119
{
72120
"cell_type": "markdown",
73121
"id": "cd1c8f8b-622d-440b-9a72-c088bb4633e2",
74122
"metadata": {},
75123
"source": [
76-
"### 1.1. Import packages\n",
124+
"### 1.3. Import packages\n",
77125
"\n",
78126
"Import standard python science packages and the `lsst.utils.plotting` package."
79127
]
@@ -129,50 +177,6 @@
129177
"print(f\"Rubin Schedule Viewer at {response.url} is alive\")"
130178
]
131179
},
132-
{
133-
"cell_type": "markdown",
134-
"id": "1989e1d3-fa07-462a-ad37-3c57087b72b9",
135-
"metadata": {},
136-
"source": [
137-
"### 2.1. Key columns\n",
138-
"\n",
139-
"IVOA ObsLocTAP defines the data model (table schema) for the scheduled observations in the `ivoa.obsplan` table -- <a href=\"https://www.ivoa.net/documents/ObsLocTAP/20210609/PR-ObsLocTAP-1.0-20210609.pdf\">Observation Locator \n",
140-
"Table Access Protocol Version 1.0</a>\n",
141-
"\n",
142-
"The schema is as follows: \n",
143-
"\n",
144-
"* `t_planning` : Time (MJD) when this observation has been added or modified into the planning log.\n",
145-
"* `target_name` : The name of the astronomical object observed, if any.\n",
146-
"* `obs_id` : The observation ID from the Camera.\n",
147-
"* `obs_collection` : ...\n",
148-
"* `s_ra` : The Right Ascension of the visit or planned observation (degrees).\n",
149-
"* `s_dec` : The Declination of the visit or planned observation (degrees).\n",
150-
"* `s_fov` : ...\n",
151-
"* `s_region` : ...\n",
152-
"* `s_resolution` : ...\n",
153-
"* `t_min` : The start time (MJD).\n",
154-
"* `t_max` : The stop time (MJD).\n",
155-
"* `t_exptime` : The total exposure time = `t_max - t_min` \n",
156-
"* `t_resolution` : 0.2 arcseconds\n",
157-
"* `em_min` : ...\n",
158-
"* `em_max` : ...\n",
159-
"* `em_res_power` : ...\n",
160-
"* `o_ucd` : ...\n",
161-
"* `pol_states` : ...\n",
162-
"* `pol_xel` : ...\n",
163-
"* `facility_name` : The facility name, e.g Rubin Simonyi, AuxTel\n",
164-
"* `instrument_name` : The instrument name, e.g LSSTCam, LSSTComCam\n",
165-
"* `t_plan_exptime` : The planned exposure time \n",
166-
"* `category` : ...\n",
167-
"* `priority` : Scheduling priority or \"look-ahead\" prediction: 0 = in the target queue as the next visit (meaning its execution is highly likely), 1 = in the 1 hour look-ahead summit queue (so likely), 2 = 24 hour pre-night simulation, meaing it is not in the summit queue and has a high degree of uncertainty. \n",
168-
"* `execution_status` : Execution status of the prediction: Scheduled = in the plan, Unscheduled, Performed: executed as stated, Aborted, Not Observed: it was not executed as specified. \n",
169-
"* `tracking_type` : The tracking type, e.g Sidereal\n",
170-
"* `rubin_rot_sky_pos` : ...\n",
171-
"* `rubin_nexp` : ...\n",
172-
"\n",
173-
"See <a href=\"https://dmtn-263.lsst.io/\">DMTN-263</a> for a description of all fields in the schema. this table will be completed in time in this tutorial."
174-
]
175-
},
176180
{
177181
"cell_type": "markdown",
178182
"id": "0382cc7d-1ccc-4c09-8907-19d8384d1c59",

0 commit comments

Comments
 (0)