Skip to content

Commit

Permalink
Merge pull request #28 from lsst-sitcom/tickets/SITCOM-1702
Browse files Browse the repository at this point in the history
tickets/SITCOM-1702: Editing and Consistency for CCR1
  • Loading branch information
bechtol authored Oct 25, 2024
2 parents d8acd63 + 57d4575 commit 40ad846
Show file tree
Hide file tree
Showing 9 changed files with 128 additions and 118 deletions.
1 change: 0 additions & 1 deletion acronyms.tex
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@
SE & System Engineering \\\hline
SITCOMTN & System Integration, Test and Commissioning Technical Note \\\hline
SLAC & SLAC National Accelerator Laboratory \\\hline
SQuaSH & Science Quality Analysis Harness \\\hline
SRD & LSST Science Requirements; LPM-17 \\\hline
SSP & Solar System Processing \\\hline
SV & Science Validation \\\hline
Expand Down
34 changes: 17 additions & 17 deletions archiving.tex
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@ \subsection{Operations Readiness Requirement}

The Rubin Project Team shall demonstrate that relevant technical data about the system state and surrounding conditions during which the survey data are being collected are recorded and archived.

\subsection{Objectives:}
\subsection{Objectives}

The objective of this requirement is to ensure that the technical state of the hardware/software systems and the surrounding environment are recorded during the time of survey data collection with sufficient fidelity to be used in support of subsequent processing to produce the LSST science products. This is of particular importance for the determination and correction of systematics in the science data as the survey progresses and statistics improve. Additionally, this includes the technical data record required to ensure efficient operation and maintenance of the observing facility. The primary repository of this technical data is the Engineering Facility Database (EFD) - it has two components:
1) a searchable database that captures the time-dependent "housekeeping" data and
2) the Large File Annex for non-telemetry records (e.g., configuration files, images, other binary files outside the science pixel data etc...).
The objective of this requirement is to ensure that the technical state of the hardware/software systems and the surrounding environment are recorded during the time of survey data collection with sufficient fidelity to be used in support of subsequent processing to produce the LSST science products. This is of particular importance for the determination and correction of systematics in the science data as the survey progresses and statistics improve. Additionally, this includes the technical data record required to ensure efficient operation and maintenance of the observing facility. The primary repository of this technical data is the Engineering Facility Database (EFD) - it has two components:
1) a searchable database that captures the time-dependent ``housekeeping'' data and
2) the Large File Annex for non-telemetry records (e.g., configuration files, images, other binary files outside the science pixel data etc.).

Technical data at the time of each observation ({\it e.g.} visit) includes but is not limited to:

\begin{itemize}
\item Technical "housekeeping" data, which includes telemetry, events and commands from each subsystem component as published to the EFD;
\item Software version including the history of the

\item Software version including the history of the
%new_hd
\begin{enumerate}
\item low-level, hardware-related software,
\item the Engineering User Interfaces, and
\item Comandable SAL Components
\item low-level, hardware-related software,
\item the Engineering User Interfaces, and
\item Comandable SAL Components
\end{enumerate}
Software written by or modified at the Observatory is documented, reviewed and version-controlled on GitHub.
Software written by or modified at the Observatory is documented, reviewed and version-controlled on GitHub.
\item The configurations of all subsystems, including their history
%new_hd
Configurations are handled through the following workflows:
Expand All @@ -34,20 +34,20 @@ \subsection{Objectives:}
\item Meteorological and the environmental state on the Summit
%new_hd
The observatory has a weather station and uses satellite images from Meteoblue to monitor and predict the meteorological conditions at and around the Observatory.

\item Environmental conditions in the dome interior
%new_hd
The Environmental awareness system foresees a large number of sensors to monitor the environmental conditions in the dome.

\item State of atmospheric turbulences -- {\it e.g.} seeing; and
%new_hd
A dedicated DIMM is part of the observatory.

\item State of sky transparency.
%new_hd
A dedicated all-sky camera and the DREAM camera are part of the observatory monitoring cloud coverage.
A dedicated all-sky camera and the DREAM camera are part of the observatory monitoring cloud coverage.
The AuxTel is equipped with a spectrograph to make detailed characterization of the sky at the same time and direction as the Simonyi telescope is observing.

