metobs_toolkit.Dataset.get_info#

Dataset.get_info(show_all_settings=False, max_disp_n_gaps=5)[source]#

Alias of show().

A function to print out a detailed overview information about the Dataset.

Parameters:

show_all_settings (bool, optional) – If True all the settings are printed out. The default is False.
max_disp_n_gaps (int, optional) – The maximum number of gaps to display detailed information of.

Return type:

None.

Examples

>>> import metobs_toolkit
>>>
>>> #Create your Dataset
>>> dataset = metobs_toolkit.Dataset() #empty Dataset

>>>
>>> #Add observations to the Dataset
>>> dataset.update_settings(
...                         input_data_file=metobs_toolkit.demo_datafile,
...                         input_metadata_file=metobs_toolkit.demo_metadatafile,
...                         template_file=metobs_toolkit.demo_template,
...                         )
>>> dataset.import_data_from_file()
>>>
>>> # Print out details
>>> dataset.get_info()
--------  General ---------
...