MetObs toolkit API Documentation

Here you can find the documentation on the classes, functions, and methods in the MetObs toolkit to be used by a user and developer.

• Dataset
  • Constructor
    • metobs_toolkit.dataset.Dataset
      • Dataset
  • Data attributes
    • metobs_toolkit.dataset.Dataset.stations
      • Dataset.stations
    • metobs_toolkit.dataset.Dataset.obstypes
      • Dataset.obstypes
    • metobs_toolkit.dataset.Dataset.template
      • Dataset.template
    • metobs_toolkit.dataset.Dataset.df
      • Dataset.df
    • metobs_toolkit.dataset.Dataset.metadf
      • Dataset.metadf
    • metobs_toolkit.dataset.Dataset.outliersdf
      • Dataset.outliersdf
    • metobs_toolkit.dataset.Dataset.gapsdf
      • Dataset.gapsdf
    • metobs_toolkit.dataset.Dataset.modeldatadf
      • Dataset.modeldatadf
    • metobs_toolkit.dataset.Dataset.present_observations
      • Dataset.present_observations
    • metobs_toolkit.dataset.Dataset.start_datetime
      • Dataset.start_datetime
    • metobs_toolkit.dataset.Dataset.end_datetime
      • Dataset.end_datetime
  • General methods and attributes
    • metobs_toolkit.dataset.Dataset.get_info
      • Dataset.get_info
    • metobs_toolkit.dataset.Dataset.subset_by_stations
      • Dataset.subset_by_stations
    • metobs_toolkit.dataset.Dataset.get_station
      • Dataset.get_station
    • metobs_toolkit.dataset.Dataset.rename_stations
      • Dataset.rename_stations
    • metobs_toolkit.dataset.Dataset.sync_records
      • Dataset.sync_records
    • metobs_toolkit.dataset.Dataset.resample
      • Dataset.resample
    • metobs_toolkit.dataset.Dataset.add_new_observationtype
      • Dataset.add_new_observationtype
    • metobs_toolkit.dataset.Dataset.create_distancematrix
      • Dataset.create_distancematrix
  • Exporting and converting methods
    • metobs_toolkit.dataset.Dataset.import_data_from_file
      • Dataset.import_data_from_file
    • metobs_toolkit.dataset.Dataset.save_dataset_to_pkl
      • Dataset.save_dataset_to_pkl
    • metobs_toolkit.dataset.Dataset.to_csv
      • Dataset.to_csv
    • metobs_toolkit.dataset.Dataset.to_parquet
      • Dataset.to_parquet
    • metobs_toolkit.dataset.Dataset.to_xr
      • Dataset.to_xr
    • metobs_toolkit.dataset.Dataset.to_netcdf
      • Dataset.to_netcdf
  • GEE related methods
    • metobs_toolkit.dataset.Dataset.modeldatadf
      • Dataset.modeldatadf
    • metobs_toolkit.dataset.Dataset.import_gee_data_from_file
      • Dataset.import_gee_data_from_file
    • metobs_toolkit.dataset.Dataset.get_static_gee_point_data
      • Dataset.get_static_gee_point_data
    • metobs_toolkit.dataset.Dataset.get_static_gee_buffer_fraction_data
      • Dataset.get_static_gee_buffer_fraction_data
    • metobs_toolkit.dataset.Dataset.get_LCZ
      • Dataset.get_LCZ
    • metobs_toolkit.dataset.Dataset.get_altitude
      • Dataset.get_altitude
    • metobs_toolkit.dataset.Dataset.get_landcover_fractions
      • Dataset.get_landcover_fractions
    • metobs_toolkit.dataset.Dataset.get_gee_timeseries_data
      • Dataset.get_gee_timeseries_data
  • Gaps related methods
    • metobs_toolkit.dataset.Dataset.gapsdf
      • Dataset.gapsdf
    • metobs_toolkit.dataset.Dataset.gap_overview_df
      • Dataset.gap_overview_df
    • metobs_toolkit.dataset.Dataset.convert_outliers_to_gaps
      • Dataset.convert_outliers_to_gaps
    • metobs_toolkit.dataset.Dataset.interpolate_gaps
      • Dataset.interpolate_gaps
    • metobs_toolkit.dataset.Dataset.fill_gaps_with_raw_modeldata
      • Dataset.fill_gaps_with_raw_modeldata
    • metobs_toolkit.dataset.Dataset.fill_gaps_with_debiased_modeldata
      • Dataset.fill_gaps_with_debiased_modeldata
    • metobs_toolkit.dataset.Dataset.fill_gaps_with_diurnal_debiased_modeldata
      • Dataset.fill_gaps_with_diurnal_debiased_modeldata
    • metobs_toolkit.dataset.Dataset.fill_gaps_with_weighted_diurnal_debiased_modeldata
      • Dataset.fill_gaps_with_weighted_diurnal_debiased_modeldata
  • Quality control related methods
    • metobs_toolkit.dataset.Dataset.outliersdf
      • Dataset.outliersdf
    • metobs_toolkit.dataset.Dataset.gross_value_check
      • Dataset.gross_value_check
    • metobs_toolkit.dataset.Dataset.persistence_check
      • Dataset.persistence_check
    • metobs_toolkit.dataset.Dataset.repetitions_check
      • Dataset.repetitions_check
    • metobs_toolkit.dataset.Dataset.step_check
      • Dataset.step_check
    • metobs_toolkit.dataset.Dataset.window_variation_check
      • Dataset.window_variation_check
    • metobs_toolkit.dataset.Dataset.buddy_check
      • Dataset.buddy_check
    • metobs_toolkit.dataset.Dataset.buddy_check_with_safetynets
      • Dataset.buddy_check_with_safetynets
    • metobs_toolkit.dataset.Dataset.get_qc_stats
      • Dataset.get_qc_stats
    • metobs_toolkit.dataset.Dataset.convert_outliers_to_gaps
      • Dataset.convert_outliers_to_gaps
  • Visualisations
    • metobs_toolkit.dataset.Dataset.make_plot_of_modeldata
      • Dataset.make_plot_of_modeldata
    • metobs_toolkit.dataset.Dataset.make_plot
      • Dataset.make_plot
    • metobs_toolkit.dataset.Dataset.make_gee_plot
      • Dataset.make_gee_plot
