dace_query.opendata package

Submodules

dace_query.opendata.opendata module

dace_query.opendata.opendata.OpenData: OpenDataClass = <dace_query.opendata.opendata.OpenDataClass object>

OpenData instance

class dace_query.opendata.opendata.OpenDataClass(dace_instance: DaceClass | None = None)

Bases: object

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

An opendata instance is already provided, to use it:

>>> from dace_query.opendata import OpenData
download(dace_data_id: str, file_type: str, output_directory: str | None = None, output_filename: str | None = None) → None

Download a publication specified by its dace_data_id, depending on the specified file type it downloads the archive or the readme file.

Available file types are [ ‘readme’, ‘archive’ ].

Parameters:

  • dace_data_id – The publication’s data id

  • file_type (str) – The file to download

  • output_directory (Optional[str]) – The directory where files will be saved

  • output_filename (Optional[str]) – The filename for the download

Returns:

None

>>> from dace_query.opendata import OpenData
>>> # OpenData.download('2019MNRAS.483.5534S', 'archive', output_directory='/tmp', output_filename='opendata.tar.gz')
query_database(limit: int | None = 10000, filters: dict | None = None, sort: dict | None = None, output_format: str | None = None) → dict[str, ndarray] | DataFrame | Table | dict

Query the open 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).

Parameters:

  • 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 (Optional[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

>>> from dace_query.opendata import OpenData
>>> values =  OpenData.query_database()

Module contents