pyaqsapi.bypqao package

pyaqsapi.bypqao.qa_annualperformanceeval(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return quality assurance performance evaluation data - aggregated by Primary Quality Assurance Organization (PQAO) for a parameter code aggregated by matching input parameter and pqao_code for the time frame between bdate and edate.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

performance evaluation data. for single monitoring site for the

pqao_code requested for the time frame between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame containing annual performance evaluation data for ozone where the PQAO is the Alabama Department of Environmental Management (pqao_code 0013).:

from datetime import date
import pyaqsapi as aqs
...
aqs.bypqao.qa_annualperformanceeval(parameter="44201",
                                    bdate=date(year=2017,
                                               month=1,
                                               day=1),
                                    edate=date(year=2017,
                                               month=12,
                                               day=31),
                                    pqao_code="0013")

pyaqsapi.bypqao.qa_annualperformanceevaltransaction(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return AQS submissions transaction format (RD) of the annual performance evaluation data (raw). Includes data pairs for QA - aggregated by Primary Quality Assurance Organization (PQAO) for a parameter code aggregated by matching input parameter and pqao_code provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

performance evaluation data. for single monitoring site for the

sitenum, countycode and stateFIPS requested for the time frame

between bdate and edate

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame containing annual performance evaluation data for ozone in where the PQAO is the Alabama Department of Environmental Management (pqao_code 0013) for 2017 in RD format.:

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_annualperformanceevaltransaction(parameter="44201",
                                               bdate=date(year=2017,
                                                          month=1,
                                                          day=1),
                                               edate=date(year=2017,
                                                          month=12,
                                                          day=31),
                                               pqao_code="0013")

pyaqsapi.bypqao.qa_blanks(parameter: str, bdate: date, edate: date, pqao_code: date, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of blank quality assurance data. Blanks are unexposed sample collection devices (e.g., filters) that are transported with the exposed sample devices to assess if contamination is occurring during the transport or handling of the samples. Data is aggregated by Primary Quality Assurance Organization (PQAO).

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance blank data

for monitors within a pqao.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (date)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return DataFrame of PM2.5 blank data in January 2018 where the PQAO is the Alabama Department of Environmental Management (agency 0013):

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.aqs_qa_blanks(parameter="88101",
                         bdate=date(year=2018, month=1, day=1),
                         edate=date(year=2018, month=1, day=31),
                         pqao_code="0013")

pyaqsapi.bypqao.qa_collocated_assessments(parameter: str, bdate: date, edate: date, pqao_code: date, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of blank quality assurance data. Blanks are unexposed sample collection devices (e.g., filters) that are transported with the exposed sample devices to assess if contamination is occurring during the transport or handling of the samples. Data is aggregated by Primary Quality Assurance Organization (PQAO).

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance blank data

for monitors within a pqao.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (date)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Returns a DataFrame of collocated assessment data for FRM PM2.5 in January 2013 where the PQAO is the Alabama Department of Environmental Management (agency 0013):

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_collocated_assessments(parameter="88101",
                                     bdate=date(year=2013,
                                                moth=1,
                                                day=1),
                                     edate=date(year=2013,
                                                month=1,
                                                day=31),
                                     pqao_code="0013")

pyaqsapi.bypqao.qa_flowrateaudit(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return Quality assurance flowrate audit data.

Return quality assurance flow rate audit data aggregated by parameter code and Primary Quality Assurance Organization (PQAO) code for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): flow rate audit data for the

requested pqao_code.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame of flow rate audit data for January 2018 where the PQAO is the Jefferson County, AL Department Of Health (agency 0550).:

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_flowrateaudit(parameter="88101",
                            bdate=date(year=2018, month=1, day=1),
                            edate=date(year=2018, month=1, day=31),
                            pqao_code="0550")

pyaqsapi.bypqao.qa_flowrateverification(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table containing flow rate Verification data for a parameter code aggregated by matching input parameter, and Primary Quality Assurance Organization (PQAO) code provided for bdate - edate time.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance flow rate

verification data for monitors within a pqao.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame of collocated assessment data for FRM PM2.5 in January 2013 where the PQAO is the Alabama Department of Environmental Management (agency 0013):

from datetime import date
import pyaqsapi as aqs
...
aqs.bypqao.aqs_qa_flowrateverification(parameter="88101",
                                       bdate=date(year=2018,
                                                  month=1,
                                                  day=1),
                                       edate=date(year=2018,
                                                  month=1,
                                                  day=31),
                                       pqao_code="0013")

pyaqsapi.bypqao.qa_one_point_qc(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return Quality assurance data - collocated assessment raw data aggregated by Primary Quality Assurance Organization (PQAO) code.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): one point qc data within a pqao

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFramee of flow rate audit data for January 2018 where the PQAO is the Jefferson County, AL Department of Health (agency 0550):

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_one_point_qc(parameter="44201",
                           bdate=date(year=2018,
                                      month=1,
                                      day=1),
                           edate=date(year=2018,
                                      month=1,
                                      day=31),
                           pqao_code="0550")

pyaqsapi.bypqao.qa_pep_audit(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of Performance Evaluation Program (PEP) audit data aggregated by Primary Quality Assurance Organization (PQAO) code for the time frame between bdate and edate.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance PEP audit data

for a Primary Quality Assurance Organization.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame of PEP audit data in June 2017 where the pqao is the Alabama Department of Environmental Management (agency 0013):

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_pep_audit(parameter="88101",
                        bdate=date(year=2017, month=6, day=1),
                        edate=date(year=2017, month=6, day=30),
                        pqao_code="0013")

Submodules

pyaqsapi.bypqao.bypqao module

Functions that aggregate data by pqao (By Primary Quality Assurance Organization).

pyaqsapi.bypqao.bypqao.qa_annualperformanceeval(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return quality assurance performance evaluation data - aggregated by Primary Quality Assurance Organization (PQAO) for a parameter code aggregated by matching input parameter and pqao_code for the time frame between bdate and edate.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

performance evaluation data. for single monitoring site for the

pqao_code requested for the time frame between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame containing annual performance evaluation data for ozone where the PQAO is the Alabama Department of Environmental Management (pqao_code 0013).:

from datetime import date
import pyaqsapi as aqs
...
aqs.bypqao.qa_annualperformanceeval(parameter="44201",
                                    bdate=date(year=2017,
                                               month=1,
                                               day=1),
                                    edate=date(year=2017,
                                               month=12,
                                               day=31),
                                    pqao_code="0013")

pyaqsapi.bypqao.bypqao.qa_annualperformanceevaltransaction(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return AQS submissions transaction format (RD) of the annual performance evaluation data (raw). Includes data pairs for QA - aggregated by Primary Quality Assurance Organization (PQAO) for a parameter code aggregated by matching input parameter and pqao_code provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

performance evaluation data. for single monitoring site for the

sitenum, countycode and stateFIPS requested for the time frame

between bdate and edate

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame containing annual performance evaluation data for ozone in where the PQAO is the Alabama Department of Environmental Management (pqao_code 0013) for 2017 in RD format.:

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_annualperformanceevaltransaction(parameter="44201",
                                               bdate=date(year=2017,
                                                          month=1,
                                                          day=1),
                                               edate=date(year=2017,
                                                          month=12,
                                                          day=31),
                                               pqao_code="0013")

pyaqsapi.bypqao.bypqao.qa_blanks(parameter: str, bdate: date, edate: date, pqao_code: date, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of blank quality assurance data. Blanks are unexposed sample collection devices (e.g., filters) that are transported with the exposed sample devices to assess if contamination is occurring during the transport or handling of the samples. Data is aggregated by Primary Quality Assurance Organization (PQAO).

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance blank data

for monitors within a pqao.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (date)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return DataFrame of PM2.5 blank data in January 2018 where the PQAO is the Alabama Department of Environmental Management (agency 0013):

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.aqs_qa_blanks(parameter="88101",
                         bdate=date(year=2018, month=1, day=1),
                         edate=date(year=2018, month=1, day=31),
                         pqao_code="0013")

pyaqsapi.bypqao.bypqao.qa_collocated_assessments(parameter: str, bdate: date, edate: date, pqao_code: date, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of blank quality assurance data. Blanks are unexposed sample collection devices (e.g., filters) that are transported with the exposed sample devices to assess if contamination is occurring during the transport or handling of the samples. Data is aggregated by Primary Quality Assurance Organization (PQAO).

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance blank data

for monitors within a pqao.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (date)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Returns a DataFrame of collocated assessment data for FRM PM2.5 in January 2013 where the PQAO is the Alabama Department of Environmental Management (agency 0013):

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_collocated_assessments(parameter="88101",
                                     bdate=date(year=2013,
                                                moth=1,
                                                day=1),
                                     edate=date(year=2013,
                                                month=1,
                                                day=31),
                                     pqao_code="0013")

pyaqsapi.bypqao.bypqao.qa_flowrateaudit(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return Quality assurance flowrate audit data.

Return quality assurance flow rate audit data aggregated by parameter code and Primary Quality Assurance Organization (PQAO) code for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): flow rate audit data for the

requested pqao_code.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame of flow rate audit data for January 2018 where the PQAO is the Jefferson County, AL Department Of Health (agency 0550).:

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_flowrateaudit(parameter="88101",
                            bdate=date(year=2018, month=1, day=1),
                            edate=date(year=2018, month=1, day=31),
                            pqao_code="0550")

pyaqsapi.bypqao.bypqao.qa_flowrateverification(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table containing flow rate Verification data for a parameter code aggregated by matching input parameter, and Primary Quality Assurance Organization (PQAO) code provided for bdate - edate time.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance flow rate

verification data for monitors within a pqao.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame of collocated assessment data for FRM PM2.5 in January 2013 where the PQAO is the Alabama Department of Environmental Management (agency 0013):

from datetime import date
import pyaqsapi as aqs
...
aqs.bypqao.aqs_qa_flowrateverification(parameter="88101",
                                       bdate=date(year=2018,
                                                  month=1,
                                                  day=1),
                                       edate=date(year=2018,
                                                  month=1,
                                                  day=31),
                                       pqao_code="0013")

pyaqsapi.bypqao.bypqao.qa_one_point_qc(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return Quality assurance data - collocated assessment raw data aggregated by Primary Quality Assurance Organization (PQAO) code.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): one point qc data within a pqao

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFramee of flow rate audit data for January 2018 where the PQAO is the Jefferson County, AL Department of Health (agency 0550):

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_one_point_qc(parameter="44201",
                           bdate=date(year=2018,
                                      month=1,
                                      day=1),
                           edate=date(year=2018,
                                      month=1,
                                      day=31),
                           pqao_code="0550")

pyaqsapi.bypqao.bypqao.qa_pep_audit(parameter: str, bdate: date, edate: date, pqao_code: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of Performance Evaluation Program (PEP) audit data aggregated by Primary Quality Assurance Organization (PQAO) code for the time frame between bdate and edate.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

pqao_codea python character object which represents the 4 digit AQS

Primary Quality Assurance Organization code (with leading zeroes).

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance PEP audit data

for a Primary Quality Assurance Organization.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• pqao_code (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Examples

Return a DataFrame of PEP audit data in June 2017 where the pqao is the Alabama Department of Environmental Management (agency 0013):

import pyaqsapi as aqs
from datetime import date
...
aqs.bypqao.qa_pep_audit(parameter="88101",
                        bdate=date(year=2017, month=6, day=1),
                        edate=date(year=2017, month=6, day=30),
                        pqao_code="0013")