• Dataset related functions
  • metobs_toolkit.dataset.import_dataset_from_pkl
    • import_dataset_from_pkl
  • Special methods
• Station
  • Constructor
    • metobs_toolkit.station.Station
      • Station
  • Data attributes
    • metobs_toolkit.station.Station.name
      • Station.name
    • metobs_toolkit.station.Station.site
      • Station.site
    • metobs_toolkit.station.Station.sensordata
      • Station.sensordata
    • metobs_toolkit.station.Station.df
      • Station.df
    • metobs_toolkit.station.Station.metadf
      • Station.metadf
    • metobs_toolkit.station.Station.outliersdf
      • Station.outliersdf
    • metobs_toolkit.station.Station.gapsdf
      • Station.gapsdf
    • metobs_toolkit.station.Station.modeldatadf
      • Station.modeldatadf
    • metobs_toolkit.station.Station.present_observations
      • Station.present_observations
    • metobs_toolkit.station.Station.start_datetime
      • Station.start_datetime
    • metobs_toolkit.station.Station.end_datetime
      • Station.end_datetime
    • metobs_toolkit.station.Station.modeldata
      • Station.modeldata
  • General methods and attributes
    • metobs_toolkit.station.Station.get_sensor
      • Station.get_sensor
    • metobs_toolkit.station.Station.add_to_sensordata
      • Station.add_to_sensordata
    • metobs_toolkit.station.Station.get_modeltimeseries
      • Station.get_modeltimeseries
    • metobs_toolkit.station.Station.add_to_modeldata
      • Station.add_to_modeldata
    • metobs_toolkit.station.Station.get_info
      • Station.get_info
    • metobs_toolkit.station.Station.resample
      • Station.resample
  • Exporting and converting methods
    • metobs_toolkit.station.Station.to_csv
      • Station.to_csv
    • metobs_toolkit.station.Station.to_parquet
      • Station.to_parquet
    • metobs_toolkit.station.Station.to_xr
      • Station.to_xr
    • metobs_toolkit.station.Station.to_netcdf
      • Station.to_netcdf
  • GEE related methods
    • metobs_toolkit.station.Station.modeldatadf
      • Station.modeldatadf
    • metobs_toolkit.station.Station.get_static_gee_point_data
      • Station.get_static_gee_point_data
    • metobs_toolkit.station.Station.get_static_gee_buffer_fraction_data
      • Station.get_static_gee_buffer_fraction_data
    • metobs_toolkit.station.Station.get_LCZ
      • Station.get_LCZ
    • metobs_toolkit.station.Station.get_altitude
      • Station.get_altitude
    • metobs_toolkit.station.Station.get_landcover_fractions
      • Station.get_landcover_fractions
    • metobs_toolkit.station.Station.get_gee_timeseries_data
      • Station.get_gee_timeseries_data
  • Gaps related methods
    • metobs_toolkit.station.Station.gapsdf
      • Station.gapsdf
    • metobs_toolkit.station.Station.gap_overview_df
      • Station.gap_overview_df
    • metobs_toolkit.station.Station.convert_outliers_to_gaps
      • Station.convert_outliers_to_gaps
    • metobs_toolkit.station.Station.interpolate_gaps
      • Station.interpolate_gaps
    • metobs_toolkit.station.Station.fill_gaps_with_raw_modeldata
      • Station.fill_gaps_with_raw_modeldata
    • metobs_toolkit.station.Station.fill_gaps_with_debiased_modeldata
      • Station.fill_gaps_with_debiased_modeldata
    • metobs_toolkit.station.Station.fill_gaps_with_diurnal_debiased_modeldata
      • Station.fill_gaps_with_diurnal_debiased_modeldata
    • metobs_toolkit.station.Station.fill_gaps_with_weighted_diurnal_debiased_modeldata
      • Station.fill_gaps_with_weighted_diurnal_debiased_modeldata
  • Quality control related methods
    • metobs_toolkit.station.Station.outliersdf
      • Station.outliersdf
    • metobs_toolkit.station.Station.gross_value_check
      • Station.gross_value_check
    • metobs_toolkit.station.Station.persistence_check
      • Station.persistence_check
    • metobs_toolkit.station.Station.repetitions_check
      • Station.repetitions_check
    • metobs_toolkit.station.Station.step_check
      • Station.step_check
    • metobs_toolkit.station.Station.window_variation_check
      • Station.window_variation_check
    • metobs_toolkit.station.Station.get_qc_stats
      • Station.get_qc_stats
    • metobs_toolkit.station.Station.convert_outliers_to_gaps
      • Station.convert_outliers_to_gaps
  • Visualisations
    • metobs_toolkit.station.Station.make_plot_of_modeldata
      • Station.make_plot_of_modeldata
    • metobs_toolkit.station.Station.make_plot
      • Station.make_plot
  • Special methods
