Add observing facility for ESO telescopes

[rachel3834]

The European Southern Observatory, ESO, operate some of the largest telescopes in the world at sites in La Silla and Paranal in Chile, close to the Rubin Observatory. These telescopes are ideally placed to follow-up Rubin discoveries, and are therefore highly desirable for TOM users to include in their observing programs.

ESO have developed API endpoints to enable users to both prepare proposals for telescope time (Phase 1) and to submit requests for Observation Blocks (OBs, the ESO term for observation requests) via the Phase 2. This is done using a template system similar to that of Gemini. The Phase 2 API is the most relevant for the TOM Toolkit.

Information on the Phase 1 API Information on the Phase 2 API

The overall goal of this epic is to develop a facility module for ESO telescopes for the TOM Toolkit. After discussions with the ESO development team, it was agreed that an intermediate goal would be to implement a proof-of-concept demostration of submitting an observation programmatically for the XSHOOTER instrument.
The first task will be to review the Phase 2 documentation and examples and prototype a facility module capable of submitting an Observation Block.

ESO Facility Workflow Doc

[rachel3834]

ESO has a demo endpoint available here. This system is entirely independent of their operations and we are invited to use it for testing purposes.
Their documentation includes an example Python query which may be helpful as a reference.

[jchate6]

Develop ESO Facility and extend to XSHOOTER facility.

[jchate6]

SNEx interested in SOXS

[phycodurus]

API methods of interest (incomplete list - see help(p2api.p2api)

Finding Chart

• addFindingChart(self, obId, filename) - Attach a new finding chart in format image/jpeg.
• deleteFindingChart(self, obId, index)
• duplicateFindingChart(self, obId, index, destinationObId)
• generateFindingChart(self, ...)

General container manipulation

• createConcatenation(self, containerId, name)
• deleteContainer(self, containerId, version)
• getContainer(self, containerId)
• getContainerItemsSchedulingInfo(self, containerId)
• getContainerSchedulingInfo(self, containerId)
• saveContainer(self, container, version)
• saveContainerSchedulingInfo(self, containerId, containerInfo, version)
• createFolder(self, containerId, name)
• createGroup(self, containerId, name)
• createItem(self, itemType, containerId, name) - Create a new OB, CB, Folder, Group, Concatenation or TimeLink at the end of the given container.
• createTemplate(self, obId, name)
• deleteTemplate(self, obId, templateId, version)
• duplicateTemplate(self, obId, templateId, destinationObId=0)
• getTemplate(self, obId, templateId) - Get existing template.
• getTemplateSignature(self, instrument, ipVersion, templateName)
• getTemplateSignatures(self, instrument, ipVersion, phase='phase2')
• getTemplates(self, obId)
• saveTemplate(self, obId, template, version)
• setTemplateParams(self, obId, template, params, version)
• createTimeLink(self, containerId, name)
• verifyContainer(self, containerId, submit)

Observing Block/Calibration Block

• createCB(self, containerId, name) - Create a new Calibration Block.
• createOB(self, containerId, name)
• deleteOB(self, obId, version)
• duplicateOB(self, obId, containerId=0)
• getItems(self, containerId) - Get ordered list of OBs and containers inside a container.
• getOB(self, obId) - Get existing OB or CB.
• getOBCompletelyFilledIn(self, obId) - Check that the OB's templates are completely filled in.
• getOBSchedulingInfo(self, obId)
• getOBSummary(self, containerId)
• saveOB(self, ob, version)
• saveOBSchedulingInfo(self, obId, obInfo, version)
• verifyOB(self, obId, submit)

User and submition methods

• getUser(self)
• saveReadme(self, runId, readme, version)
• submitRun(self, runId) - Submit the observing run to ESO for review.
• getRun(self, runId)
• getRuns(self) - Retrieve observing runs owned by or delegated to logged-in user.

Moving resources

• moveCB(self, obId, containerId)
• moveConcatenation(self, concatenationId, containerId)
• moveFolder(self, folderId, containerId)
• moveGroup(self, groupId, containerId)
• moveOB(self, obId, containerId)
• moveTimeLink(self, timeLinkId, containerId)
• reorderItems(self, containerId, items, version)
• reorderTemplates(self, obId, templates, version)

[jchate6]

Brainstorm next steps: Start with Submitting ToO Template