User API#
This section of the documentation gives an overview of the public facing functions used in the Jupyter notebooks available at the OpenGHG hub. For developers documentation of the internal workings of the library are available in the developer API section.
Analyse#
The analyse submodule contains functionality to help you analyse data retrieved from the object store. The ModelScenario class allows users to collate related data sources and calculate modelled output based on this data.
Data objects#
Classes used to return data from the object store, help with manipulation and modification.
Plotting#
These are some helper functions to quickly create plots using ObsData objects.
Classes within the client module are used to interact with OpenGHG, whether it be a cloud or local instance.
Retrieve#
The retrieve submodule contains the functionality needed to retrieve different data types from the OpenGHG store.
Standardise#
The standardise submodule handles the standardisation of different data types to the OpenGHG specification.
Transform#
The transform submodule handles creation of data types to OpenGHG specification based on an underlying input such as a database or model output. This usually involves some transformation of the data to e.g. select a region or regrid the data.
Tutorial#
Functions used in our OpenGHG tutorial notebooks and documentation.
- Tutorial
populate_flux_data()populate_footprint_data()populate_surface_data()populate_bc_ch4()populate_flux_ch4()populate_flux_co2()populate_footprint_co2()populate_footprint_inert()retrieve_example_data()clear_example_cache()clear_tutorial_store()example_extract_path()use_tutorial_store()unpack_example_archive()