• Analysis
  • Constructor
    • metobs_toolkit.analysis.Analysis
      • Analysis
  • Data attributes
    • metobs_toolkit.analysis.Analysis.df
      • Analysis.df
  • Methods
    • metobs_toolkit.analysis.Analysis.get_info
      • Analysis.get_info
    • metobs_toolkit.analysis.Analysis.get_tz
      • Analysis.get_tz
    • metobs_toolkit.analysis.Analysis.apply_filter_on_metadata
      • Analysis.apply_filter_on_metadata
    • metobs_toolkit.analysis.Analysis.apply_filter_on_records
      • Analysis.apply_filter_on_records
    • metobs_toolkit.analysis.Analysis.subset_period
      • Analysis.subset_period
    • metobs_toolkit.analysis.Analysis.aggregate_df
      • Analysis.aggregate_df
    • metobs_toolkit.analysis.Analysis.plot_diurnal_cycle
      • Analysis.plot_diurnal_cycle
    • metobs_toolkit.analysis.Analysis.plot_diurnal_cycle_with_reference_station
      • Analysis.plot_diurnal_cycle_with_reference_station
• Gap
  • Constructor
    • metobs_toolkit.gap.Gap
      • Gap
  • Attributes
    • metobs_toolkit.gap.Gap.records
      • Gap.records
    • metobs_toolkit.gap.Gap.obstype
      • Gap.obstype
    • metobs_toolkit.gap.Gap.stationname
      • Gap.stationname
    • metobs_toolkit.gap.Gap.fillsettings
      • Gap.fillsettings
    • metobs_toolkit.gap.Gap.fillstatus
      • Gap.fillstatus
    • metobs_toolkit.gap.Gap.start_datetime
      • Gap.start_datetime
    • metobs_toolkit.gap.Gap.end_datetime
      • Gap.end_datetime
    • metobs_toolkit.gap.Gap.df
      • Gap.df
  • Methods
    • metobs_toolkit.gap.Gap.get_info
      • Gap.get_info
    • metobs_toolkit.gap.Gap.flag_can_be_filled
      • Gap.flag_can_be_filled
    • metobs_toolkit.gap.Gap.flush_fill
      • Gap.flush_fill
    • metobs_toolkit.gap.Gap.interpolate
      • Gap.interpolate
    • metobs_toolkit.gap.Gap.raw_model_gapfill
      • Gap.raw_model_gapfill
    • metobs_toolkit.gap.Gap.debiased_model_gapfill
      • Gap.debiased_model_gapfill
    • metobs_toolkit.gap.Gap.diurnal_debiased_model_gapfill
      • Gap.diurnal_debiased_model_gapfill
    • metobs_toolkit.gap.Gap.weighted_diurnal_debiased_model_gapfill
      • Gap.weighted_diurnal_debiased_model_gapfill
