Skip to content

Commit

Permalink
Removing the availabilities from tests and narrative docs, too
Browse files Browse the repository at this point in the history
  • Loading branch information
bsipocz committed Feb 23, 2023
1 parent bdc0b67 commit 1414ba4
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 41 deletions.
70 changes: 33 additions & 37 deletions docs/dal/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,17 +92,13 @@ set of columns”, 2 means “columns most users can work with” and 3 ”every
including exotic items”. Query functions accept these values in the
``verbosity`` parameter. The exact semantics are service-specific.

Availability and capabilities
-----------------------------
Capabilities
------------

VO services should offer some standard ”support” interfaces specified in
VOSI. In pyVO, the information obtained from these endpoints can be
obtained from some service attributes.

For availability (i.e., is the service up and running?),
this is :py:attr:`~pyvo.dal.mixin.AvailabilityMixin.available`
and :py:attr:`~pyvo.dal.mixin.AvailabilityMixin.up_since`

Capabilities describe specific pieces of functionality (such as “this is a
spectral search”) and further metadata (such as ”this service will never
return more than 10000 rows”).
Expand Down Expand Up @@ -130,18 +126,18 @@ Table Access Protocol

.. pull-quote::

This protocol defines a service protocol for accessing
general table data, including astronomical catalogs as well as general
database tables. Access is provided for both database and table metadata
This protocol defines a service protocol for accessing
general table data, including astronomical catalogs as well as general
database tables. Access is provided for both database and table metadata
as well as for actual table data. This protocol supports the query language
`Astronomical Data Query Language (ADQL) <https://www.ivoa.net/documents/ADQL/>`_
within an integrated interface.
It also includes support for both synchronous and asynchronous queries.
Special support is provided for spatially indexed queries using the
spatial extensions in ADQL. A multi-position query capability permits
queries against an arbitrarily large list of astronomical targets,
providing a simple spatial cross-matching capability.
More sophisticated distributed cross-matching capabilities are possible by
`Astronomical Data Query Language (ADQL) <https://www.ivoa.net/documents/ADQL/>`_
within an integrated interface.
It also includes support for both synchronous and asynchronous queries.
Special support is provided for spatially indexed queries using the
spatial extensions in ADQL. A multi-position query capability permits
queries against an arbitrarily large list of astronomical targets,
providing a simple spatial cross-matching capability.
More sophisticated distributed cross-matching capabilities are possible by
orchestrating a distributed query across multiple TAP services.

-- `Table Access Protocol <https://www.ivoa.net/documents/TAP/>`_
Expand Down Expand Up @@ -264,14 +260,14 @@ Simple Image Access

.. pull-quote::

The Simple Image Access (SIA) protocol
provides capabilities for the discovery, description, access, and retrieval
of multi-dimensional image datasets, including 2-D images as well as datacubes
of three or more dimensions. SIA data discovery is based on the
`ObsCore Data Model <https://www.ivoa.net/documents/ObsCore/>`_,
which primarily describes data products by the physical axes (spatial, spectral,
time, and polarization). Image datasets with dimension greater than 2 are often
referred to as datacubes, cube or image cube datasets and may be considered examples
The Simple Image Access (SIA) protocol
provides capabilities for the discovery, description, access, and retrieval
of multi-dimensional image datasets, including 2-D images as well as datacubes
of three or more dimensions. SIA data discovery is based on the
`ObsCore Data Model <https://www.ivoa.net/documents/ObsCore/>`_,
which primarily describes data products by the physical axes (spatial, spectral,
time, and polarization). Image datasets with dimension greater than 2 are often
referred to as datacubes, cube or image cube datasets and may be considered examples
of hypercube or n-cube data. PyVO supports both versions of SIA.

-- `Simple IMage Access <https://www.ivoa.net/documents/SIA/>`_
Expand Down Expand Up @@ -324,10 +320,10 @@ Simple Spectrum Access
.. pull-quote::

The Simple Spectral Access (SSA) Protocol (SSAP)
defines a uniform interface to remotely discover and access one
defines a uniform interface to remotely discover and access one
dimensional spectra.

-- `Simple Spectral Access Protocol <https://www.ivoa.net/documents/SSA/>`_
-- `Simple Spectral Access Protocol <https://www.ivoa.net/documents/SSA/>`_

Access to (one-dimensional) spectra resembles image access, with some
subtile differences:
Expand Down Expand Up @@ -357,14 +353,14 @@ Simple Cone Search

.. pull-quote::

The Simple Cone Search (SCS)
API specification defines a simple query protocol for retrieving records from
a catalog of astronomical sources. The query describes sky position and
an angular distance, defining a cone on the sky. The response returns
a list of astronomical sources from the catalog whose positions
The Simple Cone Search (SCS)
API specification defines a simple query protocol for retrieving records from
a catalog of astronomical sources. The query describes sky position and
an angular distance, defining a cone on the sky. The response returns
a list of astronomical sources from the catalog whose positions
lie within the cone, formatted as a VOTable.

-- `Simple Cone Search <https://www.ivoa.net/documents/latest/ConeSearch.html>`_
-- `Simple Cone Search <https://www.ivoa.net/documents/latest/ConeSearch.html>`_

The Simple Cone Search returns results – typically catalog entries –
within a circular region on the sky defined by the parameters ``pos``
Expand All @@ -384,12 +380,12 @@ Simple Line Access

.. pull-quote::

The Simple Line Access Protocol (SLAP)
is an IVOA data access protocol which defines a protocol for retrieving
spectral lines coming from various Spectral Line Data Collections through
The Simple Line Access Protocol (SLAP)
is an IVOA data access protocol which defines a protocol for retrieving
spectral lines coming from various Spectral Line Data Collections through
a uniform interface within the VO framework.

-- `Simple Line Access Protocol <https://www.ivoa.net/documents/SLAP/>`_
-- `Simple Line Access Protocol <https://www.ivoa.net/documents/SLAP/>`_

This service let you query for spectral lines in a certain ``wavelength``
range. The unit of the values is meters, but any unit may be specified using
Expand Down
4 changes: 0 additions & 4 deletions pyvo/dal/tests/test_sia2_remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ class TestSIACadc():

def test_service(self):
cadc = SIA2Service(baseurl=CADC_SIA_URL)
assert cadc.availability
assert cadc.availability.available
assert cadc.availability.notes
assert cadc.availability.notes[0] == 'service is accepting queries'
assert cadc.capabilities

@pytest.mark.xfail(reason="https://github.com/astropy/pyvo/issues/361")
Expand Down

0 comments on commit 1414ba4

Please sign in to comment.