Skip to content

redplanet.Mag.sh.get_metadata 

get_metadata() -> dict

Get metadata for the dataset which is currently loaded.

Returns:

Type Description
dict

Contains information about the dataset such as description, units, references, download links, local file path, etc.

Raises:

Type Description
ValueError

If the dataset has not been loaded yet (see the load function for this module).
Source code in src/redplanet/Mag/sh/loader.py 
24
25
26
27
28
29
@substitute_docstrings
def get_metadata() -> dict:
    """
    {fulldoc.get_metadata}
    """
    return dict(get_dataset().metadata)