• SensorData
  • Constructor
    • metobs_toolkit.sensordata.SensorData
      • SensorData
  • Attributes
    • metobs_toolkit.sensordata.SensorData.df
      • SensorData.df
    • metobs_toolkit.sensordata.SensorData.outliersdf
      • SensorData.outliersdf
    • metobs_toolkit.sensordata.SensorData.gapsdf
      • SensorData.gapsdf
    • metobs_toolkit.sensordata.SensorData.stationname
      • SensorData.stationname
    • metobs_toolkit.sensordata.SensorData.tz
      • SensorData.tz
    • metobs_toolkit.sensordata.SensorData.start_datetime
      • SensorData.start_datetime
    • metobs_toolkit.sensordata.SensorData.end_datetime
      • SensorData.end_datetime
    • metobs_toolkit.sensordata.SensorData.freq
      • SensorData.freq
  • Methods
    • metobs_toolkit.sensordata.SensorData.get_info
      • SensorData.get_info
    • metobs_toolkit.sensordata.SensorData.convert_outliers_to_gaps
      • SensorData.convert_outliers_to_gaps
    • metobs_toolkit.sensordata.SensorData.gap_overview_df
      • SensorData.gap_overview_df
    • metobs_toolkit.sensordata.SensorData.resample
      • SensorData.resample
    • metobs_toolkit.sensordata.SensorData.get_qc_freq_statistics
      • SensorData.get_qc_freq_statistics
    • metobs_toolkit.sensordata.SensorData.fill_gap_with_modeldata
      • SensorData.fill_gap_with_modeldata
    • metobs_toolkit.sensordata.SensorData.interpolate_gaps
      • SensorData.interpolate_gaps
    • metobs_toolkit.sensordata.SensorData.convert_to_standard_units
      • SensorData.convert_to_standard_units
    • metobs_toolkit.sensordata.SensorData.pd_plot
      • SensorData.pd_plot
    • metobs_toolkit.sensordata.SensorData.gross_value_check
      • SensorData.gross_value_check
    • metobs_toolkit.sensordata.SensorData.persistence_check
      • SensorData.persistence_check
    • metobs_toolkit.sensordata.SensorData.repetitions_check
      • SensorData.repetitions_check
    • metobs_toolkit.sensordata.SensorData.step_check
      • SensorData.step_check
    • metobs_toolkit.sensordata.SensorData.window_variation_check
      • SensorData.window_variation_check
    • metobs_toolkit.sensordata.SensorData.to_xr
      • SensorData.to_xr
  • Special methods
