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.

Data standardisation

The standardisation submodule handles the standardisation of different data types to the OpenGHG specification.

• Standardisation functions
  • Measurement Standardisation
  • Metadata

Retrieval

The retrieve submodule contains the functionality needed to retrieve different data types from the OpenGHG store.

• Retrieval functions
  • Search functions
    • search_surface()
    • search()
  • Specific retrieval functions
    • get_obs_surface()
    • get_flux()
    • get_footprint()
    • get_bc()

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.

• Plotting functions
  • plot_timeseries()
  • plot_footprint()