describe_catalogue_dataset
Inspect a published Syndex dataset's release: axes, spectra, emission lines, and citation info, without downloading the file. Verify coverage questions like metallicity ranges or available lines.
Instructions
Describe one published dataset in the Syndex catalogue.
Reports what a Syndex dataset's current release contains — for a
grid, its axes and their extent, which spectra and emission lines it
holds, the model it came from and how to cite it — without
downloading the file. This is how to answer "does the published
BPASS grid cover Z = 1e-5?" or "which lines would I get?" for a grid
that is not installed here. Use inspect_local_grid for one that
is.
Requires network access. Names come from search_catalogue.
Args:
name: Catalogue dataset name, such as
bpass-2-2-1-cloudy-sps-test. Not a filename and not a
path.
Returns:
On failure, a mapping with ok (False) and error,
plus status when the catalogue rejected the name and
hint when it could not be reached.
On success, a mapping with ``ok`` (``True``), ``source``,
``content_is_untrusted`` (always ``True``), the dataset's
``name``, ``display_name``, ``description``, ``data_type``,
``is_test``, ``is_recommended``, ``licence``, and
``current_release``. The release carries ``release_id``,
``published_at``, ``known_bug`` (with
``known_bug_description`` when set), the Synthesizer version
bounds, ``file`` (``filename``, ``format``, ``size_bytes``,
``sha256``), ``download_command``, ``citations``, and, for a
grid, ``grid`` with ``grid_type``, ``emission_type``, the model
and photoionisation code, the wavelength range, ``axes`` as
``{name, units, scale, count, minimum, maximum}``, ``spectra``,
and ``lines`` as ``{count, ids, truncated}``. Axis values
themselves are not returned; ``count``, ``minimum`` and
``maximum`` are what a coverage question needs.
``current_release`` is ``null`` for a dataset with nothing
published yet.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||