• Obstypes
  • Constructor
    • metobs_toolkit.obstypes.Obstype
      • Obstype
  • Attributes
    • metobs_toolkit.obstypes.Obstype.name
      • Obstype.name
    • metobs_toolkit.obstypes.Obstype.std_unit
      • Obstype.std_unit
    • metobs_toolkit.obstypes.Obstype.description
      • Obstype.description
    • metobs_toolkit.obstypes.Obstype.original_name
      • Obstype.original_name
    • metobs_toolkit.obstypes.Obstype.original_unit
      • Obstype.original_unit
  • Methods
    • metobs_toolkit.obstypes.Obstype.get_compatible_units
      • Obstype.get_compatible_units
    • metobs_toolkit.obstypes.Obstype.is_compatible_with
      • Obstype.is_compatible_with
    • metobs_toolkit.obstypes.Obstype.get_info
      • Obstype.get_info
    • metobs_toolkit.obstypes.Obstype.convert_to_standard_units
      • Obstype.convert_to_standard_units
  • Special methods
• Site
  • Constructor
    • metobs_toolkit.site.Site
      • Site
  • Data attributes
    • metobs_toolkit.site.Site.stationname
      • Site.stationname
    • metobs_toolkit.site.Site.lat
      • Site.lat
    • metobs_toolkit.site.Site.lon
      • Site.lon
    • metobs_toolkit.site.Site.altitude
      • Site.altitude
    • metobs_toolkit.site.Site.LCZ
      • Site.LCZ
    • metobs_toolkit.site.Site.buffered_fractions
      • Site.buffered_fractions
    • metobs_toolkit.site.Site.extradata
      • Site.extradata
    • metobs_toolkit.site.Site.metadf
      • Site.metadf
  • Setters
    • metobs_toolkit.site.Site.set_latitude
      • Site.set_latitude
    • metobs_toolkit.site.Site.set_longitude
      • Site.set_longitude
    • metobs_toolkit.site.Site.set_altitude
      • Site.set_altitude
    • metobs_toolkit.site.Site.set_LCZ
      • Site.set_LCZ
    • metobs_toolkit.site.Site.set_geedata
      • Site.set_geedata
    • metobs_toolkit.site.Site.set_gee_buffered_frac_data
      • Site.set_gee_buffered_frac_data
    • metobs_toolkit.site.Site.add_metadata
      • Site.add_metadata
  • Status check methods
    • metobs_toolkit.site.Site.flag_has_altitude
      • Site.flag_has_altitude
    • metobs_toolkit.site.Site.flag_has_LCZ
      • Site.flag_has_LCZ
  • General methods
    • metobs_toolkit.site.Site.get_info
      • Site.get_info
  • Special methods
• WhiteSet
  • Constructor
    • metobs_toolkit.qc_collection.whitelist.WhiteSet
      • WhiteSet
  • Methods
    • metobs_toolkit.qc_collection.whitelist.WhiteSet.get_info
      • WhiteSet.get_info
    • metobs_toolkit.qc_collection.whitelist.WhiteSet.create_sensorwhitelist
      • WhiteSet.create_sensorwhitelist
  • Index Structure
  • Timezone Handling
  • Examples
  • Related Classes
    • metobs_toolkit.qc_collection.whitelist.SensorWhiteSet
      • SensorWhiteSet
  • Notes
