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.
client#
Classes within the client module are used to interact with OpenGHG, whether it be a cloud or local instance.
process_files()
Upload data files for standardisation and storage in the object store
search()
Search and retrieve data from the object store
rank_sources()
Rank data sources by date range
get_obs_surface()
Retrieve data from the object store in a format expected by the ACRG
retrieve_ceda()
Retrieve data from the CEDA Archive
retrieve_icos()
Retrieve data from the ICOS Carbon Portal
plotting#
These functions are a work in progress, we hope to soon allow users to easily create timeseries and 2D plots using Plotly.
plot_footprint()
Take a footprint dataset and return a 2D plot
plot_timeseries()
Plot timeseries data by passing in an ObsData or a list of ObsData objects