\end{itemize}

\subsection{Criteria for Completeness}
Expand All @@ -66,9 +66,9 @@ \subsection{Pre--Operations Interactions}

\sout{Transfer and archive the EFD from the Base Facility to the US Data Center. The US Data Center is located at SLAC for the purpose of construction completeness evaluation. The US Data Center is required for external queries from users outside the immediate Rubin Observatory Project.}

\subsection{Artifacts for the CCRs}
\subsection{Artifacts for Completion}
\begin{itemize}
\item A report documenting minimum criteria as defined in the criteria section above;
\item \sout{An SDK and example code for custom dashboards and dashboard templates available through a software repository(s) - {\it e.g.} GitHub or similar} This is now done in Chronograf and does not need code to be written; and
\item Example code for Rubin Science Platform queries to the EFD available through a software repository - {\it e.g.} GitHub or similar.
\item Example code for Rubin Science Platform queries to the EFD available through a software repository - {\it e.g.} GitHub or similar.
\end{itemize}
30 changes: 15 additions & 15 deletions community.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ \section{Verification of Education and Public Outreach} \label{sec:community}

\subsection{Operations Readiness requirement}

In order for the Rubin Observatory program to declare that the construction is complete and is ready to enter its Operations Phase, the Project shall demonstrate that EPO program elements have been verified against requirements, the interfaces aimed at the general public are functional and accessible, and content is sufficiently populated to represent Rubin Observatory and its services.
In order for the Rubin Observatory program to declare that the construction is complete and is ready to enter its Operations Phase, the Project shall demonstrate that EPO program elements have been verified against requirements, the interfaces aimed at the general public are functional and accessible, and content is sufficiently populated to represent Rubin Observatory and its services.

\subsection{Objectives}

Expand All @@ -14,57 +14,57 @@ \subsection{Criteria for Completenes}

\subsubsection{Citizen Science}

At completion, researchers who want to lead citizen science projects with Rubin Observatory data can create a sample set using the tools in the Rubin Science Platform (RSP) with whatever data is available at the time.
At completion, researchers who want to lead citizen science projects with Rubin Observatory data can create a sample set using the tools in the Rubin Science Platform (RSP) with whatever data is available at the time.

Rubin Observatory users will be able to create citizen science projects with any LSST data. At completion, we will have demonstrated that:
\begin{itemize}
\item Users can use the tools in the Rubin Science Platform (RSP) with whatever data is available at the time then move data to the Zooniverse Project Builder Tool, with applicable data rights observed.
\item This procedure is successful having tested two citizen science projects following this workflow.
\end{itemize}
\end{itemize}

\subsubsection{Website}

The public-facing website will be ready and live. The EPO team will have demonstrated that at minimum the following functions are operable:

\begin{itemize}
\begin{itemize}
\item The Rubin Observatory EPO website featuring:
\begin{itemize}
\begin{itemize}
\item A News page;
\item the Skyviewer;
\item A multimedia Gallery;
\item Staff profiles,
\item Ready to highlight features from the Alert Stream; and
\item Ready to highlight features from the Alert Stream; and
\item Relevant material from the existing lsst.org pages will have been migrated to the new site.
\end{itemize}
\item The Skyviewer as an interactive page allowing the display of color images over large patches of sky and allows users to pan and zoom, and that the Skyviewer features at least one tour of astronomical objects relevant to Rubin science goals;
\item The Multimedia Gallery featuring free assets that follow AVM metadata standards:
\item The Multimedia Gallery featuring free assets that follow AVM metadata standards:
\begin{itemize}
\item A set of videos for Planetarium use;
\item Image highlights and a virtual tour of Rubin Observatory; and
\item Image highlights and a virtual tour of Rubin Observatory; and
\item A short videos describing Rubin science and facilities.
\end{itemize}
\end{itemize}

\subsubsection{Formal Eduction}