• Settings
  • Constructor
    • metobs_toolkit.settings_collection.settings.Settings
      • Settings
  • Getting and Setting Values
    • metobs_toolkit.settings_collection.settings.Settings.get
      • Settings.get
    • metobs_toolkit.settings_collection.settings.Settings.set
      • Settings.set
    • metobs_toolkit.settings_collection.settings.Settings.reset
      • Settings.reset
  • Inspection Methods
    • metobs_toolkit.settings_collection.settings.Settings.get_info
      • Settings.get_info
    • metobs_toolkit.settings_collection.settings.Settings.to_dict
      • Settings.to_dict
  • Usage Examples
• ModelTimeSeries
  • Constructor
    • metobs_toolkit.modeltimeseries.ModelTimeSeries
      • ModelTimeSeries
  • Attributes
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.df
      • ModelTimeSeries.df
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.stationname
      • ModelTimeSeries.stationname
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.tz
      • ModelTimeSeries.tz
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.start_datetime
      • ModelTimeSeries.start_datetime
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.end_datetime
      • ModelTimeSeries.end_datetime
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.freq
      • ModelTimeSeries.freq
  • Methods
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.get_info
      • ModelTimeSeries.get_info
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.make_plot
      • ModelTimeSeries.make_plot
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.pd_plot
      • ModelTimeSeries.pd_plot
    • metobs_toolkit.modeltimeseries.ModelTimeSeries.to_xr
      • ModelTimeSeries.to_xr
  • Special methods
• GEEDatasetManagers
  • Constructors
    • metobs_toolkit.geedatasetmanagers.GEEStaticDatasetManager
      • GEEStaticDatasetManager
    • metobs_toolkit.geedatasetmanagers.GEEDynamicDatasetManager
      • GEEDynamicDatasetManager
  • Methods for Static dataset managers
    • metobs_toolkit.geedatasetmanagers.GEEStaticDatasetManager.get_info
      • GEEStaticDatasetManager.get_info
    • metobs_toolkit.geedatasetmanagers.GEEStaticDatasetManager.extract_static_point_data
      • GEEStaticDatasetManager.extract_static_point_data
    • metobs_toolkit.geedatasetmanagers.GEEStaticDatasetManager.extract_static_buffer_frac_data
      • GEEStaticDatasetManager.extract_static_buffer_frac_data
    • metobs_toolkit.geedatasetmanagers.GEEStaticDatasetManager.make_gee_plot
      • GEEStaticDatasetManager.make_gee_plot
  • Methods for Dynamic dataset managers
    • metobs_toolkit.geedatasetmanagers.GEEDynamicDatasetManager.get_info
      • GEEDynamicDatasetManager.get_info
    • metobs_toolkit.geedatasetmanagers.GEEDynamicDatasetManager.add_modelobstype
      • GEEDynamicDatasetManager.add_modelobstype
    • metobs_toolkit.geedatasetmanagers.GEEDynamicDatasetManager.extract_timeseries_data
      • GEEDynamicDatasetManager.extract_timeseries_data
    • metobs_toolkit.geedatasetmanagers.GEEDynamicDatasetManager.make_gee_plot
      • GEEDynamicDatasetManager.make_gee_plot
  • Special methods
• MetObs toolkit defaults
• MetObs toolkit Utility functions
  • Logging functions
    • metobs_toolkit.add_FileHandler
      • add_FileHandler
    • metobs_toolkit.add_StreamHandler
      • add_StreamHandler
  • Authentication functions
    • metobs_toolkit.connect_to_gee
      • connect_to_gee
  • Other utility functions
    • metobs_toolkit.import_dataset_from_pkl
      • import_dataset_from_pkl

Modules for MetObs toolkit Developers

A lot of the functions and methods of the MetObs toolkit are not meant to be called by the users, typically they start with _ (underscore). For developers these functions and methods are important building blocks.

The Module Index contains all functions and methods present in the MetObs toolkit.