.. Review the README on instructions to contribute. .. Review the style guide to keep a consistent approach to the documentation. .. Static objects, such as figures, should be stored in the _static directory. Review the _static/README on instructions to contribute. .. Do not remove the comments that describe each section. They are included to provide guidance to contributors. .. Do not remove other content provided in the templates, such as a section. Instead, comment out the content and include comments to explain the situation. For example: - If a section within the template is not needed, comment out the section title and label reference. Do not delete the expected section title, reference or related comments provided from the template. - If a file cannot include a title (surrounded by ampersands (#)), comment out the title from the template and include a comment explaining why this is implemented (in addition to applying the ``title`` directive). .. This is the label that can be used for cross referencing this file. .. Recommended title label format is "Directory Name"-"Title Name" -- Spaces should be replaced by hyphens. .. _Data-Access-Analysis-Tools-API-Intro: .. Each section should include a label for cross referencing to a given area. .. Recommended format for all labels is "Title Name"-"Section Name" -- Spaces should be replaced by hyphens. .. To reference a label that isn't associated with an reST object such as a title or figure, you must include the link and explicit title using the syntax :ref:`link text `. .. A warning will alert you of identical labels during the linkcheck process. ################################## Introduction to the RSP API Aspect ################################## .. This section should provide a brief, top-level description of the page. On the the main landing page at `data.lsst.cloud `_ there is an "APIs" panel however this is not yet active for DP0. The only Web API provided for DP0.1 is a TAP service for catalog access via the Portal and Notebook Aspects. Image access is not yet supported via TAP. Other IVOA standard APIs that we expect to support in the future include SCS for simple catalog searches, SIAv2 for image searches, SODA for image cutouts and mosaics, and VOSpace (in addition to WebDAV) for access to user files. .. _Data-Access-Analysis-Tools-TAP: The Table Access Protocol (TAP) service ======================================= Use of the TAP service to query catalogs via the Portal is described in :doc:`/data-access-analysis-tools/portal-intro`. In the Notebook Aspect, a TAP service is instantiated in a python notebook and used to execute an ADQL query and return a result set. A set of utilities are provided to get a TAP service instance. .. code-block:: python from rubin_jupyter_utils.lab.notebook import get_tap_service, retrieve_query service = get_tap_service() query = "SELECT TOP 100 * FROM dp01_dc2_catalogs.forced_photometry" results = service.search(query) results.to_table().show_in_notebook() Several of the DP0 :ref:`DP0-1-Tutorials-Notebooks` demonstrate how to use the TAP service programmatically from a python notebook.