The Formal Education Program offers a suite of online investigations that are web applications where users interact with astronomical data via widgets. The investigations and educator support materials will be accessible through the “Education Hub.” At completion, the EPO team will have demonstrated that:
The Formal Education Program offers a suite of online investigations that are web applications where users interact with astronomical data via widgets. The investigations and educator support materials will be accessible through the “Education Hub.” At completion, the EPO team will have demonstrated that:

\begin{itemize}
\item The investigations and educator support materials are accessible through the Education website;
\item Documentation describing the Professional Development plan for educators is completed.
\item Infrastructure for providing education materials in Spanish language is complete.
\item Infrastructure for providing education materials in Spanish language is complete.
\end{itemize}

\subsubsection{EPO Data Center}

At completion, the EPO team will have demonstrated that the EPO Data Center is cloud-based and is serving data to the EPO website and products.
At completion, the EPO team will have demonstrated that the EPO Data Center is cloud-based and is serving data to the EPO website and products.

\subsection{Pre--Operation Interactions:}
\subsection{Pre--Operation Interactions}

The final delivered infrastructure and documentation will be negotiated between the Rubin Construction Project and NOIRLab.

\subsection{Artifacts for ORR}
\subsection{Artifacts for Completion}

The EPO Team will provide evidence of verifying requirements in the Jira system and provide general documentation about each part of the program described above.

The EPO Team will provide evidence of verifying requirements in the Jira system and provide general documentation about each part of the program described above.


16 changes: 8 additions & 8 deletions documentation.tex
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ \subsection{Operations Readiness Requirement}

The project team shall deliver a complete set of documented operational procedures and supporting technical documents needed to operate the LSST as a scientific facility to conduct a 10-year survey.

\subsection{Objectives:}
\subsection{Objectives}

The objective of this Operational Requirement is to ensure that the procedures necessary for the operations and maintenance of the Rubin Observatory are documented and provided in a form that allows the operations team to conduct the 10-year planned survey. The documentation is to include but is not limited to:

Expand All @@ -17,24 +17,24 @@ \subsection{Criteria for Completeness}
\item Process procedures describing user-level standard operations
%new_hd
The documentation for the Observing specialist as the main users of the observatory is under development in Confluence and can be found \href{https://rubinobs.atlassian.net/wiki/spaces/OST/overview}{here} under \it{Training and Skills}

\item Maintenance needs and procedures for all systems in use
%new_hd
The observatory has implemented a Computerized Maintenance Management System (CMMS).
The observatory has implemented a Computerized Maintenance Management System (CMMS).
It holds a growing number of the latest versions of repeatedly used maintenance procedures.

\item A history of maintenance carried out during construction and commissioning
%new_hd
The CMMS allows for documenting the execution of maintenance activities and provides the history of all maintenance executions.

\item System software documentation - including their operating versions, functionality, and interactions with other systems
%new_hd

\item The observatory feature-based scheduler algorithms and documentation for modification and refinement
%new_hd
The feature-based scheduler is realized as a Comandable SAL Component. Its code and documentation are stored in GitHub.
\item A definition of initial delivered science data products (see previous sections)

\item A definition of initial delivered science data products (see previous sections)
\end{itemize}

{\bf Note:} At the time of this update, the Project has recently set up a "Documentation Working Group". This working group is responsible for defining the architecture of the delivered documentation repositories.
Expand All @@ -43,6 +43,6 @@ \subsection{Pre--Operations Interactions}

The final delivered documentation will be negotiated between the Rubin Construction Project and Rubin Operations.

\subsection{Artifacts for CCR}
\subsection{Artifacts for Completion}

See Criteria above.
58 changes: 29 additions & 29 deletions readiness.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,57 @@ \subsection{Operations Readiness Requirement}
\begin{itemize}

\item The Operations Team shall have a detailed operations plan approved by NSF and DOE.
\item The Operations Team shall have a staffing plan with all roles in the operations plan filled with identified personnel.
\item The Operations Team shall have a staffing plan with all roles in the operations plan filled with identified personnel.
\item The Operations Team shall demonstrate they can operate the delivered Rubin System
to efficiently capture, store, and process science quality images.

\end{itemize}

\subsection{Objectives}

The primary objective of this element of the ORR is that the Operations Team demonstrates that it
is ready to smoothly continue running the full Rubin System as it exists at the end of the
commissioning period. A successful initial phase of operations may include beginning the full
Legacy Survey of Space and Time at the approved nightly schedule and cadence.
It may also include other activities as necessary depending on the final outcome of commissioning.
These could include special observing modes to enable Early Science and further
development of detailed procedures for operations not done in commissioning but which
do not prevent completion criteria from being satisfied.
The primary objective of this element of the ORR is that the Operations Team demonstrates that it
is ready to smoothly continue running the full Rubin System as it exists at the end of the
commissioning period. A successful initial phase of operations may include beginning the full
Legacy Survey of Space and Time at the approved nightly schedule and cadence.
It may also include other activities as necessary depending on the final outcome of commissioning.
These could include special observing modes to enable Early Science and further
development of detailed procedures for operations not done in commissioning but which
do not prevent completion criteria from being satisfied.

\subsection{Criteria for Readiness}

\begin{itemize}

\item Demonstrate planning and staff for safe operations are in place.
\item The team should demonstrate that all needed roles are filled, or will be, with
\item Demonstrate planning and staff for safe operations are in place.
\item The team should demonstrate that all needed roles are filled, or will be, with
trained staff at the time of hand over to full operations.
\item All Human Resources processes for on-boarding operations staff should be complete
or ready by the date of handover as appropriate. Expatriate staff for Chile based deployments
should have all necessary documents and requirements for work in Chile in place. Chilean staff
should have any needed changes to their contracts made before operations begin.
\item An operations budget profile fully covering the needs of the observatory should be
\item All Human Resources processes for on-boarding operations staff should be complete
or ready by the date of handover as appropriate. Expatriate staff for Chile based deployments
should have all necessary documents and requirements for work in Chile in place. Chilean staff
should have any needed changes to their contracts made before operations begin.
\item An operations budget profile fully covering the needs of the observatory should be
agreed to with the agencies in advance of full operations beginning.
\item All supplies and non-labor capital items should be in place.
\item Contracts needed in year 1 for operations services or supplies should be in place.
\item Any in-kind contributions necessary for operations should be demonstrated to be in
place and functioning at the level needed for year 1. Any systems handed over to operations
from construction in advance of this review should be demonstrated to be functioning at the
\item All supplies and non-labor capital items should be in place.
\item Contracts needed in year 1 for operations services or supplies should be in place.
\item Any in-kind contributions necessary for operations should be demonstrated to be in
place and functioning at the level needed for year 1. Any systems handed over to operations
from construction in advance of this review should be demonstrated to be functioning at the
required level of performance.
\item Demonstrate all needed advisory committees/structures are ready and in place.
\item Demonstrate that all construction related documentation is captured
\item Demonstrate that all construction related documentation is captured
in an operations documentation management system.
\item Demonstrate ability to execute Alert Processing in the US DF including connectiing to community brokers.
\item Demonstrate ability to execute Data Release Processing including delivery of data to
non US DF Data Facilities and ingest of data products from same for Data Access at USDF and Chile
DAC.
\item Demonstrate that a significant fraction of the community has been granted
user accounts in the US DF, that the Rubin Science Platform supports their access and
authorization and that they have been given suitable training or information to do science
DAC.
\item Demonstrate that a significant fraction of the community has been granted
user accounts in the US DF, that the Rubin Science Platform supports their access and
authorization and that they have been given suitable training or information to do science
with the Rubin data products as they are delivered.

\end{itemize}

\subsection{Artifacts for ORR}
\subsection{Artifacts for Readiness}

As prelude: the Construction team will be responsible for creating sets/lists of topics/documents that fully describe the characteristics and performance of the Rubin systems, how to maintain them, how to operate them, and anything else critical for the Operations Team (initial survey of documents suggested date November 2020. The Operations Team will review these lists and identify anything that needs to be added (or removed) from those lists. A collaborative negotiation will be carried out with the Construction Team.

Expand All @@ -70,5 +70,5 @@ \subsection{Artifacts for ORR}
\item Maintenance Management plans;
\item Fully populated staffing plan;
\item Budget profile; and

\end{itemize}
Loading

0 comments on commit 40ad846

Please sign in to comment.