Sites#

Classes

`Site`(SID, config, instruments)	A class representing a site where atmospheric measurements are taken.
`MobileSite`(SID, config, instruments)	A class representing a mobile site where atmospheric measurements are taken.

class uataq.sites.Site(SID, config, instruments)[source]#

A class representing a site where atmospheric measurements are taken.

SID#

The site identifier.

Type:: str

config#

A dictionary containing configuration information for the site.

Type:: dict

instruments#

An instance of the InstrumentEnsemble class representing the instruments at the site.

Type:: InstrumentEnsemble

groups#

The research groups that collect data at the site.

Type:: set of str

loggers#

The loggers used by research groups that record data at a site.

Type:: set of str

pollutants#

The pollutants measured at the site.

Type:: set of str

read_data(instruments='all', lvl=None, time_range=None, num_processes=1, file_pattern=None)[source]#: Read data for each instrument for specified level.

read_obs(pollutants='all', format='wide', time_range=None, num_processes=1)#: Read observations for each pollutant, combining instruments by pollutants.

get_recent_obs(recent=dt.timedelta(days=10), lvl='qaqc')[source]#: Get recent observations from site instruments.

__init__(SID, config, instruments)[source]#

Initializes a Site object with the given site ID.

Parameters:

SID (str) – The site identifier.

config (dict) –

A dictionary containing configuration information for the site:

{
    name: str,
    is_active: bool,
    is_mobile: bool,
    latitude: float,
    longitude: float,
    zagl: float,
    loggers: dict,
    instruments: {
        instrument: {
            loggers: dict
            installation_date: str,
            removal_date: str,
        }
    }
}

instruments (InstrumentEnsemble) – An instance of the InstrumentEnsemble class representing the instruments at the site.

read_data(instruments='all', group=None, lvl=None, time_range=None, num_processes=1, file_pattern=None)[source]#

Read data for the specified instruments and level.

Parameters:

instruments (str or list of str or 'all') – The instrument(s) to read data from. If ‘all’, read data from all instruments. Default is ‘all’.
group (str, optional) – The research group to read data from. Default is None which uses the default group.
lvl (str, optional) – The data level to read. Default is None which reads the highest level available.
time_range (TimeRange | TimeRangeTypes) – The time range to read data. Default is None which reads all available data.
num_processes (int or 'max') – The number of processes to use for reading data. Default is 1.
file_pattern (str, optional) – The file pattern to use for filtering files. Default is None.

Returns:

A dictionary containing the data for each instrument.

Return type:

dict[str, pandas.DataFrame]

Raises:

ReaderError – If no data is found for the specified instruments.

get_obs(pollutants='all', format='wide', group=None, time_range=None, num_processes=1, **kwargs)[source]#

Get observations for each pollutant, combining instruments by pollutants.

Parameters:

pollutants (str or list of str, optional) – pollutants to read. If ‘all’, read all pollutants. Default is ‘all’.
format (str, optional) – Format of the data to return. Default is ‘wide’.
group (str, optional) – Research group to read data from. Default is None which uses the default group.
time_range (TimeRange | TimeRangeTypes) – The time range to read data. Default is None which reads all available data.
num_processes (int, optional) – Number of processes to use for reading data. Default is 1.

Returns:

A dictionary of dataframes, one for each level of data read, or a single dataframe if only one level was read. The keys of the dictionary are the names of the levels (‘calibrated’, ‘qaqc’, ‘raw’), and the values are the corresponding dataframes. If only one level was read, the method returns the corresponding dataframe directly.

Return type:

Union[Dict[str, pandas.DataFrame], pandas.DataFrame]

get_recent_obs(recent=datetime.timedelta(days=10), pollutants='all', format='wide', group=None)[source]#

Get recent observations from site instruments.

Parameters:

recent (str or datetime.timedelta, optional) – Time range to get recent observations. Default is 10 days.
pollutants (str or list of str, optional) – Pollutants to read. If ‘all’, read all pollutants. Default is ‘all’.
format (str, optional) – Format of the data to return. Default is ‘wide’.
group (str, optional) – Research group to read data from. Defaults to None which uses the default group.

Returns:

A dataframe containing recent observations from site instruments.

Return type:

pandas.DataFrame

class uataq.sites.MobileSite(SID, config, instruments)[source]#

A class representing a mobile site where atmospheric measurements are taken.

Parameters:

SID (str) – The site identifier.

config (dict) –

A dictionary containing configuration information for the site:

{
    ...
    is_mobile: True,
    instruments: {
        instrument: {...}
    }
    ...
}

static merge_gps(obs, gps, on=None, obs_on=None, gps_on=None)[source]#

Merge observation data with location data from GPS.

Parameters:

(pd.DataFrame) (gps)
(pd.DataFrame)
(str (gps_on)
optional) (The column name in the GPS data to merge on. If not specified, it will use the value of 'on'.)
(str
optional)
(str
optional)

Returns:

pd.DataFrame

Return type:

The merged data with added location information.

get_obs(pollutants='all', format='wide', group=None, time_range=None, num_processes=1, include_gps=True, **kwargs)[source]#

Get mobile site observations for each pollutant, combining instruments by pollutants, and (optionally) merging location data from GPS.

Parameters:

pollutants (str or list of str, optional) – pollutants to read. If ‘all’, read all pollutants. Default is ‘all’.
format (str, optional) – Format of the data to return. Default is ‘wide’.
group (str, optional) – Research group to read data from. Default is None which uses the default group.
time_range (TimeRange | TimeRangeTypes, optional) – Time range to read data. Default is None.
num_processes (int, optional) – Number of processes to use for reading data. Default is 1.
include_gps (bool, optional) – Whether to include GPS data in the returned dataframe. Default is True.

Returns:

A dataframe containing mobile site observations for each pollutant with location data merged.

Return type:

pandas.DataFrame

static plot(obs, ax=None)[source]#

Sites#

This Page