Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions astroquery/alma/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -707,8 +707,8 @@ def query_tap(self, query, *, maxrec=None, uploads=None):
>>> uploads = {'tmptable': '/tmp/tmptable_def.xml'}
>>> rslt = query_tap(self, query, maxrec=None, uploads=uploads)

Return
------
Returns
-------
result : `~pyvo.dal.TAPResults`
TAP query result

Expand Down
35 changes: 2 additions & 33 deletions astroquery/esa/euclid/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,6 @@ def __get_schema_name(self, full_qualified_table_name):
def launch_job(self, query, *, name=None, dump_to_file=False, output_file=None, output_format="csv", verbose=False,
upload_resource=None, upload_table_name=None):
"""
Description
-----------
Launches a synchronous job

Parameters
Expand Down Expand Up @@ -315,8 +313,6 @@ def launch_job(self, query, *, name=None, dump_to_file=False, output_file=None,
def launch_job_async(self, query, *, name=None, dump_to_file=False, output_file=None, output_format="csv",
verbose=False, background=False, upload_resource=None, upload_table_name=None, autorun=True):
"""
Description
-----------
Launches an asynchronous job

Parameters
Expand Down Expand Up @@ -370,8 +366,6 @@ def launch_job_async(self, query, *, name=None, dump_to_file=False, output_file=
def query_object(self, coordinate, *, radius=None, width=None, height=None,
async_job=False, verbose=False, columns=None):
"""
Description
-----------
Searches for objects around a given position with the default catalog sascat_pvpr01.mer_final_cat_pvpr01

Parameters
Expand Down Expand Up @@ -510,8 +504,6 @@ def cone_search(self, coordinate, radius, *,
verbose=False,
columns=None):
"""
Description
-----------
Cone search for a given catalog and sky position, results sorted by distance

Parameters
Expand Down Expand Up @@ -605,8 +597,6 @@ def cone_search(self, coordinate, radius, *,

def login(self, *, user=None, password=None, credentials_file=None, verbose=False):
"""
Description
-----------
Performs a login

User and password can be used or a file that contains username and password
Expand Down Expand Up @@ -649,8 +639,6 @@ def login(self, *, user=None, password=None, credentials_file=None, verbose=Fals

def login_gui(self, verbose=False):
"""
Description
-----------
Performs a login using a GUI dialog

Parameters
Expand Down Expand Up @@ -690,8 +678,6 @@ def login_gui(self, verbose=False):

def logout(self, verbose=False):
"""
Description
-----------
Performs a logout

Parameters
Expand Down Expand Up @@ -743,8 +729,6 @@ def is_gz_file(filepath):

def get_status_messages(self, verbose=False):
"""
Description
-----------
Retrieve the messages to inform users about
the status of Euclid TAP

Expand Down Expand Up @@ -822,8 +806,6 @@ def __extract_file(output_file_full_path, output_dir, files):
def get_observation_products(self, *, id=None, schema="sedm", product_type=None, product_subtype="STK",
filter="VIS", output_file=None, verbose=False):
"""
Description
-----------
Downloads the products for a given EUCLID observation_id (observations) or tile_index (mosaics)
For big files the download may require a long time

Expand Down Expand Up @@ -892,9 +874,7 @@ def get_observation_products(self, *, id=None, schema="sedm", product_type=None,

def __get_tile_catalogue_list(self, *, tile_index, product_type, verbose=False):
"""
Description
-----------
Get the list of products of a given EUCLID tile_index (mosaics)
Get the list of products of a given EUCLID tile_index (mosaics)

Parameters
----------
Expand Down Expand Up @@ -1000,8 +980,6 @@ def __get_tile_catalogue_list(self, *, tile_index, product_type, verbose=False):

def get_product_list(self, *, observation_id=None, tile_index=None, product_type, verbose=False):
"""
Description
-----------
Get the list of products of a given EUCLID id searching by observation_id or tile_index.

Parameters
Expand Down Expand Up @@ -1203,8 +1181,6 @@ def get_product_list(self, *, observation_id=None, tile_index=None, product_type

def get_product(self, *, file_name=None, product_id=None, schema='sedm', output_file=None, verbose=False):
"""
Description
-----------
Downloads a product given its file name or product id

Parameters
Expand Down Expand Up @@ -1262,8 +1238,6 @@ def get_product(self, *, file_name=None, product_id=None, schema='sedm', output_
def get_cutout(self, *, file_path=None, instrument=None, id=None, coordinate, radius, output_file=None,
verbose=False):
"""
Description
-----------
Downloads a cutout given its file path, instrument and obs_id, and the cutout region

Parameters
Expand Down Expand Up @@ -1329,8 +1303,6 @@ def get_cutout(self, *, file_path=None, instrument=None, id=None, coordinate, ra

def get_spectrum(self, *, source_id, schema='sedm', retrieval_type="ALL", output_file=None, verbose=False):
"""
Description
-----------
Downloads a spectrum with datalink.

The spectrum associated with the source_id is downloaded as a compressed fits file, and the files it contains
Expand Down Expand Up @@ -1420,10 +1392,7 @@ def get_spectrum(self, *, source_id, schema='sedm', retrieval_type="ALL", output

def get_datalinks(self, ids, *, linking_parameter='SOURCE_ID', extra_options=None, verbose=False):
"""
Description
-----------
Gets datalinks associated to the provided identifiers.
TAP+ only
Gets datalinks associated to the provided identifiers (TAP+ only).

Parameters
----------
Expand Down
4 changes: 2 additions & 2 deletions astroquery/heasarc/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ def _get_default_columns(self, catalog_name):
catalog_name : str
The name of catalog as a str

Return
------
Returns
-------
a list of column names

"""
Expand Down
12 changes: 6 additions & 6 deletions docs/imcce/imcce.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _astroquery.imcce:

******************************************************************************************************************************************
Institut de Mécanique Céleste et de Calcul des Éphémérides (IMCCE) Solar System Services (`astroquery.imcce`/astroquery.solarsystem.imcce)
******************************************************************************************************************************************
*********************************************************************************************************************************************
Institut de Mécanique Céleste et de Calcul des Éphémérides (IMCCE) Solar System Services (`astroquery.imcce` or astroquery.solarsystem.imcce)
*********************************************************************************************************************************************

Overview
========
Expand Down Expand Up @@ -40,9 +40,9 @@ looks like this:
>>> results = Skybot.cone_search(field, 5*u.arcmin, epoch)
>>> results["Number", "Name", "RA", "DEC", "Type"]
<QTable length=5>
Number Name RA DEC Type
deg deg
int64 str32 float64 float64 str24
Number Name RA DEC Type
deg deg
int64 str32 float64 float64 str24
------ ---------- -------------------- --------------------- ---------
-- 2012 BO42 0.019139999999999997 -0.01297 MB>Middle
516566 2007 DH36 0.005300833333333333 0.02301111111111111 MB>Inner
Expand Down
8 changes: 4 additions & 4 deletions docs/jplhorizons/jplhorizons.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _astroquery.jplhorizons:

***********************************************************************************
JPL Horizons Queries (`astroquery.jplhorizons`/astroquery.solarsystem.jpl.horizons)
***********************************************************************************
**************************************************************************************
JPL Horizons Queries (`astroquery.jplhorizons` or astroquery.solarsystem.jpl.horizons)
**************************************************************************************

.. Warning::

Expand All @@ -27,7 +27,7 @@ the Jet Propulation Laboratory`_.

Because of its relevance to Solar System science, this service can
also be accessed from the topical submodule
`astroquery.solarsystem.jpl`. The functionality of that service is
``astroquery.solarsystem.jpl``. The functionality of that service is
identical to the one presented here.

In order to query information for a specific Solar System body, a
Expand Down
8 changes: 4 additions & 4 deletions docs/jplsbdb/jplsbdb.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _astroquery.jplsbdb:

*************************************************************************
JPL SBDB Queries (`astroquery.jplsbdb`/astroquery.solarsystem.jpl.sbdb)
*************************************************************************
**************************************************************************
JPL SBDB Queries (`astroquery.jplsbdb` or astroquery.solarsystem.jpl.sbdb)
**************************************************************************

Overview
========
Expand All @@ -29,7 +29,7 @@ follows the definitions in that document with some simplifications.

Because of its relevance to Solar System science, this service can
also be accessed from the topical submodule
`astroquery.solarsystem.jpl`. The functionality of that service is
``astroquery.solarsystem.jpl``. The functionality of that service is
identical to the one presented here.

Example
Expand Down
8 changes: 4 additions & 4 deletions docs/mpc/mpc.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _astroquery.mpc:

*************************************************************************
Minor Planet Center Queries (`astroquery.mpc`/astroquery.solarsystem.MPC)
*************************************************************************
****************************************************************************
Minor Planet Center Queries (`astroquery.mpc` or astroquery.solarsystem.MPC)
****************************************************************************

Getting started
===============
Expand Down Expand Up @@ -497,7 +497,7 @@ If you are repeatedly getting failed queries, or bad/out-of-date results, try cl
>>> from astroquery.mpc import MPC
>>> MPC.clear_cache()

If this function is unavailable, upgrade your version of astroquery.
If this function is unavailable, upgrade your version of astroquery.
The ``clear_cache`` function was introduced in version 0.4.7.dev8479.


Expand Down
12 changes: 3 additions & 9 deletions docs/solarsystem/imcce/imcce.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. _astroquery.solarsystem.imcce:

***********************************************
IMCCE Services (`astroquery.solarsystem.imcce`)
***********************************************
**************
IMCCE Services
**************

This submodule is a collection of Solar System-related services
provided by the `Institut de Mécanique Céleste et de Calcul des Éphémérides (IMCCE)
Expand All @@ -18,9 +18,3 @@ For a list of available services, please refer to:
:maxdepth: 1

../../imcce/imcce.rst

Reference/API
=============

.. automodapi:: astroquery.solarsystem.imcce
:no-inheritance-diagram:
15 changes: 4 additions & 11 deletions docs/solarsystem/jpl/jpl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. _astroquery.solarsystem.jpl:

********************************************************
JPL Solar System Services (`astroquery.solarsystem.jpl`)
********************************************************
*************************
JPL Solar System Services
*************************

This submodule is a collection of Solar System-related services
provided by the `Jet Propulsion Laboratory (JPL)
Expand All @@ -18,11 +18,4 @@ their top-level modules.
:maxdepth: 1

../../jplsbdb/jplsbdb.rst
../../jplhorizons/jplhorizons.rst


Reference/API
=============

.. automodapi:: astroquery.solarsystem.jpl
:no-inheritance-diagram:
../../jplhorizons/jplhorizons.rst
13 changes: 3 additions & 10 deletions docs/solarsystem/mpc/mpc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. _astroquery.solarsystem.mpc:

***********************************************************
Minor Planet Center Services (`astroquery.solarsystem.mpc`)
***********************************************************
****************************
Minor Planet Center Services
****************************

This submodule is a collection of Solar System-related services
provided by the `Minor Planet Center
Expand All @@ -17,10 +17,3 @@ directly from their top-level modules.
:maxdepth: 1

../../mpc/mpc.rst


Reference/API
=============

.. automodapi:: astroquery.solarsystem.mpc
:no-inheritance-diagram:
14 changes: 3 additions & 11 deletions docs/solarsystem/solarsystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. _astroquery.solarsystem:

************************************************
Solar System Services (`astroquery.solarsystem`)
************************************************
**************************************************
Solar System Services (``astroquery.solarsystem``)
**************************************************

This submodule is a collection of Solar System-related services,
sorted by the organizations that provide these services. Modules,
Expand All @@ -21,11 +21,3 @@ The currently available service providers and services are:
mpc/mpc.rst
neodys/neodys.rst
pds/pds.rst



Reference/API
=============

.. automodapi:: astroquery.solarsystem
:no-inheritance-diagram:
3 changes: 2 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,9 @@ test=
fsspec[http]
moto[s3]
docs=
sphinx
# https://github.com/astropy/astroquery/issues/3102
sphinx-automodapi<0.18
sphinx-automodapi
matplotlib
sphinx-astropy>=1.5
scipy
Expand Down
2 changes: 0 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,6 @@ commands = flake8 astroquery --count
changedir = {toxinidir}/docs
description = Building the narrative and API docs
extras = docs
requires =
sphinx
commands =
python -m pip freeze
sphinx-build -W . _build/html
Expand Down
Loading