Catalogs#

dace_query.catalog.catalog.Catalog: CatalogClass = <dace_query.catalog.catalog.CatalogClass object>#

This is a singleton instance of the CatalogClass class.

To use it, simply import it :

from dace_query.catalog import Catalog
class dace_query.catalog.catalog.CatalogClass(dace_instance=None)#

Bases: object

The catalog class. Use to retrieve data from the catalog module.

Tip

A catalog instance is already provided, to use it:

from dace_query.catalog import Catalog
query_database(catalog, limit=10000, filters=None, sort=None, output_format=None)#

Query the catalog database to retrieve data in the chosen format.

Filters and sorting order can be applied to the query via named arguments (see Filtering and sorting).

All available formats are defined in this section (see Output formats).

Available catalogs

  • 'k2-epic'

  • 'coralie-714'

  • 'coralie-703'

  • 'gaiataskforce'

  • 'k2-confirmed-planets'

  • 'cascades'

See also

The CHEOPS Catalogs, TOI catalog and TESS Input Catalog are available in their respective modules.

Parameters:

  • catalog (str) – The catalog name to retrieve

  • limit (Optional[int]) – Maximum number of rows to return

  • filters (Optional[dict]) – Filters to apply to the query

  • sort (Optional[dict]) – Sort order to apply to the query

  • output_format (str) – Type of data returns

Returns:

The desired data in the chosen output format

Return type:

dict[str, ndarray] or DataFrame or Table or dict

Getting the K2 EPIC catalog
from dace_query.catalog import Catalog
catalog_to_search = 'k2-epic'
values = Catalog.query_database(catalog=catalog_to_search)