diff --git a/docs/_/output.txt b/docs/_/output.txt deleted file mode 100644 index e69de29..0000000 diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index d66a8ab..c3a8a06 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree index 17471f9..22128d2 100644 Binary files a/docs/_build/doctrees/index.doctree and b/docs/_build/doctrees/index.doctree differ diff --git a/docs/_build/doctrees/manual/pyaqsapiFunctions-Brief.doctree b/docs/_build/doctrees/manual/pyaqsapiFunctions-Brief.doctree index 3c85ba3..921eb56 100644 Binary files a/docs/_build/doctrees/manual/pyaqsapiFunctions-Brief.doctree and b/docs/_build/doctrees/manual/pyaqsapiFunctions-Brief.doctree differ diff --git a/docs/_build/doctrees/manual/pyaqsapiFunctions-Long.doctree b/docs/_build/doctrees/manual/pyaqsapiFunctions-Long.doctree new file mode 100644 index 0000000..317d3a4 Binary files /dev/null and b/docs/_build/doctrees/manual/pyaqsapiFunctions-Long.doctree differ diff --git a/docs/_build/doctrees/pyaqsapi.bybox.doctree b/docs/_build/doctrees/pyaqsapi.bybox.doctree deleted file mode 100644 index 0410735..0000000 Binary files a/docs/_build/doctrees/pyaqsapi.bybox.doctree and /dev/null differ diff --git a/docs/_build/doctrees/pyaqsapi.bycbsa.doctree b/docs/_build/doctrees/pyaqsapi.bycbsa.doctree deleted file mode 100644 index 6def34e..0000000 Binary files a/docs/_build/doctrees/pyaqsapi.bycbsa.doctree and /dev/null differ diff --git a/docs/_build/doctrees/pyaqsapi.bycounty.doctree b/docs/_build/doctrees/pyaqsapi.bycounty.doctree deleted file mode 100644 index cc1e1cb..0000000 Binary files a/docs/_build/doctrees/pyaqsapi.bycounty.doctree and /dev/null differ diff --git a/docs/_build/doctrees/pyaqsapi.byma.doctree b/docs/_build/doctrees/pyaqsapi.byma.doctree deleted file mode 100644 index bc17081..0000000 Binary files a/docs/_build/doctrees/pyaqsapi.byma.doctree and /dev/null differ diff --git a/docs/_build/doctrees/pyaqsapi.bypqao.doctree b/docs/_build/doctrees/pyaqsapi.bypqao.doctree deleted file mode 100644 index 2e6b3cf..0000000 Binary files a/docs/_build/doctrees/pyaqsapi.bypqao.doctree and /dev/null differ diff --git a/docs/_build/doctrees/pyaqsapi.bysite.doctree b/docs/_build/doctrees/pyaqsapi.bysite.doctree deleted file mode 100644 index c749a44..0000000 Binary files a/docs/_build/doctrees/pyaqsapi.bysite.doctree and /dev/null differ diff --git a/docs/_build/doctrees/pyaqsapi.bystate.doctree b/docs/_build/doctrees/pyaqsapi.bystate.doctree deleted file mode 100644 index 9e76b44..0000000 Binary files a/docs/_build/doctrees/pyaqsapi.bystate.doctree and /dev/null differ diff --git a/docs/_build/doctrees/pyaqsapi.doctree b/docs/_build/doctrees/pyaqsapi.doctree deleted file mode 100644 index 8ae9ea4..0000000 Binary files a/docs/_build/doctrees/pyaqsapi.doctree and /dev/null differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo index 7c58053..4368c13 100644 --- a/docs/_build/html/.buildinfo +++ b/docs/_build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 3cebc56d58d6ed3f3392a68420c06fa8 +config: 76a68937cbe1e6a63755071eed15d2c3 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt index 08a44d9..8745d98 100644 --- a/docs/_build/html/_sources/index.rst.txt +++ b/docs/_build/html/_sources/index.rst.txt @@ -3,12 +3,16 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +.. sectionauthor:: Clinton Mccrowey epa.gov> + +=========================== +pyaqsapi user documentation +=========================== -pyaqsapi's documentation -========================= .. toctree:: :maxdepth: 2 :numbered: + :hidden: .. include:: manual/EPA_Disclaimer.rst .. include:: manual/Introduction.rst @@ -19,12 +23,17 @@ pyaqsapi's documentation .. include:: manual/Using_pyaqsapi.rst .. This is temporary until the long version is finished -.. include:: manual/pyaqsapiFunctions-Brief.rst +.. +.. include:: manual/pyaqsapiFunctions-Long.rst + pyaqsapi API reference documentation -==================================== +------------------------------------ + * :ref:`modindex` -Index -===== + +pyaqsapi index +-------------- + * :ref:`genindex` diff --git a/docs/_build/html/_sources/manual/pyaqsapiFunctions-Brief.rst.txt b/docs/_build/html/_sources/manual/pyaqsapiFunctions-Brief.rst.txt index dd38309..0a972a6 100644 --- a/docs/_build/html/_sources/manual/pyaqsapiFunctions-Brief.rst.txt +++ b/docs/_build/html/_sources/manual/pyaqsapiFunctions-Brief.rst.txt @@ -1,4 +1,4 @@ -.. index:: pyaqsapi aggregate functions (brief) +:orphan: Data Mart aggregate functions ============================= @@ -34,25 +34,24 @@ Note that not all aggregations are available for each service. These thirteen services are: - - \ Monitors (\*monitors) - - \ Sample Data (\*sampledata) - - \ Daily Summary Data (\*dailydata) - - \ Annual Summary Data (annualdata) - - \ Quality Assurance - Blanks Data (\*qa_blanks) - - \ Quality Assurance - Collocated Assessments - (\*qa_collocated_assessments) - - \ Quality Assurance - Flow Rate Verifications (\*qa_flowrateverification) - - \ Quality Assurance - Flow Rate Audits (\*aqs_qa_flowrateaudit) - - \ Quality Assurance - One Point Quality Control Raw Data - (\*qa_one_point_qc) - - \ Quality Assurance - PEP Audits (\*qa_pep_audit) - - \ Transaction Sample - AQS Submission data in transaction Format (RD) - (\*transactionsample) - - \ Quality Assurance - Annual Performance Evaluations - (\*qa_annualpeferomanceeval) - - \ Quality Assurance - Annual Performance Evaluations in the AQS - \ Submission transaction format (RD) - \ (\*qa_annualpeferomanceevaltransaction) + * Monitors (monitors) + * Sample Data (sampledata) + * Daily Summary Data (dailydata) + * Annual Summary Data (annualdata) + * Quality Assurance - Blanks Data (qa_blanks) + * Quality Assurance - Collocated Assessments + (qa_collocated_assessments) + * Quality Assurance - Flow Rate Verifications (qa_flowrateverification) + * Quality Assurance - Flow Rate Audits (aqs_qa_flowrateaudit) + * Quality Assurance - One Point Quality Control Raw Data + (qa_one_point_qc) + * Quality Assurance - PEP Audits (qa_pep_audit) + * Transaction Sample - AQS Submission data in transaction Format (RD) + (transactionsample) + * Quality Assurance - Annual Performance Evaluations + (qa_annualperformanceeval) + * Quality Assurance - Annual Performance Evaluations in the AQS + Submission transaction format (RD) (qa_annualperformanceevaltransaction) Aggregate functions are named aqs..() where diff --git a/docs/_build/html/_sources/manual/pyaqsapiFunctions-Long.rst.txt b/docs/_build/html/_sources/manual/pyaqsapiFunctions-Long.rst.txt new file mode 100644 index 0000000..7da7e15 --- /dev/null +++ b/docs/_build/html/_sources/manual/pyaqsapiFunctions-Long.rst.txt @@ -0,0 +1,841 @@ +.. index:: Functions Exported by pyaqsapi + +Functions Exported by pyaqsapi +==================================================== +The pyaqsapi package includes the following submodules which are not +loaded by default: +:: + +* pyaqsapi.bysite +* pyaqsapi.bycounty +* pyaqsapi.bycounty +* pyaqsapi.bycbsa +* pyaqsapi.bybox +* pyaqsapi.byma +* pyaqsapi.ma + +With these submodules loaded to entire list of functions exported by the +pyaqsapi package includes: + +:: + +* pyaqsapi.aqs_cbsas, +* pyaqsapi.aqs_classes, +* pyaqsapi.aqs_counties_by_state, +* pyaqsapi.aqs_credentials, +* pyaqsapi.aqs_credentials, +* pyaqsapi.aqs_fields_by_service, +* pyaqsapi.aqs_fields_by_service, +* pyaqsapi.aqs_isavailable, +* pyaqsapi.aqs_isavailable, +* pyaqsapi.aqs_knownissues, +* pyaqsapi.aqs_knownissues, +* pyaqsapi.aqs_mas, +* pyaqsapi.aqs_parameters_by_class, +* pyaqsapi.aqs_pqaos, +* pyaqsapi.aqs_removeheader, +* pyaqsapi.aqs_revisionhistory, +* pyaqsapi.aqs_revisionhistory, +* pyaqsapi.aqs_sampledurations, +* pyaqsapi.aqs_sign_up, +* pyaqsapi.aqs_sign_up, +* pyaqsapi.aqs_sites_by_county, +* pyaqsapi.aqs_states, +* pyaqsapi.bybox.annualsummary, +* pyaqsapi.bybox.dailysummary, +* pyaqsapi.bybox.helperfunctions, +* pyaqsapi.bybox.monitors, +* pyaqsapi.bybox.quarterlysummary, +* pyaqsapi.bybox.sampledata, +* pyaqsapi.bycbsa.annualsummary, +* pyaqsapi.bycbsa.dailysummary, +* pyaqsapi.bycbsa.helperfunctions, +* pyaqsapi.bycbsa.monitors, +* pyaqsapi.bycbsa.quarterlysummary, +* pyaqsapi.bycbsa.sampledata, +* pyaqsapi.bycounty.annualsummary, +* pyaqsapi.bycounty.dailysummary, +* pyaqsapi.bycounty.helperfunctions, +* pyaqsapi.bycounty.monitors, +* pyaqsapi.bycounty.qa_annualperformanceeval, +* pyaqsapi.bycounty.qa_annualperformanceevaltransaction, +* pyaqsapi.bycounty.qa_blanks, +* pyaqsapi.bycounty.qa_collocated_assessments, +* pyaqsapi.bycounty.qa_flowrateaudit, +* pyaqsapi.bycounty.qa_flowrateverification, +* pyaqsapi.bycounty.qa_one_point_qc, +* pyaqsapi.bycounty.qa_pep_audit, +* pyaqsapi.bycounty.quarterlysummary, +* pyaqsapi.bycounty.sampledata, +* pyaqsapi.bycounty.transactionsample, +* pyaqsapi.byma.qa_annualpeferomanceeval, +* pyaqsapi.byma.qa_annualperformanceevaltransaction, +* pyaqsapi.byma.qa_blanks, +* pyaqsapi.byma.qa_collocated_assessments, +* pyaqsapi.byma.qa_flowrateaudit, +* pyaqsapi.byma.qa_flowrateverification, +* pyaqsapi.byma.qa_one_point_qc, +* pyaqsapi.byma.qa_pep_audit, +* pyaqsapi.byma.transactionsample, +* pyaqsapi.bypqao.qa_annualperformanceeval, +* pyaqsapi.bypqao.qa_annualperformanceevaltransaction, +* pyaqsapi.bypqao.qa_blanks, +* pyaqsapi.bypqao.qa_collocated_assessments, +* pyaqsapi.bypqao.qa_flowrateaudit, +* pyaqsapi.bypqao.qa_flowrateverification, +* pyaqsapi.bypqao.qa_one_point_qc, +* pyaqsapi.bypqao.qa_pep_audit, +* pyaqsapi.bysite.annualsummary, +* pyaqsapi.bysite.dailysummary, +* pyaqsapi.bysite.helperfunctions, +* pyaqsapi.bysite.monitors, +* pyaqsapi.bysite.qa_annualpeferomanceeval, +* pyaqsapi.bysite.qa_annualperformanceevaltransaction, +* pyaqsapi.bysite.qa_blanks, +* pyaqsapi.bysite.qa_collocated_assessments, +* pyaqsapi.bysite.qa_flowrateaudit, +* pyaqsapi.bysite.qa_flowrateverification, +* pyaqsapi.bysite.qa_one_point_qc, +* pyaqsapi.bysite.qa_pep_audit, +* pyaqsapi.bysite.quarterlysummary, +* pyaqsapi.bysite.sampledata, +* pyaqsapi.bysite.transactionsample, +* pyaqsapi.bystate.annualsummary, +* pyaqsapi.bystate.dailysummary, +* pyaqsapi.bystate.helperfunctions, +* pyaqsapi.bystate.monitors, +* pyaqsapi.bystate.qa_annualperformanceeval, +* pyaqsapi.bystate.qa_annualperformanceevaltransaction, +* pyaqsapi.bystate.qa_blanks, +* pyaqsapi.bystate.qa_collocated_assessments, +* pyaqsapi.bystate.qa_flowrateaudit, +* pyaqsapi.bystate.qa_flowrateverification, +* pyaqsapi.bystate.qa_one_point_qc, +* pyaqsapi.bystate.qa_pep_audit, +* pyaqsapi.bystate.quarterlysummary, +* pyaqsapi.bystate.sampledata, +* pyaqsapi.bystate.transactionsample + + +pyaqsapi functions are named according to the service and filter variables that +are available by the AQS Data Mart API. Refer to `Air Quality System (AQS) API +`_ for full details of the +AQS DataMart API. + + +Variable descriptions and usage +=============================== +These are all the available variables that can be used with various functions +exported from the pyaqsapi library listed alphabetically. Not all of these +variables are used with every function, and not all of these parameters are +required. See the :ref: `pyaqsapi functional families` section to +see which parameters are used with each function. + +* AQSobject: + an object of type AQSAPI_V2 that is returned from pyaqsapi + aggregate functions wheen return_header is True. + +* bdate: + a date object which represents the begin date of the data selection. + Only data on or after this date will be returned. + +* cbdate (optional): + a date object which represents the "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. + +* cedate (optional): + a date object which represents the "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. + +* countycode: + a character object which represents the 3 digit state FIPS code for the + county being requested (with leading zero(s)). Refer to + :ref: `listfunctions` for a table of available county codes for each state. + +* duration (optional): + a character string that represents the parameter duration code that limits + returned data to a specific sample duration. The default value of None + will result in no filtering based on duration code. Valid durations + include actual sample durations and not calculated durations such as 8 hour + CO or O\ :sub:`3`\ rolling averages, 3/6 day PM averages or Pb 3 month + rolling averages. Refer to :ref: `aqs_sampledurations()` for a table of all + available duration codes. + +* edate: + a date object which represents the end date of the data selection. Only + data on or before this date will be returned. + +* email: + a character object which represents the email account that will be used to + register with the AQS API or change an existing user's key. A verification + email will be sent to the account specified. + +* key: + a character object which represents the key used in conjunction with the + username given to connect to AQS Data Mart. + +* MA_code: + a character object which represents the 4 digit AQS Monitoring Agency code + (with leading zeroes). + +* maxlat: + a character object which represents the maximum latitude of a geographic + box. Decimal latitude with north begin positive. Only data south of this + latitude will be returned. + +* maxlon: + a character object which represents the maximum longitude of a + geographic box. Decimal longitude with east being positive. Only + data west of this longitude will be returned. Note that -80 is less + than -70. + +* minlat: + a character object which represents the minimum latitude of a + geographic box. Decimal latitude with north being positive. + Only data north of this latitude will be returned. + +* minlon: + a character object which represents the minimum longitude of a + geographic box. Decimal longitude with east begin positive. Only + data east of this longitude will be returned. + +* parameter: + a character list or single character object which represents the parameter + code of the air pollutant related to the data being requested. + +* return_Header: + If False (default) only returns data requested as a pandas DataFrame. If + True returns a AQSAPI_V2 object. + +* service: + a string which represents the services provided by the AQS API. For a list + of available services refer to + `_` + for the complete listing of services available through the EPA + AQS Datamart API + +* sitenum: + a character object which represents the 4 digit site number (with + leading zeros) within the county and state being requested. + +* stateFIPS: + a character object which represents the 2 digit state FIPS code + (with leading zero) for the state being requested. + +* pqao_code: + a character object which represents the 4 digit AQS Primary Quality + Assurance Organization code (with leading zeroes). + +* username: + a character object which represents the email account that will be used to + connect to the AQS API. + +pyaqsapi functional families +============================ + +Sign up and credentials +----------------------- +The functions included in this family of functions are: + +:: + +* aqs_credentials +* aqs_sign_up + +These functions are used to sign up with Data Mart and to store credential + information to use with pyaqsapi. The aqs_sign_up function takes + one parameter: + +* email: + +The aqs_credentials function takes two parameters: + +* username: +* key: + +Data Mart API metadata functions +-------------------------------- +The functions included in this family of functions are: + +:: + +* aqs_isavailable +* aqs_knownissues +* aqs_fields_by_service +* aqs_revisionhistory + +These functions return Data Mart meta data + +The aqs_isavailable function takes no parameters and returns a + table which details the status of the AQS API. + +The aqs_fields_by_service function takes one parameter, service, + which is a character object which represents the services provided by + the AQS API. For a list of available services see + `Air Quality System (AQS) API - Services Overview + `_ + +The aqs_knownissues function takes no parameters and Returns a + table of any known issues with system functionality or the data. These are + usually issues that have been identified internally and will require some + time to correct in Data Mart or the API. This function implements a direct + API call to Data Mart and returns data directly from the API. Issues + returned via this function do not include any issues from the pyaqsapi + package. + +The aqs_revisionhistory function is used to query Data Mart for the + change history to the API. + +Data Mart API list functions +---------------------------- +The functions included in this family of functions are: +:: + +* aqs_cbsas, +* aqs_classes, +* aqs_counties_by_state, +* aqs_fields_by_service, +* aqs_isavailable, +* aqs_knownissues, +* aqs_mas, +* aqs_parameters_by_class, +* aqs_pqaos, +* aqs_revisionhistory, +* aqs_sampledurations, +* aqs_sites_by_county, +* aqs_states + + +List functions return the API status, API options or groupings that can be used + in conjunction with other API calls. By default each function in this + category returns results as a DataTable. If return_header parameter is set + to True a AQSAPI_v2 object is returned instead. + +aqs_cbsas returns a table of all available Core Based Statistical + Areas (cbsas) and their respective cbsa codes. + +aqs_states takes no arguments and returns a table of the available + states and their respective state FIPS codes. + +aqs_sampledurations takes no arguments and returns a table of the + available sample duration code used to construct other requests. + +aqs_classes takes no arguments and returns a table of parameter + classes (groups of parameters, i.e. "criteria" or "all"). + +aqs_counties_by_state takes one parameter, stateFIPS, which is a two + digit state FIPS code for the state being requested represented as a + character object and returns a table of counties and their + respective FIPS code for the state requested. Use aqs_states to + receive a table of valid state FIPS codes. + +aqs_sites_by_county takes two parameters, stateFIPS, which is a + two digit state FIPS code for the state being requested and county_code + which is a three digit county FIPS code for the county being requested, + both stateFIPS and county_code should be encoded as a character object. + This function returns a table of all air monitoring sites with the + requested state and county FIPS code combination. + +aqs_pqaos takes no parameters and returns an AQSAPI_V2 + object containing a table of primary quality assurance + organizations (pqaos). + +aqs_mas takes no parameters and returns an AQSAPI_V2 + object containing a table of monitoring agencies (MA). + +Data Mart aggregate functions +----------------------------- + +..note:: + AQS Data Mart API restricts the maximum amount of monitoring data to one + full year of data per API call. These functions are able to return multiple + years of data by making repeated calls to the API. Each call to the Data + Mart API will take time to complete. The more years of data being requested + the longer pyaqsapi will take to return the results. + +These functions retrieve aggregated data from the Data Mart API and are + grouped by how each function aggregates the data. There are 5 different + families of related aggregate functions. These families are arranged by how + the Data Mart API groups the returned data, bysite, bycounty, bystate, + by (bybox) and + by (bycbsa). Within each family + of aggregated data functions there are functions that call on the 10 + different services that the Data Mart API provides. All Aggregate + functions return a pandas DataFrame by default. If the return_Header + parameter is set to True an AQSAPI_V2 object is returned instead. + +These fourteen services are: + +1. **Monitors**: Returns operational information about the samplers (monitors) + used to collect the data. Includes identifying information, + operational dates, operating organizations, etc. Functions + using this service contain monitors in the function + name. + +2. **Sample Data**: Returns sample data - the most fine grain data reported to + EPA. Usually hourly, sometimes 5-minute, 12-hour, etc. + This service is available in several geographic selections + based on geography: site, county, state, cbsa (core based + statistical area, a grouping of counties), or + by latitude/longitude bounding box. Functions using this + service contain sampledata in the function name. + All Sample Data functions accept two additional, optional + parameters; cbdate and cedate. + + + cbdate: a 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. + + + cedate: a 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. + + + duration: an optional character string that represents the parameter + duration code that limits returned data to + a specific sample duration. The default value of + None results in no filtering based on + duration code. Valid durations include actual sample + durations and not calculated durations such as 8 hour + CO or $O_3$ rolling averages, 3/6 day PM averages or + Pb 3 month rolling averages. Refer to + [aqs_sampledurations()] for a list of all available + duration codes. + +3. **Daily Summary Data**: Returns data summarized at the daily level. All daily + summaries are calculated on midnight to midnight + basis in local time. Variables returned include + date, mean value, maximum value, etc. Functions + using this service contain Dailysummary in + the function name. All Daily Summary Data functions + accept two additional parameters; cbdate and cedate + + + cbdate: a 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. + + + cedate: a 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. + +4. **Annual Summary Data**: Returns data summarized at the yearly level. + Variables include mean value, maxima, + percentiles, etc. Functions using this service + contain annualdata in the function name. All + Annual Summary Data functions accept two + additional parameters; cbdate and cedate. + + + cbdate: a 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. + + + cedate: a 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. + +5. **Quarterly Summary Data**: Returns data summarized at the quarterly level. + Variables include mean value, maxima, + percentiles, etc. Functions using this service + contain quarterlydata in the function name. All + Annual Summary Data functions accept two + additional parameters; cbdate and cedate. + + + cbdate: a 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. + + + cedate: a 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. + +6. **Quality Assurance - Blanks Data**: + Quality assurance data - blanks samples. + 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. Functions using this service contain + qa_blanks in the function name. + +7. **Quality Assurance - Collocated Assessments**: + Quality assurance data - collocated assessments. + Collocated assessments are pairs of samples + collected by different samplers at the same time + and place. (These are "operational" samplers, + assessments with independently calibrated samplers + are called "audits".). Functions using this service + contain qa_collocated_assessments in the + function name. + +8. **Quality Assurance - Flow Rate Verifications**: + Quality assurance data - flow rate verifications. + Several times per year, each PM monitor must have + it's (fixed) flow rate verified by an operator taking + a measurement of the flow rate. Functions using this + service contain qa_flowrateverification in + the function name. + +9. **Quality Assurance - Flow Rate Audits**: + Quality assurance data - flow rate audits. At least twice + year, each PM monitor must have it's flow rate + measurement audited by an expert using a different + method than is used for flow rate verifications. + Functions using this service contain + qa_flowrateaudit in the function name. + +10. **Quality Assurance - One Point Quality Control Raw Data**: + Quality assurance data - one point quality control check + raw data. At least every two weeks, certain gaseous + monitors must be challenged with a known concentration to + determine monitor performance. Functions using this + service contain qa_one_point_qc in the function + name. + +11. **Quality Assurance - pep Audits**: + Quality assurance data - performance evaluation program + (pep) audits. pep audits are independent assessments used + to estimate total measurement system bias with a primary + quality assurance organization. Functions using this + service contain qa_pep_audit in the function + name. + +12. **Transaction Sample - AQS Submission data in transaction format (RD)**: + Transaction sample data - The raw transaction sample data + uploaded to AQS by the agency responsible for data + submissions in RD format. Functions using this + service contain transactionsample in the + function name. Transaction sample data is only available + aggregated by site, county, state or monitoring agency. + +13. **Quality Assurance - Annual Performance Evaluations**: + Quality assurance data - Annual performance evaluations. + A performance evaluation must be conducted on each primary + monitor once per year. The percent differences between + known and measured concentrations at several levels are + used to assess the quality of the monitoring data. + Functions using this service contain + aqs_qa_annualperformanceeval in the function + name. Annual performance in transaction format are + only available aggregated by site, county, state, + monitoring agency, and primary quality assurance + organization. Annual performance evaluations are only + available aggregated by site, county, state, + monitoring agency, and primary quality assurance + organization. + +14. **Quality Assurance - Annual performance Evaluations in transaction** \ + **format (RD)**: + Quality assurance data - The raw transaction annual + performance evaluations data in RD format. Functions using + this service contain + aqs_qa_annualperformanceevaltransaction in the + function name. Annual performance evaluations in transaction + format are only available aggregated by site, county, state, + monitoring agency, and primary quality assurance + organization. + + +Data Mart aggregate functions bysite +-------------------------------------- +The pyaqsapi.bysite module exports the following functions: +:: + +* bysite.annualsummary, +* bysite.dailysummary, +* bysite.helperfunctions, +* bysite.monitors, +* bysite.qa_annualpeferomanceeval, +* bysite.qa_annualperformanceevaltransaction, +* bysite.qa_blanks, +* bysite.qa_collocated_assessments, +* bysite.qa_flowrateaudit, +* bysite.qa_flowrateverification, +* bysite.qa_one_point_qc, +* bysite.qa_pep_audit, +* bysite.quarterlysummary, +* bysite.sampledata, +* bysite.transactionsample + +Functions in this family of functions aggregate data at the site level. All + bysite functions accept the following variables: + +* parameter: +* bdate: +* edate: +* stateFIPS: +* countycode: +* sitenum: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata functions and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata functions and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +Data Mart aggregate functions bycounty +---------------------------------------- +The pyaqsapi.bycounty module exports the following functions: +:: + +* bycounty.annualsummary, +* bycounty.dailysummary, +* bycounty.helperfunctions, +* bycounty.monitors, +* bycounty.qa_annualperformanceeval, +* bycounty.qa_annualperformanceevaltransaction, +* bycounty.qa_blanks, +* bycounty.qa_collocated_assessments, +* bycounty.qa_flowrateaudit, +* bycounty.qa_flowrateverification, +* bycounty.qa_one_point_qc, +* bycounty.qa_pep_audit, +* bycounty.quarterlysummary, +* bycounty.sampledata, +* bycounty.transactionsample + +Functions in this family of functions aggregate data at the county level. + All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* stateFIPS: +* countycode: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +Data Mart aggregate functions bystate +--------------------------------------- +The pyaqsapi.bystate module exports the following functions: +:: + +* bystate.annualsummary, +* bystate.dailysummary, +* bystate.helperfunctions, +* bystate.monitors, +* bystate.qa_annualperformanceeval, +* bystate.qa_annualperformanceevaltransaction, +* bystate.qa_blanks, +* bystate.qa_collocated_assessments, +* bystate.qa_flowrateaudit, +* bystate.qa_flowrateverification, +* bystate.qa_one_point_qc, +* bystate.qa_pep_audit, +* bystate.quarterlysummary, +* bystate.sampledata, +* bystate.transactionsample + +Functions in this family of functions aggregate data at the state level. + All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* stateFIPS: +* countycode: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +Data Mart aggregate functions by Monitoring agency (MA) +------------------------------------------------------- +The pyaqsapi.byma module exports the following functions: +:: + +* byma.qa_annualpeferomanceeval, +* byma.qa_annualperformanceevaltransaction, +* byma.qa_blanks, +* byma.qa_collocated_assessments, +* byma.qa_flowrateaudit, +* byma.qa_flowrateverification, +* byma.qa_one_point_qc, +* byma.qa_pep_audit, +* byma.transactionsample + +Functions in this family of functions aggregate data at the state level. + All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* stateFIPS: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata functions and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + + +functions in this family of functions aggregate data at the Monitoring Agency + (MA) level. All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* MA_code: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +Data Mart aggregate functions by Core Based Statistical Area (cbsa) +------------------------------------------------------------------- +The pyaqsapi.bycbsa module exports the following functions: +:: + +* bycbsa.annualsummary, +* bycbsa.dailysummary, +* bycbsa.helperfunctions, +* bycbsa.monitors, +* bycbsa.quarterlysummary, +* bycbsa.sampledata + +Functions in this family of functions aggregate data at the Core Based + Statistical Area (cbsa, as defined by the US Census Bureau) level. + All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* cbsa_code: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + + +Data Mart aggregate functions by Primary Quality Assurance Organization (pqao) +------------------------------------------------------------------------------ +The pyaqsapi.bypqao module exports the following functions: +:: + +* bypqao.qa_annualperformanceeval, +* bypqao.qa_annualperformanceevaltransaction, +* bypqao.qa_blanks, +* bypqao.qa_collocated_assessments, +* bypqao.qa_flowrateaudit, +* bypqao.qa_flowrateverification, +* bypqao.qa_one_point_qc, +* bypqao.qa_pep_audit + +Functions in this family of functions aggregate data at the Primary Quality + Assurance Organization (pqao) level. All functions accept the following + variables: + +* parameter: +* bdate: +* edate: +* pqao_code: +* return_header (optional): set to False by default. + +Data Mart aggregate functions by latitude/longitude bounding box (bybox) +-------------------------------------------------------------------------- +The pyaqsapi.bybox module exports the following functions: +:: + +* bybox.annualsummary, +* bybox.dailysummary, +* bybox.helperfunctions, +* bybox.monitors, +* bybox.quarterlysummary, +* bybox.sampledata + +Functions in this family of functions aggregate data by a + latitude/longitude bounding box (bybox) level. All functions accept the + following variables: + +* parameter: +* bdate: +* edate: +* minlat: +* minlon: +* maxlon: +* maxlat: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +pyaqsapi Miscellaneous functions +-------------------------------- + +These are miscellaneous functions exported by pyaqsapi. + +aqs_removeheader is the function that the pyaqsapi library +uses internally to coerce an AQSAPI_V2 object into a pandas DataFrame. +This is useful if the user saves the output from another pyaqsapi function +with return_header = True set but later decides that they want just a +simple pandas DataFrame object. This function takes only one variable: + +* AQSobject: + + diff --git a/docs/_build/html/_sources/pyaqsapi.bybox.rst.txt b/docs/_build/html/_sources/pyaqsapi.bybox.rst.txt deleted file mode 100644 index 627280f..0000000 --- a/docs/_build/html/_sources/pyaqsapi.bybox.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -pyaqsapi.bybox package -====================== - -Submodules ----------- - -pyaqsapi.bybox.bybox module ---------------------------- - -.. automodule:: pyaqsapi.bybox.bybox - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: pyaqsapi.bybox - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/pyaqsapi.bycbsa.rst.txt b/docs/_build/html/_sources/pyaqsapi.bycbsa.rst.txt deleted file mode 100644 index 3348546..0000000 --- a/docs/_build/html/_sources/pyaqsapi.bycbsa.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -pyaqsapi.bycbsa package -======================= - -Submodules ----------- - -pyaqsapi.bycbsa.bycbsa module ------------------------------ - -.. automodule:: pyaqsapi.bycbsa.bycbsa - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: pyaqsapi.bycbsa - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/pyaqsapi.bycounty.rst.txt b/docs/_build/html/_sources/pyaqsapi.bycounty.rst.txt deleted file mode 100644 index fbc9312..0000000 --- a/docs/_build/html/_sources/pyaqsapi.bycounty.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -pyaqsapi.bycounty package -========================= - -Submodules ----------- - -pyaqsapi.bycounty.bycounty module ---------------------------------- - -.. automodule:: pyaqsapi.bycounty.bycounty - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: pyaqsapi.bycounty - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/pyaqsapi.byma.rst.txt b/docs/_build/html/_sources/pyaqsapi.byma.rst.txt deleted file mode 100644 index 16bdc23..0000000 --- a/docs/_build/html/_sources/pyaqsapi.byma.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -pyaqsapi.byma package -===================== - -Submodules ----------- - -pyaqsapi.byma.byma module -------------------------- - -.. automodule:: pyaqsapi.byma.byma - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: pyaqsapi.byma - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/pyaqsapi.bypqao.rst.txt b/docs/_build/html/_sources/pyaqsapi.bypqao.rst.txt deleted file mode 100644 index 08432e0..0000000 --- a/docs/_build/html/_sources/pyaqsapi.bypqao.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -pyaqsapi.bypqao package -======================= - -Submodules ----------- - -pyaqsapi.bypqao.bypqao module ------------------------------ - -.. automodule:: pyaqsapi.bypqao.bypqao - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: pyaqsapi.bypqao - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/pyaqsapi.bysite.rst.txt b/docs/_build/html/_sources/pyaqsapi.bysite.rst.txt deleted file mode 100644 index 12df214..0000000 --- a/docs/_build/html/_sources/pyaqsapi.bysite.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -pyaqsapi.bysite package -======================= - -Submodules ----------- - -pyaqsapi.bysite.bysite module ------------------------------ - -.. automodule:: pyaqsapi.bysite.bysite - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: pyaqsapi.bysite - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/pyaqsapi.bystate.rst.txt b/docs/_build/html/_sources/pyaqsapi.bystate.rst.txt deleted file mode 100644 index 2ad7e14..0000000 --- a/docs/_build/html/_sources/pyaqsapi.bystate.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -pyaqsapi.bystate package -======================== - -Submodules ----------- - -pyaqsapi.bystate.bystate module -------------------------------- - -.. automodule:: pyaqsapi.bystate.bystate - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: pyaqsapi.bystate - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/pyaqsapi.rst.txt b/docs/_build/html/_sources/pyaqsapi.rst.txt deleted file mode 100644 index 05090ed..0000000 --- a/docs/_build/html/_sources/pyaqsapi.rst.txt +++ /dev/null @@ -1,94 +0,0 @@ -pyaqsapi package -================ - -Submodules ----------- - -pyaqsapi.bybox.bybox module -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.bybox.bybox - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.bycbsa.bycbsa module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.bycbsa.bycbsa - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.bycounty.bycounty module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.bycounty.bycounty - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.byma.byma module -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.byma.byma - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.bypqao.bypqao module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.bypqao.bypqao - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.bysite.bysite module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.bysite.bysite - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.bystate.bystate module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.bystate.bystate - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.helperfunctions module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.helperfunctions - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.listfunctions module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.listfunctions - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.metadatafunctions module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.metadatafunctions - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.setupfunctions module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pyaqsapi.setupfunctions - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html index d9e31fa..0ecaa5a 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -71,14 +71,10 @@

Index

A - | D | E - | G + | F | I | L - | M - | P - | Q | R | S | T @@ -88,87 +84,11 @@

Index

A

-
-

D

- - -
-

E

    @@ -177,20 +97,10 @@

    E
-

G

+

F

-
@@ -211,321 +121,6 @@

L

-

M

- - - -
- -

P

- - - -
    -
  • - pyaqsapi.bypqao.bypqao - -
    • -
  • - pyaqsapi.bysite - -
    • -
  • - pyaqsapi.bysite.bysite - -
    • -
  • - pyaqsapi.bystate - -
    • -
  • - pyaqsapi.bystate.bystate - -
    • -
  • - pyaqsapi.helperfunctions - -
    • -
  • - pyaqsapi.listfunctions - -
    • -
  • - pyaqsapi.metadatafunctions - -
    • -
  • - pyaqsapi.setupfunctions - -
    • -
- -

Q

- - - -
-

R

    @@ -537,26 +132,10 @@

    R

    S

    @@ -567,16 +146,6 @@

    T

    diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index 8726e8b..557505f 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -4,7 +4,7 @@ - pyaqsapi's documentation — pyaqsapi documentation + pyaqsapi user documentation — pyaqsapi documentation @@ -44,7 +44,7 @@ @@ -73,7 +91,7 @@
      • -
    • pyaqsapi's documentation
      • +
    • pyaqsapi user documentation
    • View page source
      • @@ -83,13 +101,12 @@
      -
      -

      pyaqsapi's documentation

      +
      +

      pyaqsapi user documentation

      -
      -

      EPA Disclaimer

      +

      EPA Disclaimer

      Note

      This software/application was developed by the U.S. Environmental @@ -107,7 +124,7 @@

      pyaqsapi's documentation -

      AQS DataMart Disclaimer

      +

      AQS DataMart Disclaimer

      Warning

      US EPA’s AQS Data Mart API V2 is currently in beta phase of development, @@ -123,7 +140,7 @@

      AQS DataMart Disclaimer

      -

      Introduction

      +

      Introduction

      The pyaqsapi module for the python 3 programming environment allows a python 3 programming environment to connect to and retrieve data from the United States Environmental Protection Agency’s (US EPA) Air Quality System (AQS) Data Mart @@ -145,7 +162,7 @@

      Introduction -

      About the timeliness of AQS Data

      +

      About the timeliness of AQS Data

      EPA's AQS Datamart API, the service that pyaqsapi retrieves data from, does not host real time (collected now/today) data. If real time data is needed, please use the AirNow API and direct all questions toward real time data there. RAQSAPI @@ -153,7 +170,7 @@

      Introduction -

      About RAQSAPI

      +

      About RAQSAPI

      pyaqsapi is a port of RAQSAPI to the python 3 programming environment. For anyone that is familiar with RAQSAPI, the pyaqsapi API will feel familiar to you, most of the functions are similar @@ -163,7 +180,7 @@

      Introduction -

      Install pyaqsapi

      +

      Install pyaqsapi

      To install pyaqsapi first clone the pyaqsapi repository.

      git clone https://github.com/USEPA/pyaqsapi.git
      @@ -182,7 +199,7 @@

      Introduction -

      Load pyaqsapi

      +

      Load pyaqsapi

      Like any other python package make sure that you are loading pyaqsapi in the same virtual environment where pyaqsapi was installed. Load pyaqsapi in the same any other python package is loaded.

      @@ -191,7 +208,7 @@

      Introduction -

      Using pyaqsapi

      +

      Using pyaqsapi

      For those who are already familiar with using RAQSAPI then the pyaqsapi API should feel familiar with a few minor differences regarding how the data is returned.

      @@ -203,7 +220,7 @@

      Introduction -

      Sign up and setting up user credentials with the pyaqsapi library

      +

      Sign up and setting up user credentials with the pyaqsapi library

      If you have not already done so you will need to sign up with AQS Data Mart using aqs_sign_up function, this function takes one input, “email,” which is a python 3 character object, that represents the email address that you want @@ -239,74 +256,1030 @@

      Introduction +

      Functions Exported by pyaqsapi

      +

      The pyaqsapi package includes the following submodules which are not +loaded by default:

      +
      * pyaqsapi.bysite
+* pyaqsapi.bycounty
+* pyaqsapi.bycounty
+* pyaqsapi.bycbsa
+* pyaqsapi.bybox
+* pyaqsapi.byma
+* pyaqsapi.ma
+
      +
      +

      With these submodules loaded to entire list of functions exported by the +pyaqsapi package includes:

      +
      * pyaqsapi.aqs_cbsas,
+* pyaqsapi.aqs_classes,
+* pyaqsapi.aqs_counties_by_state,
+* pyaqsapi.aqs_credentials,
+* pyaqsapi.aqs_credentials,
+* pyaqsapi.aqs_fields_by_service,
+* pyaqsapi.aqs_fields_by_service,
+* pyaqsapi.aqs_isavailable,
+* pyaqsapi.aqs_isavailable,
+* pyaqsapi.aqs_knownissues,
+* pyaqsapi.aqs_knownissues,
+* pyaqsapi.aqs_mas,
+* pyaqsapi.aqs_parameters_by_class,
+* pyaqsapi.aqs_pqaos,
+* pyaqsapi.aqs_removeheader,
+* pyaqsapi.aqs_revisionhistory,
+* pyaqsapi.aqs_revisionhistory,
+* pyaqsapi.aqs_sampledurations,
+* pyaqsapi.aqs_sign_up,
+* pyaqsapi.aqs_sign_up,
+* pyaqsapi.aqs_sites_by_county,
+* pyaqsapi.aqs_states,
+* pyaqsapi.bybox.annualsummary,
+* pyaqsapi.bybox.dailysummary,
+* pyaqsapi.bybox.helperfunctions,
+* pyaqsapi.bybox.monitors,
+* pyaqsapi.bybox.quarterlysummary,
+* pyaqsapi.bybox.sampledata,
+* pyaqsapi.bycbsa.annualsummary,
+* pyaqsapi.bycbsa.dailysummary,
+* pyaqsapi.bycbsa.helperfunctions,
+* pyaqsapi.bycbsa.monitors,
+* pyaqsapi.bycbsa.quarterlysummary,
+* pyaqsapi.bycbsa.sampledata,
+* pyaqsapi.bycounty.annualsummary,
+* pyaqsapi.bycounty.dailysummary,
+* pyaqsapi.bycounty.helperfunctions,
+* pyaqsapi.bycounty.monitors,
+* pyaqsapi.bycounty.qa_annualperformanceeval,
+* pyaqsapi.bycounty.qa_annualperformanceevaltransaction,
+* pyaqsapi.bycounty.qa_blanks,
+* pyaqsapi.bycounty.qa_collocated_assessments,
+* pyaqsapi.bycounty.qa_flowrateaudit,
+* pyaqsapi.bycounty.qa_flowrateverification,
+* pyaqsapi.bycounty.qa_one_point_qc,
+* pyaqsapi.bycounty.qa_pep_audit,
+* pyaqsapi.bycounty.quarterlysummary,
+* pyaqsapi.bycounty.sampledata,
+* pyaqsapi.bycounty.transactionsample,
+* pyaqsapi.byma.qa_annualpeferomanceeval,
+* pyaqsapi.byma.qa_annualperformanceevaltransaction,
+* pyaqsapi.byma.qa_blanks,
+* pyaqsapi.byma.qa_collocated_assessments,
+* pyaqsapi.byma.qa_flowrateaudit,
+* pyaqsapi.byma.qa_flowrateverification,
+* pyaqsapi.byma.qa_one_point_qc,
+* pyaqsapi.byma.qa_pep_audit,
+* pyaqsapi.byma.transactionsample,
+* pyaqsapi.bypqao.qa_annualperformanceeval,
+* pyaqsapi.bypqao.qa_annualperformanceevaltransaction,
+* pyaqsapi.bypqao.qa_blanks,
+* pyaqsapi.bypqao.qa_collocated_assessments,
+* pyaqsapi.bypqao.qa_flowrateaudit,
+* pyaqsapi.bypqao.qa_flowrateverification,
+* pyaqsapi.bypqao.qa_one_point_qc,
+* pyaqsapi.bypqao.qa_pep_audit,
+* pyaqsapi.bysite.annualsummary,
+* pyaqsapi.bysite.dailysummary,
+* pyaqsapi.bysite.helperfunctions,
+* pyaqsapi.bysite.monitors,
+* pyaqsapi.bysite.qa_annualpeferomanceeval,
+* pyaqsapi.bysite.qa_annualperformanceevaltransaction,
+* pyaqsapi.bysite.qa_blanks,
+* pyaqsapi.bysite.qa_collocated_assessments,
+* pyaqsapi.bysite.qa_flowrateaudit,
+* pyaqsapi.bysite.qa_flowrateverification,
+* pyaqsapi.bysite.qa_one_point_qc,
+* pyaqsapi.bysite.qa_pep_audit,
+* pyaqsapi.bysite.quarterlysummary,
+* pyaqsapi.bysite.sampledata,
+* pyaqsapi.bysite.transactionsample,
+* pyaqsapi.bystate.annualsummary,
+* pyaqsapi.bystate.dailysummary,
+* pyaqsapi.bystate.helperfunctions,
+* pyaqsapi.bystate.monitors,
+* pyaqsapi.bystate.qa_annualperformanceeval,
+* pyaqsapi.bystate.qa_annualperformanceevaltransaction,
+* pyaqsapi.bystate.qa_blanks,
+* pyaqsapi.bystate.qa_collocated_assessments,
+* pyaqsapi.bystate.qa_flowrateaudit,
+* pyaqsapi.bystate.qa_flowrateverification,
+* pyaqsapi.bystate.qa_one_point_qc,
+* pyaqsapi.bystate.qa_pep_audit,
+* pyaqsapi.bystate.quarterlysummary,
+* pyaqsapi.bystate.sampledata,
+* pyaqsapi.bystate.transactionsample
+
      +
      +

      pyaqsapi functions are named according to the service and filter variables that +are available by the AQS Data Mart API. Refer to Air Quality System (AQS) API for full details of the +AQS DataMart API.

      +

      +
      +

      Variable descriptions and usage

      +

      These are all the available variables that can be used with various functions +exported from the pyaqsapi library listed alphabetically. Not all of these +variables are used with every function, and not all of these parameters are +required. See the :ref: pyaqsapi functional families section to +see which parameters are used with each function.

      +
        +
      • +
        AQSobject:

        an object of type AQSAPI_V2 that is returned from pyaqsapi +aggregate functions wheen return_header is True.

        +
        +
        +
        • +
      • +
        bdate:

        a date object which represents the begin date of the data selection. +Only data on or after this date will be returned.

        +
        +
        +
        • +
      • +
        cbdate (optional):

        a date object which represents the "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.

        +
        +
        +
        • +
      • +
        cedate (optional):

        a date object which represents the "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.

        +
        +
        +
        • +
      • +
        countycode:

        a character object which represents the 3 digit state FIPS code for the +county being requested (with leading zero(s)). Refer to +:ref: listfunctions for a table of available county codes for each state.

        +
        +
        +
        • +
      • +
        duration (optional):

        a character string that represents the parameter duration code that limits +returned data to a specific sample duration. The default value of None +will result in no filtering based on duration code. Valid durations +include actual sample durations and not calculated durations such as 8 hour +CO or O3rolling averages, 3/6 day PM averages or Pb 3 month +rolling averages. Refer to :ref: aqs_sampledurations() for a table of all +available duration codes.

        +
        +
        +
        • +
      • +
        edate:

        a date object which represents the end date of the data selection. Only +data on or before this date will be returned.

        +
        +
        +
        • +
      • +
        email:

        a character object which represents the email account that will be used to +register with the AQS API or change an existing user's key. A verification +email will be sent to the account specified.

        +
        +
        +
        • +
      • +
        key:

        a character object which represents the key used in conjunction with the +username given to connect to AQS Data Mart.

        +
        +
        +
        • +
      • +
        MA_code:

        a character object which represents the 4 digit AQS Monitoring Agency code +(with leading zeroes).

        +
        +
        +
        • +
      • +
        maxlat:

        a character object which represents the maximum latitude of a geographic +box. Decimal latitude with north begin positive. Only data south of this +latitude will be returned.

        +
        +
        +
        • +
      • +
        maxlon:

        a character object which represents the maximum longitude of a +geographic box. Decimal longitude with east being positive. Only +data west of this longitude will be returned. Note that -80 is less +than -70.

        +
        +
        +
        • +
      • +
        minlat:

        a character object which represents the minimum latitude of a +geographic box. Decimal latitude with north being positive. +Only data north of this latitude will be returned.

        +
        +
        +
        • +
      • +
        minlon:

        a character object which represents the minimum longitude of a +geographic box. Decimal longitude with east begin positive. Only +data east of this longitude will be returned.

        +
        +
        +
        • +
      • +
        parameter:

        a character list or single character object which represents the parameter +code of the air pollutant related to the data being requested.

        +
        +
        +
        • +
      • +
        return_Header:

        If False (default) only returns data requested as a pandas DataFrame. If +True returns a AQSAPI_V2 object.

        +
        +
        +
        • +
      • +
        service:

        a string which represents the services provided by the AQS API. For a list +of available services refer to +<https://aqs.epa.gov/aqsweb/documents/data_api.html#services>_ +for the complete listing of services available through the EPA +AQS Datamart API

        +
        +
        +
        • +
      • +
        sitenum:

        a character object which represents the 4 digit site number (with +leading zeros) within the county and state being requested.

        +
        +
        +
        • +
      • +
        stateFIPS:

        a character object which represents the 2 digit state FIPS code +(with leading zero) for the state being requested.

        +
        +
        +
        • +
      • +
        pqao_code:

        a character object which represents the 4 digit AQS Primary Quality +Assurance Organization code (with leading zeroes).

        +
        +
        +
        • +
      • +
        username:

        a character object which represents the email account that will be used to +connect to the AQS API.

        +
        +
        +
        • +
      +
      +
      +

      pyaqsapi functional families

      +
      +

      Sign up and credentials

      +

      The functions included in this family of functions are:

      +
      * aqs_credentials
+* aqs_sign_up
+
      +
      +
      +
      These functions are used to sign up with Data Mart and to store credential

      information to use with pyaqsapi. The aqs_sign_up function takes +one parameter:

      +
      +
      +
        +

      • email:

        • +
      +

      The aqs_credentials function takes two parameters:

      +
        +

      • username:

        • +

      • key:

        • +
      +
      +
      +

      Data Mart API metadata functions

      +

      The functions included in this family of functions are:

      +
      * aqs_isavailable
+* aqs_knownissues
+* aqs_fields_by_service
+* aqs_revisionhistory
+
      +
      +

      These functions return Data Mart meta data

      +
      +
      The aqs_isavailable function takes no parameters and returns a

      table which details the status of the AQS API.

      +
      +
      The aqs_fields_by_service function takes one parameter, service,

      which is a character object which represents the services provided by +the AQS API. For a list of available services see +Air Quality System (AQS) API - Services Overview

      +
      +
      The aqs_knownissues function takes no parameters and Returns a

      table of any known issues with system functionality or the data. These are +usually issues that have been identified internally and will require some +time to correct in Data Mart or the API. This function implements a direct +API call to Data Mart and returns data directly from the API. Issues +returned via this function do not include any issues from the pyaqsapi +package.

      +
      +
      The aqs_revisionhistory function is used to query Data Mart for the

      change history to the API.

      +
      +
      +
      +
      +

      Data Mart API list functions

      +

      The functions included in this family of functions are:

      +
      * aqs_cbsas,
+* aqs_classes,
+* aqs_counties_by_state,
+* aqs_fields_by_service,
+* aqs_isavailable,
+* aqs_knownissues,
+* aqs_mas,
+* aqs_parameters_by_class,
+* aqs_pqaos,
+* aqs_revisionhistory,
+* aqs_sampledurations,
+* aqs_sites_by_county,
+* aqs_states
+
      +
      +
      +
      List functions return the API status, API options or groupings that can be used

      in conjunction with other API calls. By default each function in this +category returns results as a DataTable. If return_header parameter is set +to True a AQSAPI_v2 object is returned instead.

      +
      +
      aqs_cbsas returns a table of all available Core Based Statistical

      Areas (cbsas) and their respective cbsa codes.

      +
      +
      aqs_states takes no arguments and returns a table of the available

      states and their respective state FIPS codes.

      +
      +
      aqs_sampledurations takes no arguments and returns a table of the

      available sample duration code used to construct other requests.

      +
      +
      aqs_classes takes no arguments and returns a table of parameter

      classes (groups of parameters, i.e. "criteria" or "all").

      +
      +
      aqs_counties_by_state takes one parameter, stateFIPS, which is a two

      digit state FIPS code for the state being requested represented as a +character object and returns a table of counties and their +respective FIPS code for the state requested. Use aqs_states to +receive a table of valid state FIPS codes.

      +
      +
      aqs_sites_by_county takes two parameters, stateFIPS, which is a

      two digit state FIPS code for the state being requested and county_code +which is a three digit county FIPS code for the county being requested, +both stateFIPS and county_code should be encoded as a character object. +This function returns a table of all air monitoring sites with the +requested state and county FIPS code combination.

      +
      +
      aqs_pqaos takes no parameters and returns an AQSAPI_V2

      object containing a table of primary quality assurance +organizations (pqaos).

      +
      +
      aqs_mas takes no parameters and returns an AQSAPI_V2

      object containing a table of monitoring agencies (MA).

      +
      +
      +
      -

      Data Mart aggregate functions

      -
      -

      Note

      -

      AQS Data Mart API restricts the maximum amount of monitoring data to one +

      Data Mart aggregate functions

      +
      +
      ..note::

      AQS Data Mart API restricts the maximum amount of monitoring data to one full year of data per API call. These functions are able to return multiple years of data by making repeated calls to the API. Each call to the Data Mart API will take time to complete. The more years of data being requested the longer pyaqsapi will take to return the results.

      -
      -

      These functions retrieve aggregated data from the Data Mart API and are grouped -by how each function aggregates the data. There are 7 different families of -related aggregate functions in which the AQS Data Mart API groups data.

      -

      These seven families are:

      -
      -
        -

      • by site (aqs.bysite)

        • -

      • by county (aqs.bycounty)

        • -

      • by state (aqs.bystate)

        • -

      • by latitude/longitude bounding box (aqs.bybox)

        • -

      • by monitoring agency (aqs.byma)

        • -

      • by Primary Quality Assurance Organization (aqs.bypqao)

        • -

      • by core based statistical area (as defined by the US census Bureau) -(aqs.bycbsa).

        • + +
        These functions retrieve aggregated data from the Data Mart API and are

        grouped by how each function aggregates the data. There are 5 different +families of related aggregate functions. These families are arranged by how +the Data Mart API groups the returned data, bysite, bycounty, bystate, +by<latitude/longitude bounding box> (bybox) and +by<core based statistical area> (bycbsa). Within each family +of aggregated data functions there are functions that call on the 10 +different services that the Data Mart API provides. All Aggregate +functions return a pandas DataFrame by default. If the return_Header +parameter is set to True an AQSAPI_V2 object is returned instead.

        +
        + +

        These fourteen services are:

        +
          +
        1. +
          Monitors: Returns operational information about the samplers (monitors)

          used to collect the data. Includes identifying information, +operational dates, operating organizations, etc. Functions +using this service contain monitors in the function +name.

          +
          +
          +
          2. +
        2. +
          Sample Data: Returns sample data - the most fine grain data reported to
          +

          EPA. Usually hourly, sometimes 5-minute, 12-hour, etc. +This service is available in several geographic selections +based on geography: site, county, state, cbsa (core based +statistical area, a grouping of counties), or +by latitude/longitude bounding box. Functions using this +service contain sampledata in the function name. +All Sample Data functions accept two additional, optional +parameters; cbdate and cedate.

          +
          +
            +
          • +
            cbdate: a 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.

            +
            +
            +
            • +
          • +
            cedate: a 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.

            +
            +
            +
            • +
          • +
            duration: an optional character string that represents the parameter

            duration code that limits returned data to +a specific sample duration. The default value of +None results in no filtering based on +duration code. Valid durations include actual sample +durations and not calculated durations such as 8 hour +CO or $O_3$ rolling averages, 3/6 day PM averages or +Pb 3 month rolling averages. Refer to +[aqs_sampledurations()] for a list of all available +duration codes.

            +
            +
            +
          +
          +
          +
          3. +
        3. +
          Daily Summary Data: Returns data summarized at the daily level. All daily
          +

          summaries are calculated on midnight to midnight +basis in local time. Variables returned include +date, mean value, maximum value, etc. Functions +using this service contain Dailysummary in +the function name. All Daily Summary Data functions +accept two additional parameters; cbdate and cedate

          -

          Within these families of aggregated data functions there are functions that -call on the 13 different aggregate services that the Data Mart API provides. -Note that not all aggregations are available for each service.

          -

          These thirteen services are:

          -
          -
            -

          • Monitors (*monitors)

            • -

          • Sample Data (*sampledata)

            • -

          • Daily Summary Data (*dailydata)

            • -

          • Annual Summary Data (annualdata)

            • -

          • Quality Assurance - Blanks Data (*qa_blanks)

            • -

          • Quality Assurance - Collocated Assessments -(*qa_collocated_assessments)

            • -

          • Quality Assurance - Flow Rate Verifications (*qa_flowrateverification)

            • -

          • Quality Assurance - Flow Rate Audits (*aqs_qa_flowrateaudit)

            • -

          • Quality Assurance - One Point Quality Control Raw Data -(*qa_one_point_qc)

            • -

          • Quality Assurance - PEP Audits (*qa_pep_audit)

            • -

          • Transaction Sample - AQS Submission data in transaction Format (RD) -(*transactionsample)

            • -

          • Quality Assurance - Annual Performance Evaluations -(*qa_annualpeferomanceeval)

            • -

          • Quality Assurance - Annual Performance Evaluations in the AQS -Submission transaction format (RD) -(*qa_annualpeferomanceevaltransaction)

            • +
              +
            • +
              cbdate: a 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.

              +
              +
              +
              • +
            • +
              cedate: a 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.

              +
              +
              +
            +
          +
          +
          4. +
        4. +
          Annual Summary Data: Returns data summarized at the yearly level.
          +

          Variables include mean value, maxima, +percentiles, etc. Functions using this service +contain annualdata in the function name. All +Annual Summary Data functions accept two +additional parameters; cbdate and cedate.

          -

          Aggregate functions are named aqs.<aggregation>.<service>() where <service> -is one of the 13 services listed above and <aggregation> is either -"bysite“, ”bycounty“, ”bystate“, ”bybox“, ”bycbsa", "byma" or "bypqao".

          +
            +
          • +
            cbdate: a 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.

            +
            +
            +
            • +
          • +
            cedate: a 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.

            +
            +
            +
            • +
          +
          +
          +
          5. +
        5. +
          Quarterly Summary Data: Returns data summarized at the quarterly level.
          +

          Variables include mean value, maxima, +percentiles, etc. Functions using this service +contain quarterlydata in the function name. All +Annual Summary Data functions accept two +additional parameters; cbdate and cedate.

          +
          +
            +
          • +
            cbdate: a 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.

            +
            +
            +
            • +
          • +
            cedate: a 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.

            +
            +
            +
            • +
          +
          +
          +
          6. +
        6. +
          Quality Assurance - Blanks Data:
          +
          Quality assurance data - blanks samples.

          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. Functions using this service contain +qa_blanks in the function name.

          +
          +
          +
          +
          +
          7. +
        7. +
          Quality Assurance - Collocated Assessments:
          +
          Quality assurance data - collocated assessments.

          Collocated assessments are pairs of samples +collected by different samplers at the same time +and place. (These are "operational" samplers, +assessments with independently calibrated samplers +are called "audits".). Functions using this service +contain qa_collocated_assessments in the +function name.

          +
          +
          +
          +
          +
          8. +
        8. +
          Quality Assurance - Flow Rate Verifications:
          +
          Quality assurance data - flow rate verifications.

          Several times per year, each PM monitor must have +it's (fixed) flow rate verified by an operator taking +a measurement of the flow rate. Functions using this +service contain qa_flowrateverification in +the function name.

          +
          +
          +
          +
          +
          9. +
        9. +
          Quality Assurance - Flow Rate Audits:
          +
          Quality assurance data - flow rate audits. At least twice

          year, each PM monitor must have it's flow rate +measurement audited by an expert using a different +method than is used for flow rate verifications. +Functions using this service contain +qa_flowrateaudit in the function name.

          +
          +
          +
          +
          +
          10. +
        10. +
          Quality Assurance - One Point Quality Control Raw Data:

          Quality assurance data - one point quality control check +raw data. At least every two weeks, certain gaseous +monitors must be challenged with a known concentration to +determine monitor performance. Functions using this +service contain qa_one_point_qc in the function +name.

          +
          +
          +
          11. +
        11. +
          Quality Assurance - pep Audits:

          Quality assurance data - performance evaluation program +(pep) audits. pep audits are independent assessments used +to estimate total measurement system bias with a primary +quality assurance organization. Functions using this +service contain qa_pep_audit in the function +name.

          +
          +
          +
          12. +
        12. +
          Transaction Sample - AQS Submission data in transaction format (RD):

          Transaction sample data - The raw transaction sample data +uploaded to AQS by the agency responsible for data +submissions in RD format. Functions using this +service contain transactionsample in the +function name. Transaction sample data is only available +aggregated by site, county, state or monitoring agency.

          +
          +
          +
          13. +
        13. +
          Quality Assurance - Annual Performance Evaluations:

          Quality assurance data - Annual performance evaluations. +A performance evaluation must be conducted on each primary +monitor once per year. The percent differences between +known and measured concentrations at several levels are +used to assess the quality of the monitoring data. +Functions using this service contain +aqs_qa_annualperformanceeval in the function +name. Annual performance in transaction format are +only available aggregated by site, county, state, +monitoring agency, and primary quality assurance +organization. Annual performance evaluations are only +available aggregated by site, county, state, +monitoring agency, and primary quality assurance +organization.

          +
          +
          +
          14. +
        14. +
          Quality Assurance - Annual performance Evaluations in transaction
          +
          format (RD):

          Quality assurance data - The raw transaction annual +performance evaluations data in RD format. Functions using +this service contain +aqs_qa_annualperformanceevaltransaction in the +function name. Annual performance evaluations in transaction +format are only available aggregated by site, county, state, +monitoring agency, and primary quality assurance +organization.

          +
          +
          +
          +
          +
          15. +
        +
      +
      +

      Data Mart aggregate functions bysite

      +

      The pyaqsapi.bysite module exports the following functions:

      +
      * bysite.annualsummary,
+* bysite.dailysummary,
+* bysite.helperfunctions,
+* bysite.monitors,
+* bysite.qa_annualpeferomanceeval,
+* bysite.qa_annualperformanceevaltransaction,
+* bysite.qa_blanks,
+* bysite.qa_collocated_assessments,
+* bysite.qa_flowrateaudit,
+* bysite.qa_flowrateverification,
+* bysite.qa_one_point_qc,
+* bysite.qa_pep_audit,
+* bysite.quarterlysummary,
+* bysite.sampledata,
+* bysite.transactionsample
+
      +
      +
      +
      Functions in this family of functions aggregate data at the site level. All

      bysite functions accept the following variables:

      +
      +
      +
        +

      • parameter:

        • +

      • bdate:

        • +

      • edate:

        • +

      • stateFIPS:

        • +

      • countycode:

        • +

      • sitenum:

        • +
      • +
        cbdate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata functions and +quarterlysummary functions).

        +
        +
        +
        • +
      • +
        cedate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata functions and +quarterlysummary functions).

        +
        +
        +
        • +

      • return_header (optional): set to False by default.

        • +
      • +
        duration (optional): (This parameter is only used in conjunction with

        sampledata functions).

        +
        +
        +
        • +
      +
      +
      +

      Data Mart aggregate functions bycounty

      +

      The pyaqsapi.bycounty module exports the following functions:

      +
      * bycounty.annualsummary,
+* bycounty.dailysummary,
+* bycounty.helperfunctions,
+* bycounty.monitors,
+* bycounty.qa_annualperformanceeval,
+* bycounty.qa_annualperformanceevaltransaction,
+* bycounty.qa_blanks,
+* bycounty.qa_collocated_assessments,
+* bycounty.qa_flowrateaudit,
+* bycounty.qa_flowrateverification,
+* bycounty.qa_one_point_qc,
+* bycounty.qa_pep_audit,
+* bycounty.quarterlysummary,
+* bycounty.sampledata,
+* bycounty.transactionsample
+
      +
      +
      +
      Functions in this family of functions aggregate data at the county level.

      All functions accept the following variables:

      +
      +
      +
        +

      • parameter:

        • +

      • bdate:

        • +

      • edate:

        • +

      • stateFIPS:

        • +

      • countycode:

        • +
      • +
        cbdate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +
      • +
        cedate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +

      • return_header (optional): set to False by default.

        • +
      • +
        duration (optional): (This parameter is only used in conjunction with

        sampledata functions).

        +
        +
        +
        • +
      +
      +
      +

      Data Mart aggregate functions bystate

      +

      The pyaqsapi.bystate module exports the following functions:

      +
      * bystate.annualsummary,
+* bystate.dailysummary,
+* bystate.helperfunctions,
+* bystate.monitors,
+* bystate.qa_annualperformanceeval,
+* bystate.qa_annualperformanceevaltransaction,
+* bystate.qa_blanks,
+* bystate.qa_collocated_assessments,
+* bystate.qa_flowrateaudit,
+* bystate.qa_flowrateverification,
+* bystate.qa_one_point_qc,
+* bystate.qa_pep_audit,
+* bystate.quarterlysummary,
+* bystate.sampledata,
+* bystate.transactionsample
+
      +
      +
      +
      Functions in this family of functions aggregate data at the state level.

      All functions accept the following variables:

      +
      +
      +
        +

      • parameter:

        • +

      • bdate:

        • +

      • edate:

        • +

      • stateFIPS:

        • +

      • countycode:

        • +
      • +
        cbdate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +
      • +
        cedate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +

      • return_header (optional): set to False by default.

        • +
      • +
        duration (optional): (This parameter is only used in conjunction with

        sampledata functions).

        +
        +
        +
        • +
      +
      +
      +

      Data Mart aggregate functions by Monitoring agency (MA)

      +

      The pyaqsapi.byma module exports the following functions:

      +
      * byma.qa_annualpeferomanceeval,
+* byma.qa_annualperformanceevaltransaction,
+* byma.qa_blanks,
+* byma.qa_collocated_assessments,
+* byma.qa_flowrateaudit,
+* byma.qa_flowrateverification,
+* byma.qa_one_point_qc,
+* byma.qa_pep_audit,
+* byma.transactionsample
+
      +
      +
      +
      Functions in this family of functions aggregate data at the state level.

      All functions accept the following variables:

      +
      +
      +
        +

      • parameter:

        • +

      • bdate:

        • +

      • edate:

        • +

      • stateFIPS:

        • +
      • +
        cbdate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata functions and +quarterlysummary functions).

        +
        +
        +
        • +
      • +
        cedate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +

      • return_header (optional): set to False by default.

        • +
      • +
        duration (optional): (This parameter is only used in conjunction with

        sampledata functions).

        +
        +
        +
        • +
      +
      +
      functions in this family of functions aggregate data at the Monitoring Agency

      (MA) level. All functions accept the following variables:

      +
      +
      +
        +

      • parameter:

        • +

      • bdate:

        • +

      • edate:

        • +

      • MA_code:

        • +
      • +
        cbdate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +
      • +
        cedate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +

      • return_header (optional): set to False by default.

        • +
      • +
        duration (optional): (This parameter is only used in conjunction with

        sampledata functions).

        +
        +
        +
        • +
      +
      +
      +

      Data Mart aggregate functions by Core Based Statistical Area (cbsa)

      +

      The pyaqsapi.bycbsa module exports the following functions:

      +
      * bycbsa.annualsummary,
+* bycbsa.dailysummary,
+* bycbsa.helperfunctions,
+* bycbsa.monitors,
+* bycbsa.quarterlysummary,
+* bycbsa.sampledata
+
      +
      +
      +
      Functions in this family of functions aggregate data at the Core Based

      Statistical Area (cbsa, as defined by the US Census Bureau) level. +All functions accept the following variables:

      +
      +
      +
        +

      • parameter:

        • +

      • bdate:

        • +

      • edate:

        • +

      • cbsa_code:

        • +
      • +
        cbdate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +
      • +
        cedate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +

      • return_header (optional): set to False by default.

        • +
      • +
        duration (optional): (This parameter is only used in conjunction with

        sampledata functions).

        +
        +
        +
        • +
      +
      +
      +

      Data Mart aggregate functions by Primary Quality Assurance Organization (pqao)

      +

      The pyaqsapi.bypqao module exports the following functions:

      +
      * bypqao.qa_annualperformanceeval,
+* bypqao.qa_annualperformanceevaltransaction,
+* bypqao.qa_blanks,
+* bypqao.qa_collocated_assessments,
+* bypqao.qa_flowrateaudit,
+* bypqao.qa_flowrateverification,
+* bypqao.qa_one_point_qc,
+* bypqao.qa_pep_audit
+
      +
      +
      +
      Functions in this family of functions aggregate data at the Primary Quality

      Assurance Organization (pqao) level. All functions accept the following +variables:

      +
      +
      +
        +

      • parameter:

        • +

      • bdate:

        • +

      • edate:

        • +

      • pqao_code:

        • +

      • return_header (optional): set to False by default.

        • +
      +
      +
      +

      Data Mart aggregate functions by latitude/longitude bounding box (bybox)

      +

      The pyaqsapi.bybox module exports the following functions:

      +
      * bybox.annualsummary,
+* bybox.dailysummary,
+* bybox.helperfunctions,
+* bybox.monitors,
+* bybox.quarterlysummary,
+* bybox.sampledata
+
      +
      +
      +
      Functions in this family of functions aggregate data by a

      latitude/longitude bounding box (bybox) level. All functions accept the +following variables:

      +
      +
      +
        +

      • parameter:

        • +

      • bdate:

        • +

      • edate:

        • +

      • minlat:

        • +

      • minlon:

        • +

      • maxlon:

        • +

      • maxlat:

        • +
      • +
        cbdate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +
      • +
        cedate (optional): (This parameter is only used in conjunction with

        sampledata, dailysummary, +annualdata and +quarterlysummary functions).

        +
        +
        +
        • +

      • return_header (optional): set to False by default.

        • +
      • +
        duration (optional): (This parameter is only used in conjunction with

        sampledata functions).

        +
        +
        +
        • +
      +
      +
      +

      pyaqsapi Miscellaneous functions

      +

      These are miscellaneous functions exported by pyaqsapi.

      +

      aqs_removeheader is the function that the pyaqsapi library +uses internally to coerce an AQSAPI_V2 object into a pandas DataFrame. +This is useful if the user saves the output from another pyaqsapi function +with return_header = True set but later decides that they want just a +simple pandas DataFrame object. This function takes only one variable:

      +
        +

      • AQSobject:

        • +
      -

      pyaqsapi API reference documentation

      +

      pyaqsapi API reference documentation

      -
      -

      Index

      +
      +

      pyaqsapi index

      +
      +
      diff --git a/docs/_build/html/manual/pyaqsapiFunctions-Brief.html b/docs/_build/html/manual/pyaqsapiFunctions-Brief.html index 9485ea0..ff192e2 100644 --- a/docs/_build/html/manual/pyaqsapiFunctions-Brief.html +++ b/docs/_build/html/manual/pyaqsapiFunctions-Brief.html @@ -72,7 +72,7 @@
      -

      Data Mart aggregate functions

      +

      Data Mart aggregate functions

      Note

      AQS Data Mart API restricts the maximum amount of monitoring data to one @@ -84,7 +84,7 @@

      These functions retrieve aggregated data from the Data Mart API and are grouped by how each function aggregates the data. There are 7 different families of related aggregate functions in which the AQS Data Mart API groups data.

      -

      These seven families are:

      +

      These seven families are:

      • by site (aqs.bysite)

        • @@ -100,28 +100,27 @@

        Within these families of aggregated data functions there are functions that call on the 13 different aggregate services that the Data Mart API provides. Note that not all aggregations are available for each service.

        -

        These thirteen services are:

        +

        These thirteen services are:

          -

        • Monitors (*monitors)

          • -

        • Sample Data (*sampledata)

          • -

        • Daily Summary Data (*dailydata)

          • +

        • Monitors (monitors)

          • +

        • Sample Data (sampledata)

          • +

        • Daily Summary Data (dailydata)

        • Annual Summary Data (annualdata)

          • -

        • Quality Assurance - Blanks Data (*qa_blanks)

          • +

        • Quality Assurance - Blanks Data (qa_blanks)

        • Quality Assurance - Collocated Assessments -(*qa_collocated_assessments)

          • -

        • Quality Assurance - Flow Rate Verifications (*qa_flowrateverification)

          • -

        • Quality Assurance - Flow Rate Audits (*aqs_qa_flowrateaudit)

          • +(qa_collocated_assessments)

          +

        • Quality Assurance - Flow Rate Verifications (qa_flowrateverification)

          • +

        • Quality Assurance - Flow Rate Audits (aqs_qa_flowrateaudit)

        • Quality Assurance - One Point Quality Control Raw Data -(*qa_one_point_qc)

          • -

        • Quality Assurance - PEP Audits (*qa_pep_audit)

          • +(qa_one_point_qc)

          +

        • Quality Assurance - PEP Audits (qa_pep_audit)

        • Transaction Sample - AQS Submission data in transaction Format (RD) -(*transactionsample)

          • +(transactionsample)

        • Quality Assurance - Annual Performance Evaluations -(*qa_annualpeferomanceeval)

          • +(qa_annualperformanceeval)

        • Quality Assurance - Annual Performance Evaluations in the AQS -Submission transaction format (RD) -(*qa_annualpeferomanceevaltransaction)

          • +Submission transaction format (RD) (qa_annualperformanceevaltransaction)

        Aggregate functions are named aqs.<aggregation>.<service>() where <service> diff --git a/docs/_build/html/manual/pyaqsapiFunctions-Long.html b/docs/_build/html/manual/pyaqsapiFunctions-Long.html new file mode 100644 index 0000000..c46d142 --- /dev/null +++ b/docs/_build/html/manual/pyaqsapiFunctions-Long.html @@ -0,0 +1,1131 @@ + + + + + + + Functions Exported by pyaqsapi — pyaqsapi documentation + + + + + + + + + + + + + + + + + +

        + + +
        + +
        +
        +
        + +
        +
        +
        +
        + +
        +

        Functions Exported by pyaqsapi

        +

        The pyaqsapi package includes the following submodules which are not +loaded by default:

        +
        * pyaqsapi.bysite
+* pyaqsapi.bycounty
+* pyaqsapi.bycounty
+* pyaqsapi.bycbsa
+* pyaqsapi.bybox
+* pyaqsapi.byma
+* pyaqsapi.ma
+
        +
        +

        With these submodules loaded to entire list of functions exported by the +pyaqsapi package includes:

        +
        * pyaqsapi.aqs_cbsas,
+* pyaqsapi.aqs_classes,
+* pyaqsapi.aqs_counties_by_state,
+* pyaqsapi.aqs_credentials,
+* pyaqsapi.aqs_credentials,
+* pyaqsapi.aqs_fields_by_service,
+* pyaqsapi.aqs_fields_by_service,
+* pyaqsapi.aqs_isavailable,
+* pyaqsapi.aqs_isavailable,
+* pyaqsapi.aqs_knownissues,
+* pyaqsapi.aqs_knownissues,
+* pyaqsapi.aqs_mas,
+* pyaqsapi.aqs_parameters_by_class,
+* pyaqsapi.aqs_pqaos,
+* pyaqsapi.aqs_removeheader,
+* pyaqsapi.aqs_revisionhistory,
+* pyaqsapi.aqs_revisionhistory,
+* pyaqsapi.aqs_sampledurations,
+* pyaqsapi.aqs_sign_up,
+* pyaqsapi.aqs_sign_up,
+* pyaqsapi.aqs_sites_by_county,
+* pyaqsapi.aqs_states,
+* pyaqsapi.bybox.annualsummary,
+* pyaqsapi.bybox.dailysummary,
+* pyaqsapi.bybox.helperfunctions,
+* pyaqsapi.bybox.monitors,
+* pyaqsapi.bybox.quarterlysummary,
+* pyaqsapi.bybox.sampledata,
+* pyaqsapi.bycbsa.annualsummary,
+* pyaqsapi.bycbsa.dailysummary,
+* pyaqsapi.bycbsa.helperfunctions,
+* pyaqsapi.bycbsa.monitors,
+* pyaqsapi.bycbsa.quarterlysummary,
+* pyaqsapi.bycbsa.sampledata,
+* pyaqsapi.bycounty.annualsummary,
+* pyaqsapi.bycounty.dailysummary,
+* pyaqsapi.bycounty.helperfunctions,
+* pyaqsapi.bycounty.monitors,
+* pyaqsapi.bycounty.qa_annualperformanceeval,
+* pyaqsapi.bycounty.qa_annualperformanceevaltransaction,
+* pyaqsapi.bycounty.qa_blanks,
+* pyaqsapi.bycounty.qa_collocated_assessments,
+* pyaqsapi.bycounty.qa_flowrateaudit,
+* pyaqsapi.bycounty.qa_flowrateverification,
+* pyaqsapi.bycounty.qa_one_point_qc,
+* pyaqsapi.bycounty.qa_pep_audit,
+* pyaqsapi.bycounty.quarterlysummary,
+* pyaqsapi.bycounty.sampledata,
+* pyaqsapi.bycounty.transactionsample,
+* pyaqsapi.byma.qa_annualpeferomanceeval,
+* pyaqsapi.byma.qa_annualperformanceevaltransaction,
+* pyaqsapi.byma.qa_blanks,
+* pyaqsapi.byma.qa_collocated_assessments,
+* pyaqsapi.byma.qa_flowrateaudit,
+* pyaqsapi.byma.qa_flowrateverification,
+* pyaqsapi.byma.qa_one_point_qc,
+* pyaqsapi.byma.qa_pep_audit,
+* pyaqsapi.byma.transactionsample,
+* pyaqsapi.bypqao.qa_annualperformanceeval,
+* pyaqsapi.bypqao.qa_annualperformanceevaltransaction,
+* pyaqsapi.bypqao.qa_blanks,
+* pyaqsapi.bypqao.qa_collocated_assessments,
+* pyaqsapi.bypqao.qa_flowrateaudit,
+* pyaqsapi.bypqao.qa_flowrateverification,
+* pyaqsapi.bypqao.qa_one_point_qc,
+* pyaqsapi.bypqao.qa_pep_audit,
+* pyaqsapi.bysite.annualsummary,
+* pyaqsapi.bysite.dailysummary,
+* pyaqsapi.bysite.helperfunctions,
+* pyaqsapi.bysite.monitors,
+* pyaqsapi.bysite.qa_annualpeferomanceeval,
+* pyaqsapi.bysite.qa_annualperformanceevaltransaction,
+* pyaqsapi.bysite.qa_blanks,
+* pyaqsapi.bysite.qa_collocated_assessments,
+* pyaqsapi.bysite.qa_flowrateaudit,
+* pyaqsapi.bysite.qa_flowrateverification,
+* pyaqsapi.bysite.qa_one_point_qc,
+* pyaqsapi.bysite.qa_pep_audit,
+* pyaqsapi.bysite.quarterlysummary,
+* pyaqsapi.bysite.sampledata,
+* pyaqsapi.bysite.transactionsample,
+* pyaqsapi.bystate.annualsummary,
+* pyaqsapi.bystate.dailysummary,
+* pyaqsapi.bystate.helperfunctions,
+* pyaqsapi.bystate.monitors,
+* pyaqsapi.bystate.qa_annualperformanceeval,
+* pyaqsapi.bystate.qa_annualperformanceevaltransaction,
+* pyaqsapi.bystate.qa_blanks,
+* pyaqsapi.bystate.qa_collocated_assessments,
+* pyaqsapi.bystate.qa_flowrateaudit,
+* pyaqsapi.bystate.qa_flowrateverification,
+* pyaqsapi.bystate.qa_one_point_qc,
+* pyaqsapi.bystate.qa_pep_audit,
+* pyaqsapi.bystate.quarterlysummary,
+* pyaqsapi.bystate.sampledata,
+* pyaqsapi.bystate.transactionsample
+
        +
        +

        pyaqsapi functions are named according to the service and filter variables that +are available by the AQS Data Mart API. Refer to Air Quality System (AQS) API for full details of the +AQS DataMart API.

        +
        +
        +

        Variable descriptions and usage

        +

        These are all the available variables that can be used with various functions +exported from the pyaqsapi library listed alphabetically. Not all of these +variables are used with every function, and not all of these parameters are +required. See the :ref: pyaqsapi functional families section to +see which parameters are used with each function.

        +
          +
        • +
          AQSobject:

          an object of type AQSAPI_V2 that is returned from pyaqsapi +aggregate functions wheen return_header is True.

          +
          +
          +
          • +
        • +
          bdate:

          a date object which represents the begin date of the data selection. +Only data on or after this date will be returned.

          +
          +
          +
          • +
        • +
          cbdate (optional):

          a date object which represents the "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.

          +
          +
          +
          • +
        • +
          cedate (optional):

          a date object which represents the "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.

          +
          +
          +
          • +
        • +
          countycode:

          a character object which represents the 3 digit state FIPS code for the +county being requested (with leading zero(s)). Refer to +:ref: listfunctions for a table of available county codes for each state.

          +
          +
          +
          • +
        • +
          duration (optional):

          a character string that represents the parameter duration code that limits +returned data to a specific sample duration. The default value of None +will result in no filtering based on duration code. Valid durations +include actual sample durations and not calculated durations such as 8 hour +CO or O3rolling averages, 3/6 day PM averages or Pb 3 month +rolling averages. Refer to :ref: aqs_sampledurations() for a table of all +available duration codes.

          +
          +
          +
          • +
        • +
          edate:

          a date object which represents the end date of the data selection. Only +data on or before this date will be returned.

          +
          +
          +
          • +
        • +
          email:

          a character object which represents the email account that will be used to +register with the AQS API or change an existing user's key. A verification +email will be sent to the account specified.

          +
          +
          +
          • +
        • +
          key:

          a character object which represents the key used in conjunction with the +username given to connect to AQS Data Mart.

          +
          +
          +
          • +
        • +
          MA_code:

          a character object which represents the 4 digit AQS Monitoring Agency code +(with leading zeroes).

          +
          +
          +
          • +
        • +
          maxlat:

          a character object which represents the maximum latitude of a geographic +box. Decimal latitude with north begin positive. Only data south of this +latitude will be returned.

          +
          +
          +
          • +
        • +
          maxlon:

          a character object which represents the maximum longitude of a +geographic box. Decimal longitude with east being positive. Only +data west of this longitude will be returned. Note that -80 is less +than -70.

          +
          +
          +
          • +
        • +
          minlat:

          a character object which represents the minimum latitude of a +geographic box. Decimal latitude with north being positive. +Only data north of this latitude will be returned.

          +
          +
          +
          • +
        • +
          minlon:

          a character object which represents the minimum longitude of a +geographic box. Decimal longitude with east begin positive. Only +data east of this longitude will be returned.

          +
          +
          +
          • +
        • +
          parameter:

          a character list or single character object which represents the parameter +code of the air pollutant related to the data being requested.

          +
          +
          +
          • +
        • +
          return_Header:

          If False (default) only returns data requested as a pandas DataFrame. If +True returns a AQSAPI_V2 object.

          +
          +
          +
          • +
        • +
          service:

          a string which represents the services provided by the AQS API. For a list +of available services refer to +<https://aqs.epa.gov/aqsweb/documents/data_api.html#services>_ +for the complete listing of services available through the EPA +AQS Datamart API

          +
          +
          +
          • +
        • +
          sitenum:

          a character object which represents the 4 digit site number (with +leading zeros) within the county and state being requested.

          +
          +
          +
          • +
        • +
          stateFIPS:

          a character object which represents the 2 digit state FIPS code +(with leading zero) for the state being requested.

          +
          +
          +
          • +
        • +
          pqao_code:

          a character object which represents the 4 digit AQS Primary Quality +Assurance Organization code (with leading zeroes).

          +
          +
          +
          • +
        • +
          username:

          a character object which represents the email account that will be used to +connect to the AQS API.

          +
          +
          +
          • +
        +
        +
        +

        pyaqsapi functional families

        +
        +

        Sign up and credentials

        +

        The functions included in this family of functions are:

        +
        * aqs_credentials
+* aqs_sign_up
+
        +
        +
        +
        These functions are used to sign up with Data Mart and to store credential

        information to use with pyaqsapi. The aqs_sign_up function takes +one parameter:

        +
        +
        +
          +

        • email:

          • +
        +

        The aqs_credentials function takes two parameters:

        +
          +

        • username:

          • +

        • key:

          • +
        +
        +
        +

        Data Mart API metadata functions

        +

        The functions included in this family of functions are:

        +
        * aqs_isavailable
+* aqs_knownissues
+* aqs_fields_by_service
+* aqs_revisionhistory
+
        +
        +

        These functions return Data Mart meta data

        +
        +
        The aqs_isavailable function takes no parameters and returns a

        table which details the status of the AQS API.

        +
        +
        The aqs_fields_by_service function takes one parameter, service,

        which is a character object which represents the services provided by +the AQS API. For a list of available services see +Air Quality System (AQS) API - Services Overview

        +
        +
        The aqs_knownissues function takes no parameters and Returns a

        table of any known issues with system functionality or the data. These are +usually issues that have been identified internally and will require some +time to correct in Data Mart or the API. This function implements a direct +API call to Data Mart and returns data directly from the API. Issues +returned via this function do not include any issues from the pyaqsapi +package.

        +
        +
        The aqs_revisionhistory function is used to query Data Mart for the

        change history to the API.

        +
        +
        +
        +
        +

        Data Mart API list functions

        +

        The functions included in this family of functions are:

        +
        * aqs_cbsas,
+* aqs_classes,
+* aqs_counties_by_state,
+* aqs_fields_by_service,
+* aqs_isavailable,
+* aqs_knownissues,
+* aqs_mas,
+* aqs_parameters_by_class,
+* aqs_pqaos,
+* aqs_revisionhistory,
+* aqs_sampledurations,
+* aqs_sites_by_county,
+* aqs_states
+
        +
        +
        +
        List functions return the API status, API options or groupings that can be used

        in conjunction with other API calls. By default each function in this +category returns results as a DataTable. If return_header parameter is set +to True a AQSAPI_v2 object is returned instead.

        +
        +
        aqs_cbsas returns a table of all available Core Based Statistical

        Areas (cbsas) and their respective cbsa codes.

        +
        +
        aqs_states takes no arguments and returns a table of the available

        states and their respective state FIPS codes.

        +
        +
        aqs_sampledurations takes no arguments and returns a table of the

        available sample duration code used to construct other requests.

        +
        +
        aqs_classes takes no arguments and returns a table of parameter

        classes (groups of parameters, i.e. "criteria" or "all").

        +
        +
        aqs_counties_by_state takes one parameter, stateFIPS, which is a two

        digit state FIPS code for the state being requested represented as a +character object and returns a table of counties and their +respective FIPS code for the state requested. Use aqs_states to +receive a table of valid state FIPS codes.

        +
        +
        aqs_sites_by_county takes two parameters, stateFIPS, which is a

        two digit state FIPS code for the state being requested and county_code +which is a three digit county FIPS code for the county being requested, +both stateFIPS and county_code should be encoded as a character object. +This function returns a table of all air monitoring sites with the +requested state and county FIPS code combination.

        +
        +
        aqs_pqaos takes no parameters and returns an AQSAPI_V2

        object containing a table of primary quality assurance +organizations (pqaos).

        +
        +
        aqs_mas takes no parameters and returns an AQSAPI_V2

        object containing a table of monitoring agencies (MA).

        +
        +
        +
        +
        +

        Data Mart aggregate functions

        +
        +
        ..note::

        AQS Data Mart API restricts the maximum amount of monitoring data to one +full year of data per API call. These functions are able to return multiple +years of data by making repeated calls to the API. Each call to the Data +Mart API will take time to complete. The more years of data being requested +the longer pyaqsapi will take to return the results.

        +
        +
        These functions retrieve aggregated data from the Data Mart API and are

        grouped by how each function aggregates the data. There are 5 different +families of related aggregate functions. These families are arranged by how +the Data Mart API groups the returned data, bysite, bycounty, bystate, +by<latitude/longitude bounding box> (bybox) and +by<core based statistical area> (bycbsa). Within each family +of aggregated data functions there are functions that call on the 10 +different services that the Data Mart API provides. All Aggregate +functions return a pandas DataFrame by default. If the return_Header +parameter is set to True an AQSAPI_V2 object is returned instead.

        +
        +
        +

        These fourteen services are:

        +
          +
        1. +
          Monitors: Returns operational information about the samplers (monitors)

          used to collect the data. Includes identifying information, +operational dates, operating organizations, etc. Functions +using this service contain monitors in the function +name.

          +
          +
          +
          2. +
        2. +
          Sample Data: Returns sample data - the most fine grain data reported to
          +

          EPA. Usually hourly, sometimes 5-minute, 12-hour, etc. +This service is available in several geographic selections +based on geography: site, county, state, cbsa (core based +statistical area, a grouping of counties), or +by latitude/longitude bounding box. Functions using this +service contain sampledata in the function name. +All Sample Data functions accept two additional, optional +parameters; cbdate and cedate.

          +
          +
            +
          • +
            cbdate: a 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.

            +
            +
            +
            • +
          • +
            cedate: a 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.

            +
            +
            +
            • +
          • +
            duration: an optional character string that represents the parameter

            duration code that limits returned data to +a specific sample duration. The default value of +None results in no filtering based on +duration code. Valid durations include actual sample +durations and not calculated durations such as 8 hour +CO or $O_3$ rolling averages, 3/6 day PM averages or +Pb 3 month rolling averages. Refer to +[aqs_sampledurations()] for a list of all available +duration codes.

            +
            +
            +
            • +
          +
          +
          +
          3. +
        3. +
          Daily Summary Data: Returns data summarized at the daily level. All daily
          +

          summaries are calculated on midnight to midnight +basis in local time. Variables returned include +date, mean value, maximum value, etc. Functions +using this service contain Dailysummary in +the function name. All Daily Summary Data functions +accept two additional parameters; cbdate and cedate

          +
          +
            +
          • +
            cbdate: a 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.

            +
            +
            +
            • +
          • +
            cedate: a 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.

            +
            +
            +
            • +
          +
          +
          +
          4. +
        4. +
          Annual Summary Data: Returns data summarized at the yearly level.
          +

          Variables include mean value, maxima, +percentiles, etc. Functions using this service +contain annualdata in the function name. All +Annual Summary Data functions accept two +additional parameters; cbdate and cedate.

          +
          +
            +
          • +
            cbdate: a 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.

            +
            +
            +
            • +
          • +
            cedate: a 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.

            +
            +
            +
            • +
          +
          +
          +
          5. +
        5. +
          Quarterly Summary Data: Returns data summarized at the quarterly level.
          +

          Variables include mean value, maxima, +percentiles, etc. Functions using this service +contain quarterlydata in the function name. All +Annual Summary Data functions accept two +additional parameters; cbdate and cedate.

          +
          +
            +
          • +
            cbdate: a 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.

            +
            +
            +
            • +
          • +
            cedate: a 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.

            +
            +
            +
            • +
          +
          +
          +
          6. +
        6. +
          Quality Assurance - Blanks Data:
          +
          Quality assurance data - blanks samples.

          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. Functions using this service contain +qa_blanks in the function name.

          +
          +
          +
          +
          +
          7. +
        7. +
          Quality Assurance - Collocated Assessments:
          +
          Quality assurance data - collocated assessments.

          Collocated assessments are pairs of samples +collected by different samplers at the same time +and place. (These are "operational" samplers, +assessments with independently calibrated samplers +are called "audits".). Functions using this service +contain qa_collocated_assessments in the +function name.

          +
          +
          +
          +
          +
          8. +
        8. +
          Quality Assurance - Flow Rate Verifications:
          +
          Quality assurance data - flow rate verifications.

          Several times per year, each PM monitor must have +it's (fixed) flow rate verified by an operator taking +a measurement of the flow rate. Functions using this +service contain qa_flowrateverification in +the function name.

          +
          +
          +
          +
          +
          9. +
        9. +
          Quality Assurance - Flow Rate Audits:
          +
          Quality assurance data - flow rate audits. At least twice

          year, each PM monitor must have it's flow rate +measurement audited by an expert using a different +method than is used for flow rate verifications. +Functions using this service contain +qa_flowrateaudit in the function name.

          +
          +
          +
          +
          +
          10. +
        10. +
          Quality Assurance - One Point Quality Control Raw Data:

          Quality assurance data - one point quality control check +raw data. At least every two weeks, certain gaseous +monitors must be challenged with a known concentration to +determine monitor performance. Functions using this +service contain qa_one_point_qc in the function +name.

          +
          +
          +
          11. +
        11. +
          Quality Assurance - pep Audits:

          Quality assurance data - performance evaluation program +(pep) audits. pep audits are independent assessments used +to estimate total measurement system bias with a primary +quality assurance organization. Functions using this +service contain qa_pep_audit in the function +name.

          +
          +
          +
          12. +
        12. +
          Transaction Sample - AQS Submission data in transaction format (RD):

          Transaction sample data - The raw transaction sample data +uploaded to AQS by the agency responsible for data +submissions in RD format. Functions using this +service contain transactionsample in the +function name. Transaction sample data is only available +aggregated by site, county, state or monitoring agency.

          +
          +
          +
          13. +
        13. +
          Quality Assurance - Annual Performance Evaluations:

          Quality assurance data - Annual performance evaluations. +A performance evaluation must be conducted on each primary +monitor once per year. The percent differences between +known and measured concentrations at several levels are +used to assess the quality of the monitoring data. +Functions using this service contain +aqs_qa_annualperformanceeval in the function +name. Annual performance in transaction format are +only available aggregated by site, county, state, +monitoring agency, and primary quality assurance +organization. Annual performance evaluations are only +available aggregated by site, county, state, +monitoring agency, and primary quality assurance +organization.

          +
          +
          +
          14. +
        14. +
          Quality Assurance - Annual performance Evaluations in transaction
          +
          format (RD):

          Quality assurance data - The raw transaction annual +performance evaluations data in RD format. Functions using +this service contain +aqs_qa_annualperformanceevaltransaction in the +function name. Annual performance evaluations in transaction +format are only available aggregated by site, county, state, +monitoring agency, and primary quality assurance +organization.

          +
          +
          +
          +
          +
          15. +
        +
        +
        +

        Data Mart aggregate functions bysite

        +

        The pyaqsapi.bysite module exports the following functions:

        +
        * bysite.annualsummary,
+* bysite.dailysummary,
+* bysite.helperfunctions,
+* bysite.monitors,
+* bysite.qa_annualpeferomanceeval,
+* bysite.qa_annualperformanceevaltransaction,
+* bysite.qa_blanks,
+* bysite.qa_collocated_assessments,
+* bysite.qa_flowrateaudit,
+* bysite.qa_flowrateverification,
+* bysite.qa_one_point_qc,
+* bysite.qa_pep_audit,
+* bysite.quarterlysummary,
+* bysite.sampledata,
+* bysite.transactionsample
+
        +
        +
        +
        Functions in this family of functions aggregate data at the site level. All

        bysite functions accept the following variables:

        +
        +
        +
          +

        • parameter:

          • +

        • bdate:

          • +

        • edate:

          • +

        • stateFIPS:

          • +

        • countycode:

          • +

        • sitenum:

          • +
        • +
          cbdate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata functions and +quarterlysummary functions).

          +
          +
          +
          • +
        • +
          cedate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata functions and +quarterlysummary functions).

          +
          +
          +
          • +

        • return_header (optional): set to False by default.

          • +
        • +
          duration (optional): (This parameter is only used in conjunction with

          sampledata functions).

          +
          +
          +
          • +
        +
        +
        +

        Data Mart aggregate functions bycounty

        +

        The pyaqsapi.bycounty module exports the following functions:

        +
        * bycounty.annualsummary,
+* bycounty.dailysummary,
+* bycounty.helperfunctions,
+* bycounty.monitors,
+* bycounty.qa_annualperformanceeval,
+* bycounty.qa_annualperformanceevaltransaction,
+* bycounty.qa_blanks,
+* bycounty.qa_collocated_assessments,
+* bycounty.qa_flowrateaudit,
+* bycounty.qa_flowrateverification,
+* bycounty.qa_one_point_qc,
+* bycounty.qa_pep_audit,
+* bycounty.quarterlysummary,
+* bycounty.sampledata,
+* bycounty.transactionsample
+
        +
        +
        +
        Functions in this family of functions aggregate data at the county level.

        All functions accept the following variables:

        +
        +
        +
          +

        • parameter:

          • +

        • bdate:

          • +

        • edate:

          • +

        • stateFIPS:

          • +

        • countycode:

          • +
        • +
          cbdate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +
        • +
          cedate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +

        • return_header (optional): set to False by default.

          • +
        • +
          duration (optional): (This parameter is only used in conjunction with

          sampledata functions).

          +
          +
          +
          • +
        +
        +
        +

        Data Mart aggregate functions bystate

        +

        The pyaqsapi.bystate module exports the following functions:

        +
        * bystate.annualsummary,
+* bystate.dailysummary,
+* bystate.helperfunctions,
+* bystate.monitors,
+* bystate.qa_annualperformanceeval,
+* bystate.qa_annualperformanceevaltransaction,
+* bystate.qa_blanks,
+* bystate.qa_collocated_assessments,
+* bystate.qa_flowrateaudit,
+* bystate.qa_flowrateverification,
+* bystate.qa_one_point_qc,
+* bystate.qa_pep_audit,
+* bystate.quarterlysummary,
+* bystate.sampledata,
+* bystate.transactionsample
+
        +
        +
        +
        Functions in this family of functions aggregate data at the state level.

        All functions accept the following variables:

        +
        +
        +
          +

        • parameter:

          • +

        • bdate:

          • +

        • edate:

          • +

        • stateFIPS:

          • +

        • countycode:

          • +
        • +
          cbdate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +
        • +
          cedate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +

        • return_header (optional): set to False by default.

          • +
        • +
          duration (optional): (This parameter is only used in conjunction with

          sampledata functions).

          +
          +
          +
          • +
        +
        +
        +

        Data Mart aggregate functions by Monitoring agency (MA)

        +

        The pyaqsapi.byma module exports the following functions:

        +
        * byma.qa_annualpeferomanceeval,
+* byma.qa_annualperformanceevaltransaction,
+* byma.qa_blanks,
+* byma.qa_collocated_assessments,
+* byma.qa_flowrateaudit,
+* byma.qa_flowrateverification,
+* byma.qa_one_point_qc,
+* byma.qa_pep_audit,
+* byma.transactionsample
+
        +
        +
        +
        Functions in this family of functions aggregate data at the state level.

        All functions accept the following variables:

        +
        +
        +
          +

        • parameter:

          • +

        • bdate:

          • +

        • edate:

          • +

        • stateFIPS:

          • +
        • +
          cbdate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata functions and +quarterlysummary functions).

          +
          +
          +
          • +
        • +
          cedate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +

        • return_header (optional): set to False by default.

          • +
        • +
          duration (optional): (This parameter is only used in conjunction with

          sampledata functions).

          +
          +
          +
          • +
        +
        +
        functions in this family of functions aggregate data at the Monitoring Agency

        (MA) level. All functions accept the following variables:

        +
        +
        +
          +

        • parameter:

          • +

        • bdate:

          • +

        • edate:

          • +

        • MA_code:

          • +
        • +
          cbdate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +
        • +
          cedate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +

        • return_header (optional): set to False by default.

          • +
        • +
          duration (optional): (This parameter is only used in conjunction with

          sampledata functions).

          +
          +
          +
          • +
        +
        +
        +

        Data Mart aggregate functions by Core Based Statistical Area (cbsa)

        +

        The pyaqsapi.bycbsa module exports the following functions:

        +
        * bycbsa.annualsummary,
+* bycbsa.dailysummary,
+* bycbsa.helperfunctions,
+* bycbsa.monitors,
+* bycbsa.quarterlysummary,
+* bycbsa.sampledata
+
        +
        +
        +
        Functions in this family of functions aggregate data at the Core Based

        Statistical Area (cbsa, as defined by the US Census Bureau) level. +All functions accept the following variables:

        +
        +
        +
          +

        • parameter:

          • +

        • bdate:

          • +

        • edate:

          • +

        • cbsa_code:

          • +
        • +
          cbdate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +
        • +
          cedate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +

        • return_header (optional): set to False by default.

          • +
        • +
          duration (optional): (This parameter is only used in conjunction with

          sampledata functions).

          +
          +
          +
          • +
        +
        +
        +

        Data Mart aggregate functions by Primary Quality Assurance Organization (pqao)

        +

        The pyaqsapi.bypqao module exports the following functions:

        +
        * bypqao.qa_annualperformanceeval,
+* bypqao.qa_annualperformanceevaltransaction,
+* bypqao.qa_blanks,
+* bypqao.qa_collocated_assessments,
+* bypqao.qa_flowrateaudit,
+* bypqao.qa_flowrateverification,
+* bypqao.qa_one_point_qc,
+* bypqao.qa_pep_audit
+
        +
        +
        +
        Functions in this family of functions aggregate data at the Primary Quality

        Assurance Organization (pqao) level. All functions accept the following +variables:

        +
        +
        +
          +

        • parameter:

          • +

        • bdate:

          • +

        • edate:

          • +

        • pqao_code:

          • +

        • return_header (optional): set to False by default.

          • +
        +
        +
        +

        Data Mart aggregate functions by latitude/longitude bounding box (bybox)

        +

        The pyaqsapi.bybox module exports the following functions:

        +
        * bybox.annualsummary,
+* bybox.dailysummary,
+* bybox.helperfunctions,
+* bybox.monitors,
+* bybox.quarterlysummary,
+* bybox.sampledata
+
        +
        +
        +
        Functions in this family of functions aggregate data by a

        latitude/longitude bounding box (bybox) level. All functions accept the +following variables:

        +
        +
        +
          +

        • parameter:

          • +

        • bdate:

          • +

        • edate:

          • +

        • minlat:

          • +

        • minlon:

          • +

        • maxlon:

          • +

        • maxlat:

          • +
        • +
          cbdate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +
        • +
          cedate (optional): (This parameter is only used in conjunction with

          sampledata, dailysummary, +annualdata and +quarterlysummary functions).

          +
          +
          +
          • +

        • return_header (optional): set to False by default.

          • +
        • +
          duration (optional): (This parameter is only used in conjunction with

          sampledata functions).

          +
          +
          +
          • +
        +
        +
        +

        pyaqsapi Miscellaneous functions

        +

        These are miscellaneous functions exported by pyaqsapi.

        +

        aqs_removeheader is the function that the pyaqsapi library +uses internally to coerce an AQSAPI_V2 object into a pandas DataFrame. +This is useful if the user saves the output from another pyaqsapi function +with return_header = True set but later decides that they want just a +simple pandas DataFrame object. This function takes only one variable:

        +
          +

        • AQSobject:

          • +
        +
        +
        + + +
        +
        +
        + +
        + +
        +

        © Copyright 2024, US Environmental Protection Agency.

        +
        + + Built with Sphinx using a + theme + provided by Read the Docs. + + +
        +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv index ef58cef..1022a93 100644 Binary files a/docs/_build/html/objects.inv and b/docs/_build/html/objects.inv differ diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html deleted file mode 100644 index 4b6538f..0000000 --- a/docs/_build/html/py-modindex.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - Python Module Index — pyaqsapi documentation - - - - - - - - - - - - - - - - - - - - -
        - - -
        - -
        -
        -
        -
          -
          • -
        • Python Module Index
          • -
        • -
          • -
        -
        -
        -
        -
        - - -

        Python Module Index

        - -
        - p -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
         
        - p
        - pyaqsapi -
            - pyaqsapi.bybox -
            - pyaqsapi.bybox.bybox -
            - pyaqsapi.bycbsa -
            - pyaqsapi.bycbsa.bycbsa -
            - pyaqsapi.bycounty -
            - pyaqsapi.bycounty.bycounty -
            - pyaqsapi.byma -
            - pyaqsapi.byma.byma -
            - pyaqsapi.bypqao -
            - pyaqsapi.bypqao.bypqao -
            - pyaqsapi.bysite -
            - pyaqsapi.bysite.bysite -
            - pyaqsapi.bystate -
            - pyaqsapi.bystate.bystate -
            - pyaqsapi.helperfunctions -
            - pyaqsapi.listfunctions -
            - pyaqsapi.metadatafunctions -
            - pyaqsapi.setupfunctions -
        - - -
        -
        -
        - -
        - -
        -

        © Copyright 2024, US Environmental Protection Agency.

        -
        - - Built with Sphinx using a - theme - provided by Read the Docs. - - -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/_build/html/pyaqsapi.bybox.html b/docs/_build/html/pyaqsapi.bybox.html deleted file mode 100644 index 129efd8..0000000 --- a/docs/_build/html/pyaqsapi.bybox.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - pyaqsapi.bybox package — pyaqsapi documentation - - - - - - - - - - - - - - - - - -
        - - -
        - -
        -
        -
        - -
        -
        -
        -
        - -
        -

        pyaqsapi.bybox package

        -
        -

        Submodules

        -
        -
        -

        pyaqsapi.bybox.bybox module

        -

        Functions that aggregate data by box. -(by latitude/longitude bounding box).

        -
        -
        -pyaqsapi.bybox.bybox.annualsummary(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated by latitude/longitude -bounding box (_by_box).

        -

        Annual summary contains a DataFrame matching the input parameter for the -rectangular area area bounded by minlat, maxlat, minlon, maxlon provided -for bdate - edate time frame. Variables returned include mean value, maxima, -percentiles, and etc.

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object) sample data for all monitors
        -
        within the input latitude/longitude bounding box for a single parameter.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bybox.bybox.dailysummary(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of daily summary data aggregated by latitude/longitude -bounding box (_by_box).

        -

        Daily summary contains a DataFrame matching the input parameter and -stateFIPS provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): daily summary data for all
        -
        monitors within the input latitude/longitude bounding box for a single
        -
        parameter.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bybox.bybox.monitors(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -

        Return a table of monitors and related metadata sites with the provided -parameter, aggregated by latitude/longitude bounding box (_by_box) for -bdate - edate time frame.

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        pandas DataFrame or an AQSAPI_V2 object

        Returns a table of monitors from a latitude/longitude bounding -box (_by_box).

        -
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bybox.bybox.quarterlysummary(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, duration=None, return_header=False)
        -

        Return a DataFrame of quarterly data aggregate by latitude/longitude -bounding box (_by_box).

        -

        Quarterly summary contains a DataFrame matching the input parameter, -stateFIPS and county_code provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): daily summary data for all
        -
        monitors within the input latitude/longitude bounding box for a single
        -
        parameter.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bybox.bybox.sampledata(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, duration=None, return_header=False)
        -

        Return sample data where the data is aggregated by latitude/longitude -bounding box (_by_box).

        -

        If return_header is FALSE (default) this function -returns a single DataFrame with the requested data. If return_header is -TRUE returns a list of AQSAPI_v2 objects

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a -specific sample duration. The default value of None results -in no filtering based on duration code.Valid durations -include actual sample durations and not calculated durations -such as 8 hour carbon monoxide or ozone rolling averages, -3/6 day PM averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        -
        - -
        -
        -

        Module contents

        -
        -
        - - -
        -
        -
        - -
        - -
        -

        © Copyright 2024, US Environmental Protection Agency.

        -
        - - Built with Sphinx using a - theme - provided by Read the Docs. - - -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/_build/html/pyaqsapi.bycbsa.html b/docs/_build/html/pyaqsapi.bycbsa.html deleted file mode 100644 index 9967c7a..0000000 --- a/docs/_build/html/pyaqsapi.bycbsa.html +++ /dev/null @@ -1,373 +0,0 @@ - - - - - - - pyaqsapi.bycbsa package — pyaqsapi documentation - - - - - - - - - - - - - - - - - -
        - - -
        - -
        -
        -
        - -
        -
        -
        -
        - -
        -

        pyaqsapi.bycbsa package

        -
        -

        Submodules

        -
        -
        -

        pyaqsapi.bycbsa.bycbsa module

        -

        Functions that aggregate data by cbsa -(by Core Based Statistic Area, as defined by the Census Bureau).

        -
        -
        -pyaqsapi.bycbsa.bycbsa.annualsummary(parameter, bdate, edate, cbsa_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated at the Core Based -Statistical Area (cbsa) level.

        -

        Annual summary contains a DataFrame matching the input parameter and -cbsa_code provided for bdate - edate time frame. Variables returned include -mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros)

        -
        -
        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): a DataFrame or an
        -
        AQS_Data Mart_APIv2 object that containing annual summary data for the
        -
        cbsa_code requested.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycbsa.bycbsa.dailysummary(parameter, bdate, edate, cbsa_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of data aggregated by Core Based Statistical Area -(cbsa).

        -

        Daily summary contains a DataFrame matching the input parameter and -cbsa_code provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros)

        -
        -
        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): a DataFrame or an
        -
        AQS_Data Mart_APIv2 object that containing daily summary data for
        -
        the cbsa_code requested.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycbsa.bycbsa.monitors(parameter, bdate, edate, cbsa_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -

        Return a table of monitors at all sites with the provided parameter, -aggregated by Core Based Statistical Area (CBSA) 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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros)

        -
        -
        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 at a site.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycbsa.bycbsa.quarterlysummary(parameter, bdate, edate, cbsa_code, cbdate=None, cedate=None, return_header=False)
        -

        Return quarterly summary data aggregated by Core Based Statistical Area -(cbsa_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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros).

        -
        -
        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.

        -
        -
        Example
        -
        -------
        -
        Return a DataFrame of NO2 quarterly summary
        -
        data the for Charlotte-Concord-Gastonia, NC cbsa for
        -
        each quarter in 2017.::

        import pyaqsapi as aqs -from datetime import date -... -aqs.bycbsa.quarterlysummary(parameter="42602",

        -
        -

        bdate=date(year=2017, month=1, day=1), -edate=date(year=2017, month=1, day=1), -cbsa_code="16740")

        -
        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): quarterly summary statistics for
        -
        the given parameter for a all monitors with matching parameter and
        -
        cbsa_code combination within the bdate - edate timeframe.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycbsa.bycbsa.sampledata(parameter, bdate, edate, cbsa_code, duration=None, cbdate=None, cedate=None, return_header=False)
        -

        Return sample data where the data is aggregated at the Core Based -Statistical Area (cbsa) level.

        -
        -
        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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros)

        -
        -
        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.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a specific -sample duration. The default value of None results in -no filtering based on duration code.Valid durations include -actual sample durations and not calculated durations such as 8 -hour carbon monoxide or ozone rolling averages, 3/6 day PM -averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): sample data for all monitors
        -
        matching cbsa_code for the given parameter.
        -
        -
        -
        -
        - -
        -
        -

        Module contents

        -
        -
        - - -
        -
        -
        - -
        - -
        -

        © Copyright 2024, US Environmental Protection Agency.

        -
        - - Built with Sphinx using a - theme - provided by Read the Docs. - - -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/_build/html/pyaqsapi.bycounty.html b/docs/_build/html/pyaqsapi.bycounty.html deleted file mode 100644 index be4ee53..0000000 --- a/docs/_build/html/pyaqsapi.bycounty.html +++ /dev/null @@ -1,861 +0,0 @@ - - - - - - - pyaqsapi.bycounty package — pyaqsapi documentation - - - - - - - - - - - - - - - - - -
        - - -
        - -
        -
        -
        - -
        -
        -
        -
        - -
        -

        pyaqsapi.bycounty package

        -
        -

        Submodules

        -
        -
        -

        pyaqsapi.bycounty.bycounty module

        -

        Functions that aggregate data by county.

        -
        -
        -pyaqsapi.bycounty.bycounty.annualsummary(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated at the county level.

        -

        Annual summary contains a DataFrame matching the input parameter, -stateFIPS and county_code provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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.

        -
        -
        Example
        -
        -------
        -
        Returns all FRM/FEM PM2.5 data for Wake County, NC between
        -
        January 1, 2015 - February 28, 2016::

        import pyaqsapi as aqs -from datetime import date -... -aqs.bycounty.annualsummary(parameter="88101",

        -
        -
        -
        bdate=date(year=2016,

        month=1, -day=1),

        -
        -
        edate=date(year=2016,

        month=2, -day=28),

        -
        -
        -

        stateFIPS="37", -countycode="183", -return_header=True)

        -
        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): annual summary data for the
        -
        requested stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.dailysummary(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of data aggregated at the county level.

        -

        Daily summary contains a DataFrame matching the input parameter, stateFIPS -and county_code provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): blank quality assurance data for
        -
        the requested stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.monitors(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -

        Return a table of monitors and related metadata at sites with the provided -parameter, stateFIPS and county_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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): monitors from
        -
        the selected stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_annualperformanceeval(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return quality assurance performance evaluation data - aggregated by -site for a parameter code aggregated by matching input -parameter, stateFIPS and countycode 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 all monitoring sites for the
        -
        matching countycode and stateFIPS requested for the time frame
        -
        between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_annualperformanceevaltransaction(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Returns AQS submissions transaction format (RD) of the annual -performance evaluation data (raw). Includes data pairs for -QA - aggregated by county for a parameter code aggregated by matching -input parameter, countycode and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 all monitoring sites with matching
        -
        countycode and stateFIPS requested for the time frame
        -
        between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_blanks(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        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 at the county level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): blank quality assurance data for
        -
        the requested stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_collocated_assessments(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of collocated assessment data aggregated by matching input -parameter, stateFIPS and county_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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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
        -
        collocated assessment data for monitors within a county.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_flowrateaudit(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return Quality assurance flowrate audit data.

        -

        Return a table containing flow rate audit data aggregated by parameter -code, stateFIPS and countycode 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_flowrateverification(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing flow rate Verification data for a parameter code -aggregated matching input parameter, stateFIPS, and county_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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 county.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_one_point_qc(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing flow rate audit data aggregated by parameter -code, stateFIPS and countycode 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_pep_audit(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing quality assurance Performance Evaluation Program -(PEP) audit data aggregated by parameter code, stateFIPS and countycode 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 Program (PEP) audit data for the requested stateFIPS and county
        -
        combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.quarterlysummary(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of quarterly data aggregated at the county level.

        -

        Quarterly summary contains a DataFrame matching the input parameter, -stateFIPS and county_code provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): quarterly summary statistics for
        -
        the given parameter for a single countycode and stateFIPS combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.sampledata(parameter, bdate, edate, stateFIPS, countycode, duration=None, cbdate=None, cedate=None, return_header=False)
        -

        Returns sample data where the data is aggregated at the county level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a specific -sample duration. The default value of None results in -no filtering based on duration code.Valid durations include -actual sample durations and not calculated durations such as 8 -hour carbon monoxide or ozone rolling averages, 3/6 day PM -averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

        -
        -
        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.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a -specific sample duration. The default value of None results -in no filtering based on duration code.Valid durations -include actual sample durations and not calculated durations -such as 8 hour carbon monoxide or ozone rolling averages, -3/6 day PM averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

        -
        -
        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 Program (PEP) audit data for the requested stateFIPS and county
        -
        combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.transactionsample(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return transactionsample data - aggregated by county in the AQS Submission -Transaction Format (RD) sample (raw) data for a parameter code aggregated -by matching input parameter, stateFIPS and countycode provided for -bdate - edate time frame. Includes data both in submitted and -standard units.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): transaction sample (raw) data
        -
        in the AQS submission transaction format (RD) corresponding to the inputs
        -
        provided.
        -
        -
        -
        -
        - -
        -
        -

        Module contents

        -
        -
        - - -
        -
        -
        - -
        - -
        -

        © Copyright 2024, US Environmental Protection Agency.

        -
        - - Built with Sphinx using a - theme - provided by Read the Docs. - - -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/_build/html/pyaqsapi.byma.html b/docs/_build/html/pyaqsapi.byma.html deleted file mode 100644 index 8436d30..0000000 --- a/docs/_build/html/pyaqsapi.byma.html +++ /dev/null @@ -1,517 +0,0 @@ - - - - - - - pyaqsapi.byma package — pyaqsapi documentation - - - - - - - - - - - - - - - - - -
        - - -
        - -
        -
        -
        - -
        -
        -
        -
        - -
        -

        pyaqsapi.byma package

        -
        -

        Submodules

        -
        -
        -

        pyaqsapi.byma.byma module

        -

        Functions that aggregate data by ma (By Monitoring Agency).

        -
        -
        -pyaqsapi.byma.byma.qa_annualpeferomanceeval(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Returns quality assurance performance evaluation data - aggregated by -by Monitoring agency (MA) for a parameter code aggregated by matching input -parameter and MA_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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 all monitoring sites for with the MA_code requested
        -
        for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_annualperformanceevaltransaction(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Returns AQS submissions transaction format (RD) of the annual performance -evaluation data (raw). Includes data pairs for QA - aggregated by -Monitoring agency (MA) for a parameter code aggregated by matching input -parameter and MA_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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 in the AQS submissions transaction format (RD)for all sites
        -
        matching the MA_code requested for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_blanks(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        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 monitoring -agency code (MA_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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 sample
        -
        data for all monitors within the input MA_code.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_collocated_assessments(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of collocated assessment data aggregated by matching input -parameter, and monitoring agency (MA) 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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 collocated
        -
        assessment data for monitors within a monitoring agency.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_flowrateaudit(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return Quality assurance flowrate audit data.

        -

        Return a table containing flow rate audit data aggregated by parameter -code and monitoring agency code (_by_MA) 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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 MA_code.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_flowrateverification(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing flow rate Verification data for a parameter code -aggregated by matching input parameter, and monitoring agency (MA) 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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 MA_code.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_one_point_qc(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table one point QC check data aggregated by monitoring agency -code (_by_MA).

        -
        -
        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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 MA_code.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_pep_audit(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of Performance Evaluation Program (PEP) audit data -aggregated by monitoring agency code (_by_MA) 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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 monitoring agency.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.transactionsample(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return transactionsample data - aggregated by Monitoring agency (MA) in -the AQS Submission Transaction Format (RD) sample (raw) data for a -parameter code aggregated by matching input parameter, and monitoring -agency (MA) code provided for bdate - edate time frame. Includes data both -in submitted and standard units.

        -
        -
        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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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): transaction sample (raw) data in
        -
        the AQS submission transaction format (RD) corresponding to the inputs
        -
        provided.
        -
        -
        -
        -
        - -
        -
        -

        Module contents

        -
        -
        - - -
        -
        -
        - -
        - -
        -

        © Copyright 2024, US Environmental Protection Agency.

        -
        - - Built with Sphinx using a - theme - provided by Read the Docs. - - -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/_build/html/pyaqsapi.bypqao.html b/docs/_build/html/pyaqsapi.bypqao.html deleted file mode 100644 index 6684486..0000000 --- a/docs/_build/html/pyaqsapi.bypqao.html +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - - pyaqsapi.bypqao package — pyaqsapi documentation - - - - - - - - - - - - - - - - - -
        - - -
        - -
        -
        -
        - -
        -
        -
        -
        - -
        -

        pyaqsapi.bypqao package

        -
        -

        Submodules

        -
        -
        -

        pyaqsapi.bypqao.bypqao module

        -

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

        -
        -
        -pyaqsapi.bypqao.bypqao.qa_annualperformanceeval(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_annualperformanceevaltransaction(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        Returns 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
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_blanks(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_collocated_assessments(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_flowrateaudit(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_flowrateverification(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_one_point_qc(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_pep_audit(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -

        Module contents

        -
        -
        - - -
        -
        -
        - -
        - -
        -

        © Copyright 2024, US Environmental Protection Agency.

        -
        - - Built with Sphinx using a - theme - provided by Read the Docs. - - -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/_build/html/pyaqsapi.bysite.html b/docs/_build/html/pyaqsapi.bysite.html deleted file mode 100644 index 127ba0e..0000000 --- a/docs/_build/html/pyaqsapi.bysite.html +++ /dev/null @@ -1,881 +0,0 @@ - - - - - - - pyaqsapi.bysite package — pyaqsapi documentation - - - - - - - - - - - - - - - - - -
        - - -
        - -
        -
        -
        - -
        -
        -
        -
        - -
        -

        pyaqsapi.bysite package

        -
        -

        Submodules

        -
        -
        -

        pyaqsapi.bysite.bysite module

        -

        pyaqsapi Functions that aggregate data by site.

        -
        -
        -pyaqsapi.bysite.bysite.annualsummary(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated at the site level.

        -

        Annual summary contains a DataFrame matching the input parameter, -stateFIPS, county_code, and sitenum provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): annual summary data for the
        -
        sitenum, countycode and stateFIPS requested for the time frame between
        -
        bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.dailysummary(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of data aggregated at the site level.

        -

        Daily summary contains a DataFrame matching the input parameter, stateFIPS, -county_code, and sitenum provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): daily summary data for the
        -
        sitenum, countycode and stateFIPS requested for the time frame between
        -
        bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.monitors(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -
        -
        Return a table of monitors and related metadata at sites

        with the provided parameter, stateFIPS, county_code, and sitenum -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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): monitors from
        -
        the selected site.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_annualpeferomanceeval(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return quality assurance performance evaluation data - aggregated by -site for a parameter code aggregated by matching input -parameter, sitenum, countycode and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_annualperformanceevaltransaction(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Returns AQS submissions transaction format (RD) of the annual -performance evaluation data (raw). Includes data pairs for -QA - aggregated by site for a parameter code aggregated by matching -input parameter, sitenum, countycode and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_blanks(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        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 at the site level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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
        -
        sample data for single monitoring site for the sitenum, countycode and
        -
        stateFIPS requested for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_collocated_assessments(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of collocated assessment data aggregated by matching -input parameter, stateFIPS, county_code, and sitenum 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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 collocated
        -
        assessment data for monitors within a site.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_flowrateaudit(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return Quality assurance flowrate audit data.

        -

        Return a table containing flow rate audit data aggregated by -parameter code, stateFIPS, countycode and site number 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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 sitenum, countycode and stateFIPS for the time
        -
        period between bdate - edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_flowrateverification(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of containing flow rate verification data aggregated by -matching input parameter, stateFIPS, county_code, and sitenum 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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 at a site.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_one_point_qc(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of one point QC raw data aggregated -by parameter code, stateFIPS, countycode and site number.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): for the requested sitenum,
        -
        countycode and stateFIPS for the time period between bdate - edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_pep_audit(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of Performance Evaluation Program (PEP) audit -data aggregated by parameter code, stateFIPS, countycode and -site number 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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 within a stateFIPS, countycode and sitenum
        -
        for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.quarterlysummary(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of quarterly data aggregated at the site level.

        -

        Quarterly summary contains a DataFrame matching the input parameter, -stateFIPS, county_code, and sitenum provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): quarterly summary statistics for
        -
        the given parameter for a single countycode and stateFIPS combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.sampledata(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, duration=None, return_header=False)
        -

        Returns sample data where the data is aggregated at the site level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a -specific sample duration. The default value of None results -in no filtering based on duration code.Valid durations -include actual sample durations and not calculated durations -such as 8 hour carbon monoxide or ozone rolling averages, -3/6 day PM averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): sample data aggregated at the
        -
        site level matching the input stateFIPS, countycode and sitenum
        -
        for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.transactionsample(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of Returns transactionsample data aggregated by site -in the AQS Submission Transaction Format (RD) sample (raw) data aggregated -by matching input parameter, stateFIPS, county_code, and sitenum 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): transaction sample
        -
        (raw) data in the AQS submission transaction format (RD)
        -
        corresponding to the inputs provided.
        -
        -
        -
        -
        - -
        -
        -

        Module contents

        -
        -
        - - -
        -
        -
        - -
        - -
        -

        © Copyright 2024, US Environmental Protection Agency.

        -
        - - Built with Sphinx using a - theme - provided by Read the Docs. - - -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/_build/html/pyaqsapi.bystate.html b/docs/_build/html/pyaqsapi.bystate.html deleted file mode 100644 index 6201fb7..0000000 --- a/docs/_build/html/pyaqsapi.bystate.html +++ /dev/null @@ -1,773 +0,0 @@ - - - - - - - pyaqsapi.bystate package — pyaqsapi documentation - - - - - - - - - - - - - - - - - -
        - - -
        - -
        -
        -
        - -
        -
        -
        -
        - -
        -

        pyaqsapi.bystate package

        -
        -

        Submodules

        -
        -
        -

        pyaqsapi.bystate.bystate module

        -

        Functions that aggregated data by state.

        -
        -
        -pyaqsapi.bystate.bystate.annualsummary(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated at the state level.

        -

        Annual summary contains a DataFrame matching the input parameter and -stateFIPS provided for bdate - edate time frame. Variables returned include -mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): annual summary data for the
        -
        stateFIPS requested.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.dailysummary(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of data aggregated at the state level.

        -

        Daily summary contains a DataFrame matching the input parameter and -stateFIPS provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): daily summary statistics for the
        -
        given parameter for a single stateFIPS.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.monitors(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -

        Return a table of monitors and related metadata at all sites -with the provided parameter and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): monitors from the

        selected state.

        -
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_annualperformanceeval(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return quality assurance performance evaluation data - aggregated by -site for a parameter code aggregated by matching input -parameter, and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 all monitoring sites for the
        -
        matching parameter and stateFIPS requested for the time frame
        -
        between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_annualperformanceevaltransaction(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return AQS submissions transaction format (RD) of the annual -performance evaluation data (raw). Includes data pairs for -QA - aggregated by county for a parameter code aggregated by matching -input parameter and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 all monitoring sites with matching
        -
        parameter and stateFIPS requested for the time frame
        -
        between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_blanks(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        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 at the state -level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 sample
        -
        data for all monitors within the input stateFIPS.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_collocated_assessments(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of collocated assessment data aggregated by matching input -parameter and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 collocated
        -
        assessment data for monitors within a state.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_flowrateaudit(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return Quality assurance flowrate audit data.

        -

        Return a table of monitors and related metadata at all sites -with the provided parameter and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): monitors from the

        selected state.

        -
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_flowrateverification(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing flow rate Verification data for a parameter code -aggregated matching input parameter, and stateFIPS, 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 state.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_one_point_qc(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame or an AQS_Data Mart_APIv2 S3 object containing Quality -assurance data - flow rate audit raw data aggregated by state FIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 the
        -
        input stateFIPS for bdate - edate time frame..
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_pep_audit(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of Performance Evaluation Program (PEP) audit data -aggregated by parameter code, and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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
        -
        within a state.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.quarterlysummary(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of quarterly data aggregated at the state level.

        -

        Quarterly summary contains a DataFrame matching the input parameter, -stateFIPS a provided for bdate - edate time frame. Variables returned -include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): quarterly summary statistics for
        -
        the given parameter for a all monitors with matching parameter and
        -
        stateFIPS combination within the bdate - edate timeframe.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.sampledata(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, duration=None, return_header=False)
        -

        Return sample data where the data is aggregated at the state level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a -specific sample duration. The default value of None results -in no filtering based on duration code.Valid durations -include actual sample durations and not calculated durations -such as 8 hour carbon monoxide or ozone rolling averages, -3/6 day PM averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): containing sample data
        -
        for all monitors matching stateFIPS for the given parameter.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.transactionsample(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return transactionsample data - aggregated by state in the AQS Submission -Transaction Format (RD) sample (raw) data for a parameter code aggregated -by matching input parameter, and stateFIPS provided for bdate - edate time -frame. Includes data both in submitted and standard units.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): transaction sample (raw) data
        -
        in the AQS submission transaction format (RD) corresponding to the inputs
        -
        provided.
        -
        -
        -
        -
        - -
        -
        -

        Module contents

        -
        -
        - - -
        -
        -
        - -
        - -
        -

        © Copyright 2024, US Environmental Protection Agency.

        -
        - - Built with Sphinx using a - theme - provided by Read the Docs. - - -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/_build/html/pyaqsapi.html b/docs/_build/html/pyaqsapi.html deleted file mode 100644 index 779233c..0000000 --- a/docs/_build/html/pyaqsapi.html +++ /dev/null @@ -1,4213 +0,0 @@ - - - - - - - pyaqsapi package — pyaqsapi documentation - - - - - - - - - - - - - - - - - -
        - - -
        - -
        -
        -
        - -
        -
        -
        -
        - -
        -

        pyaqsapi package

        -
        -

        Submodules

        -
        -

        pyaqsapi.bybox.bybox module

        -

        Functions that aggregate data by box. -(by latitude/longitude bounding box).

        -
        -
        -pyaqsapi.bybox.bybox.annualsummary(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated by latitude/longitude -bounding box (_by_box).

        -

        Annual summary contains a DataFrame matching the input parameter for the -rectangular area area bounded by minlat, maxlat, minlon, maxlon provided -for bdate - edate time frame. Variables returned include mean value, maxima, -percentiles, and etc.

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object) sample data for all monitors
        -
        within the input latitude/longitude bounding box for a single parameter.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bybox.bybox.dailysummary(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of daily summary data aggregated by latitude/longitude -bounding box (_by_box).

        -

        Daily summary contains a DataFrame matching the input parameter and -stateFIPS provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): daily summary data for all
        -
        monitors within the input latitude/longitude bounding box for a single
        -
        parameter.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bybox.bybox.monitors(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -

        Return a table of monitors and related metadata sites with the provided -parameter, aggregated by latitude/longitude bounding box (_by_box) for -bdate - edate time frame.

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        pandas DataFrame or an AQSAPI_V2 object

        Returns a table of monitors from a latitude/longitude bounding -box (_by_box).

        -
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bybox.bybox.quarterlysummary(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, duration=None, return_header=False)
        -

        Return a DataFrame of quarterly data aggregate by latitude/longitude -bounding box (_by_box).

        -

        Quarterly summary contains a DataFrame matching the input parameter, -stateFIPS and county_code provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): daily summary data for all
        -
        monitors within the input latitude/longitude bounding box for a single
        -
        parameter.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bybox.bybox.sampledata(parameter, bdate, edate, minlat, maxlat, minlon, maxlon, cbdate=None, cedate=None, duration=None, return_header=False)
        -

        Return sample data where the data is aggregated by latitude/longitude -bounding box (_by_box).

        -

        If return_header is FALSE (default) this function -returns a single DataFrame with the requested data. If return_header is -TRUE returns a list of AQSAPI_v2 objects

        -
        -
        Parameters:
        -
        -
        parametera 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.

        -
        -
        minlata python character object which represents the minimum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data north of this latitude will be returned.

        -
        -
        maxlata python character object which represents the maximum latitude

        of a geographic box. Decimal latitude with north begin positive. -Only data south of this latitude will be returned.

        -
        -
        minlona python character object which represents the minimum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data east of this longitude will be returned.

        -
        -
        maxlona python character object which represents the maximum longitude

        of a geographic box. Decimal longitude with east begin positive. -Only data west of this longitude will be returned. Note that -80 -is less than -70.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a -specific sample duration. The default value of None results -in no filtering based on duration code.Valid durations -include actual sample durations and not calculated durations -such as 8 hour carbon monoxide or ozone rolling averages, -3/6 day PM averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.bycbsa.bycbsa module

        -

        Functions that aggregate data by cbsa -(by Core Based Statistic Area, as defined by the Census Bureau).

        -
        -
        -pyaqsapi.bycbsa.bycbsa.annualsummary(parameter, bdate, edate, cbsa_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated at the Core Based -Statistical Area (cbsa) level.

        -

        Annual summary contains a DataFrame matching the input parameter and -cbsa_code provided for bdate - edate time frame. Variables returned include -mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros)

        -
        -
        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): a DataFrame or an
        -
        AQS_Data Mart_APIv2 object that containing annual summary data for the
        -
        cbsa_code requested.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycbsa.bycbsa.dailysummary(parameter, bdate, edate, cbsa_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of data aggregated by Core Based Statistical Area -(cbsa).

        -

        Daily summary contains a DataFrame matching the input parameter and -cbsa_code provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros)

        -
        -
        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): a DataFrame or an
        -
        AQS_Data Mart_APIv2 object that containing daily summary data for
        -
        the cbsa_code requested.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycbsa.bycbsa.monitors(parameter, bdate, edate, cbsa_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -

        Return a table of monitors at all sites with the provided parameter, -aggregated by Core Based Statistical Area (CBSA) 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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros)

        -
        -
        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 at a site.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycbsa.bycbsa.quarterlysummary(parameter, bdate, edate, cbsa_code, cbdate=None, cedate=None, return_header=False)
        -

        Return quarterly summary data aggregated by Core Based Statistical Area -(cbsa_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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros).

        -
        -
        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.

        -
        -
        Example
        -
        -------
        -
        Return a DataFrame of NO2 quarterly summary
        -
        data the for Charlotte-Concord-Gastonia, NC cbsa for
        -
        each quarter in 2017.::

        import pyaqsapi as aqs -from datetime import date -... -aqs.bycbsa.quarterlysummary(parameter="42602",

        -
        -

        bdate=date(year=2017, month=1, day=1), -edate=date(year=2017, month=1, day=1), -cbsa_code="16740")

        -
        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): quarterly summary statistics for
        -
        the given parameter for a all monitors with matching parameter and
        -
        cbsa_code combination within the bdate - edate timeframe.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycbsa.bycbsa.sampledata(parameter, bdate, edate, cbsa_code, duration=None, cbdate=None, cedate=None, return_header=False)
        -

        Return sample data where the data is aggregated at the Core Based -Statistical Area (cbsa) level.

        -
        -
        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.

        -
        -
        cbsa_code: a python character object which represents the 5 digit AQS Core

        Based Statistical Area code (the same as the census code, with -leading zeros)

        -
        -
        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.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a specific -sample duration. The default value of None results in -no filtering based on duration code.Valid durations include -actual sample durations and not calculated durations such as 8 -hour carbon monoxide or ozone rolling averages, 3/6 day PM -averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): sample data for all monitors
        -
        matching cbsa_code for the given parameter.
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.bycounty.bycounty module

        -

        Functions that aggregate data by county.

        -
        -
        -pyaqsapi.bycounty.bycounty.annualsummary(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated at the county level.

        -

        Annual summary contains a DataFrame matching the input parameter, -stateFIPS and county_code provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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.

        -
        -
        Example
        -
        -------
        -
        Returns all FRM/FEM PM2.5 data for Wake County, NC between
        -
        January 1, 2015 - February 28, 2016::

        import pyaqsapi as aqs -from datetime import date -... -aqs.bycounty.annualsummary(parameter="88101",

        -
        -
        -
        bdate=date(year=2016,

        month=1, -day=1),

        -
        -
        edate=date(year=2016,

        month=2, -day=28),

        -
        -
        -

        stateFIPS="37", -countycode="183", -return_header=True)

        -
        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): annual summary data for the
        -
        requested stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.dailysummary(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of data aggregated at the county level.

        -

        Daily summary contains a DataFrame matching the input parameter, stateFIPS -and county_code provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): blank quality assurance data for
        -
        the requested stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.monitors(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -

        Return a table of monitors and related metadata at sites with the provided -parameter, stateFIPS and county_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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): monitors from
        -
        the selected stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_annualperformanceeval(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return quality assurance performance evaluation data - aggregated by -site for a parameter code aggregated by matching input -parameter, stateFIPS and countycode 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 all monitoring sites for the
        -
        matching countycode and stateFIPS requested for the time frame
        -
        between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_annualperformanceevaltransaction(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Returns AQS submissions transaction format (RD) of the annual -performance evaluation data (raw). Includes data pairs for -QA - aggregated by county for a parameter code aggregated by matching -input parameter, countycode and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 all monitoring sites with matching
        -
        countycode and stateFIPS requested for the time frame
        -
        between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_blanks(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        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 at the county level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): blank quality assurance data for
        -
        the requested stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_collocated_assessments(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of collocated assessment data aggregated by matching input -parameter, stateFIPS and county_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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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
        -
        collocated assessment data for monitors within a county.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_flowrateaudit(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return Quality assurance flowrate audit data.

        -

        Return a table containing flow rate audit data aggregated by parameter -code, stateFIPS and countycode 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_flowrateverification(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing flow rate Verification data for a parameter code -aggregated matching input parameter, stateFIPS, and county_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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 county.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_one_point_qc(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing flow rate audit data aggregated by parameter -code, stateFIPS and countycode 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 stateFIPS and county combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.qa_pep_audit(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing quality assurance Performance Evaluation Program -(PEP) audit data aggregated by parameter code, stateFIPS and countycode 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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 Program (PEP) audit data for the requested stateFIPS and county
        -
        combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.quarterlysummary(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of quarterly data aggregated at the county level.

        -

        Quarterly summary contains a DataFrame matching the input parameter, -stateFIPS and county_code provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): quarterly summary statistics for
        -
        the given parameter for a single countycode and stateFIPS combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.sampledata(parameter, bdate, edate, stateFIPS, countycode, duration=None, cbdate=None, cedate=None, return_header=False)
        -

        Returns sample data where the data is aggregated at the county level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a specific -sample duration. The default value of None results in -no filtering based on duration code.Valid durations include -actual sample durations and not calculated durations such as 8 -hour carbon monoxide or ozone rolling averages, 3/6 day PM -averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

        -
        -
        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.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a -specific sample duration. The default value of None results -in no filtering based on duration code.Valid durations -include actual sample durations and not calculated durations -such as 8 hour carbon monoxide or ozone rolling averages, -3/6 day PM averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

        -
        -
        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 Program (PEP) audit data for the requested stateFIPS and county
        -
        combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bycounty.bycounty.transactionsample(parameter, bdate, edate, stateFIPS, countycode, cbdate=None, cedate=None, return_header=False)
        -

        Return transactionsample data - aggregated by county in the AQS Submission -Transaction Format (RD) sample (raw) data for a parameter code aggregated -by matching input parameter, stateFIPS and countycode provided for -bdate - edate time frame. Includes data both in submitted and -standard units.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        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): transaction sample (raw) data
        -
        in the AQS submission transaction format (RD) corresponding to the inputs
        -
        provided.
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.byma.byma module

        -

        Functions that aggregate data by ma (By Monitoring Agency).

        -
        -
        -pyaqsapi.byma.byma.qa_annualpeferomanceeval(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Returns quality assurance performance evaluation data - aggregated by -by Monitoring agency (MA) for a parameter code aggregated by matching input -parameter and MA_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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 all monitoring sites for with the MA_code requested
        -
        for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_annualperformanceevaltransaction(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Returns AQS submissions transaction format (RD) of the annual performance -evaluation data (raw). Includes data pairs for QA - aggregated by -Monitoring agency (MA) for a parameter code aggregated by matching input -parameter and MA_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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 in the AQS submissions transaction format (RD)for all sites
        -
        matching the MA_code requested for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_blanks(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        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 monitoring -agency code (MA_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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 sample
        -
        data for all monitors within the input MA_code.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_collocated_assessments(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of collocated assessment data aggregated by matching input -parameter, and monitoring agency (MA) 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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 collocated
        -
        assessment data for monitors within a monitoring agency.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_flowrateaudit(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return Quality assurance flowrate audit data.

        -

        Return a table containing flow rate audit data aggregated by parameter -code and monitoring agency code (_by_MA) 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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 MA_code.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_flowrateverification(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing flow rate Verification data for a parameter code -aggregated by matching input parameter, and monitoring agency (MA) 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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 MA_code.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_one_point_qc(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table one point QC check data aggregated by monitoring agency -code (_by_MA).

        -
        -
        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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 MA_code.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.qa_pep_audit(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of Performance Evaluation Program (PEP) audit data -aggregated by monitoring agency code (_by_MA) 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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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 monitoring agency.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.byma.byma.transactionsample(parameter, bdate, edate, MA_code, cbdate=None, cedate=None, return_header=False)
        -

        Return transactionsample data - aggregated by Monitoring agency (MA) in -the AQS Submission Transaction Format (RD) sample (raw) data for a -parameter code aggregated by matching input parameter, and monitoring -agency (MA) code provided for bdate - edate time frame. Includes data both -in submitted and standard units.

        -
        -
        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.

        -
        -
        MA_codea python character object which represents the 4 digit AQS

        Monitoring Agency 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): transaction sample (raw) data in
        -
        the AQS submission transaction format (RD) corresponding to the inputs
        -
        provided.
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.bypqao.bypqao module

        -

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

        -
        -
        -pyaqsapi.bypqao.bypqao.qa_annualperformanceeval(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_annualperformanceevaltransaction(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        Returns 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
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_blanks(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_collocated_assessments(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_flowrateaudit(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_flowrateverification(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_one_point_qc(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bypqao.bypqao.qa_pep_audit(parameter, bdate, edate, pqao_code, cbdate=None, cedate=None, return_header=False)
        -

        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.
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.bysite.bysite module

        -

        pyaqsapi Functions that aggregate data by site.

        -
        -
        -pyaqsapi.bysite.bysite.annualsummary(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated at the site level.

        -

        Annual summary contains a DataFrame matching the input parameter, -stateFIPS, county_code, and sitenum provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): annual summary data for the
        -
        sitenum, countycode and stateFIPS requested for the time frame between
        -
        bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.dailysummary(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of data aggregated at the site level.

        -

        Daily summary contains a DataFrame matching the input parameter, stateFIPS, -county_code, and sitenum provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): daily summary data for the
        -
        sitenum, countycode and stateFIPS requested for the time frame between
        -
        bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.monitors(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -
        -
        Return a table of monitors and related metadata at sites

        with the provided parameter, stateFIPS, county_code, and sitenum -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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): monitors from
        -
        the selected site.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_annualpeferomanceeval(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return quality assurance performance evaluation data - aggregated by -site for a parameter code aggregated by matching input -parameter, sitenum, countycode and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_annualperformanceevaltransaction(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Returns AQS submissions transaction format (RD) of the annual -performance evaluation data (raw). Includes data pairs for -QA - aggregated by site for a parameter code aggregated by matching -input parameter, sitenum, countycode and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_blanks(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        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 at the site level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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
        -
        sample data for single monitoring site for the sitenum, countycode and
        -
        stateFIPS requested for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_collocated_assessments(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of collocated assessment data aggregated by matching -input parameter, stateFIPS, county_code, and sitenum 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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 collocated
        -
        assessment data for monitors within a site.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_flowrateaudit(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return Quality assurance flowrate audit data.

        -

        Return a table containing flow rate audit data aggregated by -parameter code, stateFIPS, countycode and site number 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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 sitenum, countycode and stateFIPS for the time
        -
        period between bdate - edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_flowrateverification(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of containing flow rate verification data aggregated by -matching input parameter, stateFIPS, county_code, and sitenum 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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 at a site.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_one_point_qc(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of one point QC raw data aggregated -by parameter code, stateFIPS, countycode and site number.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): for the requested sitenum,
        -
        countycode and stateFIPS for the time period between bdate - edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.qa_pep_audit(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of Performance Evaluation Program (PEP) audit -data aggregated by parameter code, stateFIPS, countycode and -site number 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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 within a stateFIPS, countycode and sitenum
        -
        for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.quarterlysummary(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of quarterly data aggregated at the site level.

        -

        Quarterly summary contains a DataFrame matching the input parameter, -stateFIPS, county_code, and sitenum provided for bdate - edate time frame. -Variables returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): quarterly summary statistics for
        -
        the given parameter for a single countycode and stateFIPS combination.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.sampledata(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, duration=None, return_header=False)
        -

        Returns sample data where the data is aggregated at the site level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a -specific sample duration. The default value of None results -in no filtering based on duration code.Valid durations -include actual sample durations and not calculated durations -such as 8 hour carbon monoxide or ozone rolling averages, -3/6 day PM averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): sample data aggregated at the
        -
        site level matching the input stateFIPS, countycode and sitenum
        -
        for the time frame between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bysite.bysite.transactionsample(parameter, bdate, edate, stateFIPS, countycode, sitenum, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of Returns transactionsample data aggregated by site -in the AQS Submission Transaction Format (RD) sample (raw) data aggregated -by matching input parameter, stateFIPS, county_code, and sitenum 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

        -
        -
        sitenuma python character object which represents the 4 digit site

        number (with leading zeros) within the county and state -being requested.

        -
        -
        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): transaction sample
        -
        (raw) data in the AQS submission transaction format (RD)
        -
        corresponding to the inputs provided.
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.bystate.bystate module

        -

        Functions that aggregated data by state.

        -
        -
        -pyaqsapi.bystate.bystate.annualsummary(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of annual data aggregated at the state level.

        -

        Annual summary contains a DataFrame matching the input parameter and -stateFIPS provided for bdate - edate time frame. Variables returned include -mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): annual summary data for the
        -
        stateFIPS requested.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.dailysummary(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of data aggregated at the state level.

        -

        Daily summary contains a DataFrame matching the input parameter and -stateFIPS provided for bdate - edate time frame. Variables -returned include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): daily summary statistics for the
        -
        given parameter for a single stateFIPS.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.monitors(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of monitors.

        -

        Return a table of monitors and related metadata at all sites -with the provided parameter and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): monitors from the

        selected state.

        -
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_annualperformanceeval(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return quality assurance performance evaluation data - aggregated by -site for a parameter code aggregated by matching input -parameter, and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 all monitoring sites for the
        -
        matching parameter and stateFIPS requested for the time frame
        -
        between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_annualperformanceevaltransaction(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return AQS submissions transaction format (RD) of the annual -performance evaluation data (raw). Includes data pairs for -QA - aggregated by county for a parameter code aggregated by matching -input parameter and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 all monitoring sites with matching
        -
        parameter and stateFIPS requested for the time frame
        -
        between bdate and edate.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_blanks(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        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 at the state -level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 sample
        -
        data for all monitors within the input stateFIPS.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_collocated_assessments(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of collocated assessment data aggregated by matching input -parameter and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 collocated
        -
        assessment data for monitors within a state.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_flowrateaudit(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return Quality assurance flowrate audit data.

        -

        Return a table of monitors and related metadata at all sites -with the provided parameter and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): monitors from the

        selected state.

        -
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_flowrateverification(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a table containing flow rate Verification data for a parameter code -aggregated matching input parameter, and stateFIPS, 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 state.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_one_point_qc(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame or an AQS_Data Mart_APIv2 S3 object containing Quality -assurance data - flow rate audit raw data aggregated by state FIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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 the
        -
        input stateFIPS for bdate - edate time frame..
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.qa_pep_audit(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a table of Performance Evaluation Program (PEP) audit data -aggregated by parameter code, and stateFIPS 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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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
        -
        within a state.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.quarterlysummary(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return a DataFrame of quarterly data aggregated at the state level.

        -

        Quarterly summary contains a DataFrame matching the input parameter, -stateFIPS a provided for bdate - edate time frame. Variables returned -include mean value, maxima, percentiles, and etc.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): quarterly summary statistics for
        -
        the given parameter for a all monitors with matching parameter and
        -
        stateFIPS combination within the bdate - edate timeframe.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.sampledata(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, duration=None, return_header=False)
        -

        Return sample data where the data is aggregated at the state level.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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.

        -
        -
        durationan optional python character string that represents the

        parameter duration code that limits returned data to a -specific sample duration. The default value of None results -in no filtering based on duration code.Valid durations -include actual sample durations and not calculated durations -such as 8 hour carbon monoxide or ozone rolling averages, -3/6 day PM averages or lead 3 month rolling averages. Use -aqs_sampledurations() for a list of all available -duration codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): containing sample data
        -
        for all monitors matching stateFIPS for the given parameter.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.bystate.bystate.transactionsample(parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False)
        -

        Return transactionsample data - aggregated by state in the AQS Submission -Transaction Format (RD) sample (raw) data for a parameter code aggregated -by matching input parameter, and stateFIPS provided for bdate - edate time -frame. Includes data both in submitted and standard units.

        -
        -
        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.

        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        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): transaction sample (raw) data
        -
        in the AQS submission transaction format (RD) corresponding to the inputs
        -
        provided.
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.helperfunctions module

        -

        helperfunctions.

        -
        -
        -class pyaqsapi.helperfunctions.AQSAPI_V2
        -

        Bases: object

        -
        -

        AQSAPI_V2 class used to store and retrieve data from the EPA AQS -Datamart API.

        -
        -

        # for some reason Sphinx does not like this Attributes section so it is -# commented out, for now.

        -

        # Attributes -# ---------- -# _header (pandas DataFrame): header information returned from the -# AQS Datamart API. -# _request_time (str): the time stamp that the call to the AQS Datamart -# API was received. -# _status (str): the status (associated with the _status_code) returned -# from a call to the AQS Datamart API. -# _status_code (str): the numeric status_code (represented as a string) -# that is returned from a call to the AQS Datamart API. -# _rows (str): the number of rows contained in the _data. -# _url (str): a string representing the URL used to make the AQS Datamart -# API call. -# _data (pandas DataFrame): the data returned from a call to the -# AQS Datamart API.

        -
        -
        -

        Methods

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

        set_data():

        set_header():

        get_data():

        get_header():

        get_status_code():

        get_header():

        get_url():

        get_header():

        get_request_time():

        -
        -
        -get_data()
        -

        Return the Data portion of the AQSAPI_V2 instance.

        -
        -
        Returns:
        -
        -
        (pandas DataFrame) a DataFrame containing the Data portion of the
        -
        AQSAPI_V2 instance.
        -
        -
        -
        -
        - -
        -
        -get_header()
        -

        Return the Header portion of the AQSAPI_V2 instance.

        -
        -
        Returns:
        -
        -
        (pandas DataFrame) a DataFrame containing the Header portion of the
        -
        AQSAPI_V2 instance.
        -
        -
        -
        -
        - -
        -
        -get_request_time()
        -

        Retrieve the time that the request to the AQS DataMart API was made.

        -
        -
        Returns:
        -
        -
        (str) A string representing the time that that request to the AQS
        -
        DataMart API was made.
        -
        -
        -
        -
        - -
        -
        -get_status_code()
        -

        Retrieve the status code from the API call.

        -
        -
        Returns:
        -
        -
        (str) A string representing the status code returned from the EPA
        -
        DataMart API.
        -
        -
        -
        -
        - -
        -
        -get_url()
        -

        Retrieve the URL of the AQS DataMart API request.

        -
        -
        Returns:
        -
        -
        (str) A string representing the status code returned from the EPA
        -
        DataMart API.
        -
        -
        -
        -
        - -
        -
        -set_data(Data)
        -

        Set the Data of a single AQSAPI_V2 object.

        -

        Data must be a pandas DataFrame.

        -
        -
        Warns:
        -
        -
        A warning is thrown if Data is not a pandas DataFrame
        -
        -
        -
        -
        - -
        -
        -set_header(Header)
        -

        Set the header of a single AQSAPI_V2 object. Header must be a -pandas DataFrame.

        -
        -
        Parameters:
        -
        -
        HeaderPandas DataFrame

        A pandas.DataFrame instance with the header information.

        -
        -
        -
        -
        Returns:
        -
        -
        None.
        -
        -
        -
        Warns:
        -
        -
        A warning is thrown if Header is not a pandas DataFrame
        -
        -
        -
        -
        - -
        - -
        -
        -pyaqsapi.helperfunctions.aqs_credentials(username=None, key=None)
        -

        Sets the user credentials for the AQS API. This function -needs to be called once and only once every time this library -is re-loaded. Users must have a valid username and key which -can be obtained through the use of the aqs_sign_up function, -use pyaqsapi.aqs_sign_up() to sign up for AQS data mart credentials.

        -
        -
        Parameters:
        -
        -
        usernamea python character object which represents the email account

        that will be used to connect to the AQS API.

        -
        -
        keythe key used in conjunction with the username given to connect to

        AQS Data Mart.

        -
        -
        -
        -
        Returns:
        -
        -
        None
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.helperfunctions.aqs_removeheader(aqsobject)
        -

        Coerces a single AQS_Data_Mart_APIv2 instance or a list of -AQS_Data_Mart_APIv2 instance into a single DataFrame object. -This function decouples the Data from the AQSAPI_v2 object and returns -only the Data portion as a DataFrame. If the input is a list of AQSAPI_v2 -objects combines the Data portion of each AQS_Data_Mart_APIv2 object -into a DataFrame with Header information discarded. -Else returns the input with no changes.

        -
        -
        Parameters:
        -
        -
        aqsobjectAn object of AQSAPI_v2 or a list of AQSAPI_v2 objects.
        -
        -
        -
        Returns:
        -
        -
        (DataFrame) A DataFrame containing the data portion of the AQSAPI_V2
        -
        object.
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.listfunctions module

        -

        listfunctions.

        -
        -
        -pyaqsapi.listfunctions.aqs_cbsas(return_header=False)
        -

        Return a table of all Core Based Statistical Areas (cbsa) and their -associated cbsa_codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): all cbsas and their associated
        -
        cbsa_codes.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_classes(return_header=False)
        -

        Return a table of Parameter classes (groups of parameters, i.e. "criteria" -or "all"). The information from this function can be used as input to other -API calls.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): Parameter classes (groups of
        -
        parameters, i.e. "criteria" or "all").
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_counties_by_state(stateFIPS, return_header=False)
        -

        Return a table of all counties in within the stateFIPS provided.

        -
        -
        Parameters:
        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): all counties in the requested
        -
        state.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_fields_by_service(service, return_header=False)
        -
        -
        Return a table containing the list and definitions of fields in the

        service requested.

        -
        -
        -
        -
        Parameters:
        -
        -
        servicea string which represents the services provided by the AQS

        API. For a list of available services refer to -https://aqs.epa.gov/aqsweb/documents/data_api.html#services

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): details the status of the AQS

        API.

        -
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_isavailable(return_header=False)
        -

        Return a table explaining the status of the AQS API.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): details the status of the AQS

        API.

        -
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_knownissues(return_header=False)
        -

        Return a table of any known issues with system functionality or the data. -These are usually issues that have been identified internally and will -require some time to correct in Data Mart or the API. This function -implements a direct API call to Data Mart and returns data directly from -the API. Issues returned via this function do not include any issues from -the pyaqsapi python package.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): information involving known
        -
        issues with the Data Mart API.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_mas(return_header=False)
        -

        Return a DataFrame of monitoring agencies (MA).

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): monitoring agencies and their
        -
        associated agency code.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_parameters_by_class(parameterclass, return_header=False)
        -

        Return a table of Parameter classes (groups of parameters, i.e. "criteria" -or "all"). The information from this function can be used as input to other -API calls.

        -
        -
        Parameters:
        -
        -
        parameterclass: a python character object that represents the class

        requested, use aqs_classes() for retrieving available -classes. The parameterclass python character object must be -a valid parameterclass as returned from aqs_classes(). -The class must be an exact match to what is returned from -aqs_classes().

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): parameters associated with the
        -
        parameterclass requested. None is returned for parameterclasses not found.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_pqaos(return_header=False)
        -

        Return a table of primary quality assurance organizations (pqaos).

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): pqaos and their associated
        -
        pqao_codes.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_revisionhistory(return_header=False)
        -

        Return a table Returns that contains change history to the AQS Data Mart -API.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): details change history to the
        -
        AQS Data Mart API.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_sampledurations(return_header=False)
        -

        Return a table of sample durations and their associated duration codes. -Returned values are not calculated durations such as 8 hour carbon monoxide -or ozone rolling averages, 3/6 day PM averages or Pb 3 month rolling -averages.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): sample durations and
        -
        their associated duration codes
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_sites_by_county(stateFIPS, countycode, return_header=False)
        -

        Return data containing a table of all air monitoring sites with the input -state and county FIPS code combination.

        -
        -
        Parameters:
        -
        -
        stateFIPSa python character object which represents the 2 digit

        state FIPS code (with leading zero) for the state being -requested. Use aqs_states() for the list of available -FIPS codes.

        -
        -
        countycodea python character object which represents the 3 digit

        state FIPS code for the county being requested -(with leading zero(s)). Use aqs_counties_by_state() for -the list of available county codes for each state.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): all air monitoring sites with
        -
        the requested state and county FIPS codes.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.listfunctions.aqs_states(return_header=False)
        -

        Return a table of US states, US territories, and the district or Columbia -with their respective FIPS codes.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): states and their associated FIPS
        -
        code.
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.metadatafunctions module

        -

        metadatafunctions.

        -
        -
        -pyaqsapi.metadatafunctions.aqs_is_available(return_header=False)
        -

        Return the status of the AQS API.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): Details the status of the
        -
        AQS API (The status information is located in the header).
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.metadatafunctions.aqs_knownissues(return_header=False)
        -

        Return a table of any known issues with system functionality or the data. -These are usually issues that have been identified internally and will -require some time to correct in Data Mart or the API. This function -implements a direct API call to Data Mart and returns data directly from -the API. Issues returned via this function do not include any issues from -the pyaqsapi python package.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): Information involving known
        -
        issues with the Data Mart API.
        -
        -
        -
        -
        - -
        -
        -pyaqsapi.metadatafunctions.aqs_revisionhistory(return_header=False)
        -

        Return the change history to the AQS Data Mart API.

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

        returns a AQSAPI_v2 object.

        -
        -
        -
        -
        Returns:
        -
        -
        (pandas DataFrame or an AQSAPI_V2 object): Information on the revision
        -
        history to the AQS Datamart API.
        -
        -
        -
        -
        - -
        -
        -

        pyaqsapi.setupfunctions module

        -

        setupfunctions.

        -
        -
        -pyaqsapi.setupfunctions.aqs_sign_up(email)
        -

        Use this service to register as a new user or to reset an existing user's -key. A verification email will be sent to the email account specified. To -reset a password: If the request is made with an email that is already -registered, a new key will be issued for that account and emailed to the -listed address. Usage is the same in either case. Refer to the email -message for further instructions before continuing.

        -
        -
        Parameters:
        -
        -
        emailA python character object which represents the email account that

        will be used to register with the AQS API or change an existing -user's key. A verification email will be sent to the account -specified. Follow the instructions in the verification e-mail -before proceeding to use any other functionality of the AQS API. -Register your credential with the aqs_credentials() before using -the other functions in this library.

        -
        -
        -
        -
        Returns:
        -
        -
        None.
        -
        -
        -
        -
        - -
        -
        -
        - - -
        -
        -
        - -
        - -
        -

        © Copyright 2024, US Environmental Protection Agency.

        -
        - - Built with Sphinx using a - theme - provided by Read the Docs. - - -
        -
        -
        -
        -
        - - - - \ No newline at end of file diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 3ceed5b..1b0b66b 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["index", "manual/EPA_Disclaimer", "manual/Install_pyaqsapi", "manual/Introduction", "manual/Load_pyaqsapi", "manual/RAQSAPI", "manual/TimelinessofAQSdata", "manual/Using_pyaqsapi", "manual/pyaqsapiFunctions-Brief", "pyaqsapi", "pyaqsapi.bybox", "pyaqsapi.bycbsa", "pyaqsapi.bycounty", "pyaqsapi.byma", "pyaqsapi.bypqao", "pyaqsapi.bysite", "pyaqsapi.bystate"], "filenames": ["index.rst", "manual/EPA_Disclaimer.rst", "manual/Install_pyaqsapi.rst", "manual/Introduction.rst", "manual/Load_pyaqsapi.rst", "manual/RAQSAPI.rst", "manual/TimelinessofAQSdata.rst", "manual/Using_pyaqsapi.rst", "manual/pyaqsapiFunctions-Brief.rst", "pyaqsapi.rst", "pyaqsapi.bybox.rst", "pyaqsapi.bycbsa.rst", "pyaqsapi.bycounty.rst", "pyaqsapi.byma.rst", "pyaqsapi.bypqao.rst", "pyaqsapi.bysite.rst", "pyaqsapi.bystate.rst"], "titles": ["pyaqsapi's documentation", "EPA Disclaimer", "Install pyaqsapi", "Introduction", "Load pyaqsapi", "About RAQSAPI", "About the timeliness of AQS Data", "Using pyaqsapi", "Data Mart aggregate functions", "pyaqsapi package", "pyaqsapi.bybox package", "pyaqsapi.bycbsa package", "pyaqsapi.bycounty package", "pyaqsapi.byma package", "pyaqsapi.bypqao package", "pyaqsapi.bysite package", "pyaqsapi.bystate package"], "terms": {"thi": [0, 1, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "softwar": [0, 1], "applic": [0, 1], "wa": [0, 1, 4, 9, 11, 12, 13, 14, 15, 16], "develop": [0, 1], "u": [0, 1, 3, 7, 8, 9], "environment": [0, 1, 3, 7], "protect": [0, 1, 3, 7], "agenc": [0, 1, 3, 7, 8, 9, 13], "usepa": [0, 1, 2], "No": [0, 1], "warranti": [0, 1], "express": [0, 1], "impli": [0, 1], "i": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "made": [0, 1, 9], "regard": [0, 1, 7], "accuraci": [0, 1], "util": [0, 1], "system": [0, 1, 3, 9], "nor": [0, 1], "shall": [0, 1], "act": [0, 1], "distribut": [0, 1], "constitut": [0, 1], "ani": [0, 1, 4, 7, 9], "The": [0, 1, 3, 7, 8, 9, 10, 11, 12, 15, 16], "ha": [0, 1, 3], "relinquish": [0, 1], "control": [0, 1, 8], "inform": [0, 1, 3, 7, 9], "longer": [0, 1, 8], "respons": [0, 1], "integr": [0, 1], "confidenti": [0, 1], "avail": [0, 1, 3, 8, 9, 10, 11, 12, 15, 16], "specif": [0, 1, 9, 10, 11, 12, 15, 16], "commerci": [0, 1], "product": [0, 1], "process": [0, 1], "servic": [0, 1, 6, 7, 8, 9], "mark": [0, 1], "trademark": [0, 1], "manufactur": [0, 1], "otherwis": [0, 1], "doe": [0, 1, 5, 6, 7, 9], "endors": [0, 1], "recommend": [0, 1], "favor": [0, 1], "seal": [0, 1], "logo": [0, 1], "manner": [0, 1], "activ": [0, 1], "unit": [0, 1, 3, 9, 12, 13, 16], "state": [0, 1, 3, 8, 9, 12, 15, 16], "govern": [0, 1], "v2": [0, 1, 3], "current": [0, 1], "beta": [0, 1], "phase": [0, 1], "interfac": [0, 1, 3], "been": [0, 1, 3, 9], "final": [0, 1], "mean": [0, 1, 7, 9, 10, 11, 12, 15, 16], "certain": [0, 1], "mai": [0, 1, 7], "chang": [0, 1, 7, 9, 11, 12, 13, 14, 15, 16], "remov": [0, 1], "without": [0, 1, 7], "notic": [0, 1], "As": [0, 1], "result": [0, 1, 3, 8, 9, 10, 11, 12, 15, 16], "packag": [0, 1, 2, 3, 4, 5, 7], "also": [0, 1, 7], "reflect": [0, 1], "respect": [0, 1, 9], "improv": [0, 1], "design": [0, 1], "qualiti": [0, 1, 3, 7, 8, 9, 11, 12, 13, 14, 15, 16], "author": [0, 1], "assum": [0, 1], "liabil": [0, 1], "problem": [0, 1], "occur": [0, 1, 9, 12, 13, 14, 15, 16], "hardwar": [0, 1], "account": [0, 1, 7, 9], "modul": [0, 3, 7], "python": [0, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16], "3": [0, 3, 5, 7, 9, 10, 11, 12, 15, 16], "program": [0, 3, 5, 9, 12, 13, 14, 15, 16], "environ": [0, 3, 4, 5], "allow": [0, 3], "connect": [0, 3, 9], "retriev": [0, 3, 6, 7, 8, 9], "from": [0, 3, 6, 7, 8, 9, 10, 11, 12, 15, 16], "air": [0, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "1": [0, 3, 6, 9, 11, 12], "directli": [0, 3, 9], "enabl": [0, 3], "omit": [0, 3], "legaci": [0, 3], "challeng": [0, 3], "includ": [0, 3, 9, 10, 11, 12, 13, 14, 15, 16], "coerc": [0, 3, 9], "json": [0, 3], "object": [0, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "usabl": [0, 3], "multipl": [0, 3, 8], "year": [0, 3, 8, 9, 11, 12], "format": [0, 3, 8, 9, 12, 13, 14, 15, 16], "request": [0, 3, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "handl": [0, 3, 9, 12, 13, 14, 15, 16], "pollut": [0, 3, 9, 10, 11, 12, 13, 14, 15, 16], "rate": [0, 3, 8, 9, 11, 12, 13, 14, 15, 16], "limit": [0, 3, 9, 10, 11, 12, 15, 16], "all": [0, 3, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16], "basic": [0, 3], "have": [0, 3, 5, 7, 9], "implement": [0, 3, 9], "ar": [0, 2, 3, 4, 5, 7, 8, 9, 12, 13, 14, 15, 16], "server": [0, 3, 7], "via": [0, 3, 9], "hypertext": [0, 3], "transfer": [0, 3], "protocol": [0, 3], "http": [0, 2, 3, 9], "so": [0, 3, 7, 9], "need": [0, 3, 6, 7, 9], "extern": [0, 3], "odbc": [0, 3], "driver": [0, 3], "configur": [0, 3], "deal": [0, 3], "secur": [0, 3], "vulner": [0, 3], "associ": [0, 3, 9], "them": [0, 3], "most": [0, 3, 5], "paramet": [0, 3, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16], "return_head": [0, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "which": [0, 3, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "default": [0, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "fals": [0, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "If": [0, 3, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16], "decid": [0, 3], "true": [0, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "return": [0, 3, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "aqs_datamart_apiv2": [0, 3], "an": [0, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "instanc": [0, 3, 9], "method": [0, 3, 7, 9], "header": [0, 3, 7, 9], "other": [0, 3, 4, 5, 9], "metadata": [0, 3, 9, 10, 12, 15, 16], "relat": [0, 3, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "call": [0, 3, 7, 8, 9], "after": [0, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "each": [0, 3, 5, 7, 8, 9, 11, 12, 15], "five": [0, 3], "second": [0, 3], "stall": [0, 3], "invok": [0, 3], "help": [0, 3], "prevent": [0, 3], "overload": [0, 3], "serv": [0, 3], "simpl": [0, 3], "host": [0, 6], "real": [0, 6], "time": [0, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "collect": [0, 6, 9, 12, 13, 14, 15, 16], "now": [0, 6, 9], "todai": [0, 6], "pleas": [0, 6], "airnow": [0, 6], "direct": [0, 6, 9], "question": [0, 6], "toward": [0, 6], "work": [0, 6], "cannot": [0, 6], "For": [0, 5, 6, 7, 9], "more": [0, 6, 8], "detail": [0, 6, 9], "see": [0, 6], "section": [0, 6, 9], "7": [0, 6, 8], "page": [0, 6], "port": [0, 5], "anyon": [0, 5], "familiar": [0, 5, 7], "feel": [0, 5, 7], "you": [0, 4, 5, 7], "similar": [0, 5, 7], "sent": [0, 5, 7, 9], "same": [0, 4, 5, 7, 9, 11], "aim": [0, 5], "featur": [0, 5], "pariti": [0, 5], "neither": [0, 5], "project": [0, 2, 5, 7], "than": [0, 5, 9, 10], "languag": [0, 5], "prefer": [0, 5], "benefit": [0, 5], "one": [0, 5, 7, 8, 9, 13, 14, 15, 16], "over": [0, 5], "To": [0, 2, 9], "first": [0, 2], "clone": [0, 2], "repositori": [0, 2], "git": [0, 2], "github": [0, 2], "com": [0, 2], "next": [0, 2], "root": [0, 2], "directori": [0, 2], "pip": [0, 2], "proper": [0, 2], "depend": [0, 2], "requir": [0, 2, 9], "build": [0, 2], "r": [0, 2], "txt": [0, 2], "while": [0, 2], "still": [0, 2], "setuptool": [0, 2], "m": [0, 2], "like": [0, 4, 9], "make": [0, 4, 8, 9], "sure": [0, 4], "virtual": [0, 4], "where": [0, 4, 8, 9, 10, 11, 12, 15, 16], "import": [0, 4, 9, 11, 12], "those": [0, 7], "who": [0, 7], "alreadi": [0, 7, 9], "should": [0, 7], "few": [0, 7], "minor": [0, 7], "differ": [0, 7, 8], "how": [0, 7, 8], "panda": [0, 7, 9, 10, 11, 12, 13, 14, 15, 16], "frame": [0, 7, 9, 10, 11, 12, 13, 14, 15, 16], "export": [0, 7], "when": [0, 7, 9, 11, 12, 13, 14, 15, 16], "simpli": [0, 7], "manual": [0, 7], "aqsapi_v2": [0, 7, 9, 10, 11, 12, 13, 14, 15, 16], "get_data": [0, 7, 9], "class": [0, 7, 9], "get_head": [0, 7, 9], "done": [0, 7], "aqs_sign_up": [0, 7, 9], "take": [0, 7, 8], "input": [0, 7, 9, 10, 11, 12, 13, 14, 15, 16], "email": [0, 7, 9], "charact": [0, 7, 9, 10, 11, 12, 13, 14, 15, 16], "repres": [0, 7, 9, 10, 11, 12, 13, 14, 15, 16], "address": [0, 7, 9], "want": [0, 7], "success": [0, 7], "messag": [0, 7, 9], "provid": [0, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "new": [0, 7, 9], "kei": [0, 7, 9], "access": [0, 7], "can": [0, 7, 9], "regener": [0, 7], "exist": [0, 7, 9], "gener": [0, 7], "A": [0, 7, 9], "e": [0, 7, 9, 12, 13, 14, 15, 16], "mail": [0, 7, 9], "given": [0, 7, 9, 11, 12, 15, 16], "store": [0, 7, 9], "global": [0, 7], "variabl": [0, 7, 9, 10, 11, 12, 13, 14, 15, 16], "everi": [0, 7, 9], "valid": [0, 7, 9, 10, 11, 12, 15, 16], "reject": [0, 7], "password": [0, 7, 9], "treat": [0, 7], "plain": [0, 7], "text": [0, 7], "attempt": [0, 7], "encrypt": [0, 7], "would": [0, 7], "usernam": [0, 7, 9], "combin": [0, 7, 9, 11, 12, 15, 16], "suppli": [0, 7], "intend": [0, 7], "authent": [0, 7], "onli": [0, 7, 9, 10, 11, 12, 13, 14, 15, 16], "monitor": [0, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "befor": [0, 7, 9, 10, 11, 12, 13, 14, 15, 16], "aqs_credenti": [0, 7, 9], "enter": [0, 7], "both": [0, 7, 9, 12, 13, 16], "either": [0, 7, 8, 9], "note": [0, 7, 8, 9, 10], "howev": [0, 7], "sourc": [0, 7], "do": [0, 7, 9], "creat": [0, 7], "sinc": [0, 7], "ew": [0, 7], "restrict": [0, 8], "maximum": [0, 8, 9, 10], "amount": [0, 8], "full": [0, 8], "per": [0, 8], "These": [0, 8, 9], "abl": [0, 8], "repeat": [0, 8], "complet": [0, 8], "being": [0, 8, 9, 10, 11, 12, 13, 14, 15, 16], "group": [0, 8, 9], "There": [0, 8], "famili": [0, 8], "seven": [0, 8], "site": [0, 8, 9, 10, 11, 12, 13, 14, 15, 16], "bysit": [0, 8], "counti": [0, 8, 9, 12, 15, 16], "bycounti": [0, 8], "bystat": [0, 8], "latitud": [0, 8, 9, 10], "longitud": [0, 8, 9, 10], "bound": [0, 8, 9, 10], "box": [0, 8, 9, 10], "bybox": [0, 8], "byma": [0, 8], "primari": [0, 8, 9, 14], "assur": [0, 8, 9, 11, 12, 13, 14, 15, 16], "organ": [0, 8, 9, 14], "bypqao": [0, 8], "core": [0, 8, 9, 11], "base": [0, 8, 9, 10, 11, 12, 13, 14, 15, 16], "statist": [0, 8, 9, 11, 12, 15, 16], "area": [0, 8, 9, 10, 11], "defin": [0, 8, 9, 11], "censu": [0, 8, 9, 11], "bureau": [0, 8, 9, 11], "bycbsa": [0, 8], "within": [0, 8, 9, 10, 11, 12, 13, 14, 15, 16], "13": [0, 8], "thirteen": [0, 8], "sampl": [0, 8, 9, 10, 11, 12, 13, 14, 15, 16], "sampledata": [0, 8, 9, 10, 11, 12, 15, 16], "daili": [0, 8, 9, 10, 11, 12, 15, 16], "summari": [0, 8, 9, 10, 11, 12, 15, 16], "dailydata": [0, 8], "annual": [0, 8, 9, 10, 11, 12, 13, 14, 15, 16], "annualdata": [0, 8], "blank": [0, 8, 9, 12, 13, 14, 15, 16], "qa_blank": [0, 8, 9, 12, 13, 14, 15, 16], "colloc": [0, 8, 9, 12, 13, 14, 15, 16], "assess": [0, 8, 9, 12, 13, 14, 15, 16], "qa_collocated_assess": [0, 8, 9, 12, 13, 14, 15, 16], "flow": [0, 8, 9, 11, 12, 13, 14, 15, 16], "verif": [0, 8, 9, 11, 12, 13, 14, 15, 16], "qa_flowrateverif": [0, 8, 9, 12, 13, 14, 15, 16], "audit": [0, 8, 9, 12, 13, 14, 15, 16], "aqs_qa_flowrateaudit": [0, 8], "One": [0, 8], "point": [0, 8, 9, 13, 14, 15, 16], "raw": [0, 8, 9, 12, 13, 14, 15, 16], "qa_one_point_qc": [0, 8, 9, 12, 13, 14, 15, 16], "pep": [0, 8, 9, 12, 13, 14, 15, 16], "qa_pep_audit": [0, 8, 9, 12, 13, 14, 15, 16], "transact": [0, 8, 9, 12, 13, 14, 15, 16], "submiss": [0, 8, 9, 12, 13, 14, 15, 16], "rd": [0, 8, 9, 12, 13, 14, 15, 16], "transactionsampl": [0, 8, 9, 12, 13, 15, 16], "perform": [0, 8, 9, 12, 13, 14, 15, 16], "evalu": [0, 8, 9, 12, 13, 14, 15, 16], "qa_annualpeferomanceev": [0, 8, 9, 13, 15], "qa_annualpeferomanceevaltransact": [0, 8], "name": [0, 8], "list": [0, 8, 9, 10, 11, 12, 13, 14, 15, 16], "abov": [0, 8], "": [1, 2, 3, 6, 7, 9, 12, 15], "refer": [1, 9], "us": [1, 2, 5, 6, 9, 10, 11, 12, 13, 14, 15, 16], "data": [1, 3, 7, 9, 10, 11, 12, 13, 14, 15, 16], "mart": [1, 3, 7, 9], "api": [1, 3, 5, 6, 7, 8, 9], "function": [1, 3, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16], "document": [1, 9], "user": [1, 3, 9], "pyaqsapi": [3, 5, 6, 8], "epa": [3, 6, 9], "aq": [3, 4, 7, 8, 9, 11, 12, 13, 14, 15, 16], "credenti": [3, 9], "librari": [3, 9], "instal": [3, 4], "set": [3, 9], "datamart": [6, 7, 9], "raqsapi": [6, 7], "load": [7, 9], "aggreg": [9, 10, 11, 12, 13, 14, 15, 16], "annualsummari": [9, 10, 11, 12, 15, 16], "bdate": [9, 10, 11, 12, 13, 14, 15, 16], "edat": [9, 10, 11, 12, 13, 14, 15, 16], "minlat": [9, 10], "maxlat": [9, 10], "minlon": [9, 10], "maxlon": [9, 10], "cbdate": [9, 10, 11, 12, 13, 14, 15, 16], "none": [9, 10, 11, 12, 13, 14, 15, 16], "cedat": [9, 10, 11, 12, 13, 14, 15, 16], "datafram": [9, 10, 11, 12, 13, 14, 15, 16], "_by_box": [9, 10], "contain": [9, 10, 11, 12, 13, 14, 15, 16], "match": [9, 10, 11, 12, 13, 14, 15, 16], "rectangular": [9, 10], "valu": [9, 10, 11, 12, 15, 16], "maxima": [9, 10, 11, 12, 15, 16], "percentil": [9, 10, 11, 12, 15, 16], "etc": [9, 10, 11, 12, 15, 16], "string": [9, 10, 11, 12, 13, 14, 15, 16], "code": [9, 10, 11, 12, 13, 14, 15, 16], "date": [9, 10, 11, 12, 13, 14, 15, 16], "begin": [9, 10, 11, 12, 13, 14, 15, 16], "select": [9, 10, 11, 12, 13, 14, 15, 16], "end": [9, 10, 11, 12, 13, 14, 15, 16], "minimum": [9, 10], "geograph": [9, 10], "decim": [9, 10], "north": [9, 10], "posit": [9, 10], "south": [9, 10], "east": [9, 10], "west": [9, 10], "80": [9, 10], "less": [9, 10], "70": [9, 10], "singl": [9, 10, 11, 12, 13, 14, 15, 16], "dailysummari": [9, 10, 11, 12, 15, 16], "statefip": [9, 10, 12, 14, 15, 16], "tabl": [9, 10, 11, 12, 13, 14, 15, 16], "quarterlysummari": [9, 10, 11, 12, 15, 16], "durat": [9, 10, 11, 12, 15, 16], "quarterli": [9, 10, 11, 12, 15, 16], "county_cod": [9, 10, 12, 15], "option": [9, 10, 11, 12, 13, 14, 15, 16], "filter": [9, 10, 11, 12, 13, 14, 15, 16], "actual": [9, 10, 11, 12, 15, 16], "calcul": [9, 10, 11, 12, 15, 16], "8": [9, 10, 11, 12, 15, 16], "hour": [9, 10, 11, 12, 15, 16], "carbon": [9, 10, 11, 12, 15, 16], "monoxid": [9, 10, 11, 12, 15, 16], "ozon": [9, 10, 11, 12, 15, 16], "roll": [9, 10, 11, 12, 15, 16], "averag": [9, 10, 11, 12, 15, 16], "6": [9, 10, 11, 12, 15, 16], "dai": [9, 10, 11, 12, 15, 16], "pm": [9, 10, 11, 12, 15, 16], "lead": [9, 10, 11, 12, 13, 14, 15, 16], "month": [9, 10, 11, 12, 15, 16], "aqs_sampledur": [9, 10, 11, 12, 15, 16], "cbsa": [9, 11], "cbsa_cod": [9, 11], "level": [9, 11, 12, 15, 16], "5": [9, 11, 12], "digit": [9, 11, 12, 13, 14, 15, 16], "zero": [9, 11, 12, 13, 14, 15, 16], "last": [9, 11, 12, 13, 14, 15, 16], "indic": [9, 11, 12, 13, 14, 15, 16], "updat": [9, 11, 12, 13, 14, 15, 16], "aqs_data": [9, 11, 16], "mart_apiv2": [9, 11, 16], "exampl": [9, 11, 12], "no2": [9, 11], "charlott": [9, 11], "concord": [9, 11], "gastonia": [9, 11], "nc": [9, 11, 12], "quarter": [9, 11], "2017": [9, 11], "datetim": [9, 11, 12], "42602": [9, 11], "16740": [9, 11], "timefram": [9, 11, 16], "countycod": [9, 12, 14, 15], "2": [9, 12, 15, 16], "fip": [9, 12, 15, 16], "aqs_stat": [9, 12, 15, 16], "aqs_counties_by_st": [9, 12, 15], "frm": [9, 12], "fem": [9, 12], "pm2": [9, 12], "wake": [9, 12], "between": [9, 12, 13, 14, 15, 16], "januari": [9, 12], "2015": [9, 12], "februari": [9, 12], "28": [9, 12], "2016": [9, 12], "88101": [9, 12], "37": [9, 12], "183": [9, 12], "qa_annualperformanceev": [9, 12, 14, 16], "qa_annualperformanceevaltransact": [9, 12, 13, 14, 15, 16], "pair": [9, 12, 13, 14, 15, 16], "qa": [9, 12, 13, 14, 15, 16], "unexpos": [9, 12, 13, 14, 15, 16], "devic": [9, 12, 13, 14, 15, 16], "g": [9, 12, 13, 14, 15, 16], "transport": [9, 12, 13, 14, 15, 16], "expos": [9, 12, 13, 14, 15, 16], "contamin": [9, 12, 13, 14, 15, 16], "dure": [9, 12, 13, 14, 15, 16], "qa_flowrateaudit": [9, 12, 13, 14, 15, 16], "flowrat": [9, 12, 13, 14, 15, 16], "submit": [9, 12, 13, 16], "standard": [9, 12, 13, 16], "correspond": [9, 12, 13, 15, 16], "ma": [9, 13], "By": [9, 13, 14], "ma_cod": [9, 13], "4": [9, 13, 14, 15], "_by_ma": [9, 13], "qc": [9, 13, 14, 15, 16], "check": [9, 13], "pqao": [9, 14], "pqao_cod": [9, 14], "sitenum": [9, 14, 15], "number": [9, 15], "period": [9, 15], "s3": [9, 16], "some": 9, "reason": 9, "sphinx": 9, "attribut": 9, "comment": 9, "out": 9, "_header": 9, "_request_tim": 9, "str": 9, "stamp": 9, "receiv": 9, "_statu": 9, "statu": 9, "_status_cod": 9, "numer": 9, "status_cod": 9, "_row": 9, "row": 9, "_data": 9, "_url": 9, "url": 9, "set_data": 9, "set_head": 9, "get_status_cod": 9, "get_url": 9, "get_request_tim": 9, "portion": 9, "must": 9, "warn": 9, "thrown": 9, "onc": 9, "re": 9, "obtain": 9, "through": 9, "sign": 9, "up": 9, "conjunct": 9, "aqs_removehead": 9, "aqsobject": 9, "aqs_data_mart_apiv2": 9, "decoupl": 9, "discard": 9, "els": 9, "aqs_cbsa": 9, "aqs_class": 9, "criteria": 9, "aqs_fields_by_servic": 9, "definit": 9, "field": 9, "gov": 9, "aqsweb": 9, "data_api": 9, "html": 9, "aqs_isavail": 9, "explain": 9, "aqs_knownissu": 9, "known": 9, "issu": 9, "usual": 9, "identifi": 9, "intern": 9, "correct": 9, "involv": 9, "aqs_ma": 9, "aqs_parameters_by_class": 9, "parameterclass": 9, "exact": 9, "what": 9, "found": 9, "aqs_pqao": 9, "aqs_revisionhistori": 9, "histori": 9, "pb": 9, "aqs_sites_by_counti": 9, "territori": 9, "district": 9, "columbia": 9, "aqs_is_avail": 9, "locat": 9, "revis": 9, "regist": 9, "reset": 9, "specifi": 9, "usag": 9, "case": 9, "further": 9, "instruct": 9, "continu": 9, "follow": 9, "proceed": 9, "your": 9}, "objects": {"pyaqsapi": [[10, 0, 0, "-", "bybox"], [11, 0, 0, "-", "bycbsa"], [12, 0, 0, "-", "bycounty"], [13, 0, 0, "-", "byma"], [14, 0, 0, "-", "bypqao"], [15, 0, 0, "-", "bysite"], [16, 0, 0, "-", "bystate"], [9, 0, 0, "-", "helperfunctions"], [9, 0, 0, "-", "listfunctions"], [9, 0, 0, "-", "metadatafunctions"], [9, 0, 0, "-", "setupfunctions"]], "pyaqsapi.bybox": [[10, 0, 0, "-", "bybox"]], "pyaqsapi.bybox.bybox": [[10, 1, 1, "", "annualsummary"], [10, 1, 1, "", "dailysummary"], [10, 1, 1, "", "monitors"], [10, 1, 1, "", "quarterlysummary"], [10, 1, 1, "", "sampledata"]], "pyaqsapi.bycbsa": [[11, 0, 0, "-", "bycbsa"]], "pyaqsapi.bycbsa.bycbsa": [[11, 1, 1, "", "annualsummary"], [11, 1, 1, "", "dailysummary"], [11, 1, 1, "", "monitors"], [11, 1, 1, "", "quarterlysummary"], [11, 1, 1, "", "sampledata"]], "pyaqsapi.bycounty": [[12, 0, 0, "-", "bycounty"]], "pyaqsapi.bycounty.bycounty": [[12, 1, 1, "", "annualsummary"], [12, 1, 1, "", "dailysummary"], [12, 1, 1, "", "monitors"], [12, 1, 1, "", "qa_annualperformanceeval"], [12, 1, 1, "", "qa_annualperformanceevaltransaction"], [12, 1, 1, "", "qa_blanks"], [12, 1, 1, "", "qa_collocated_assessments"], [12, 1, 1, "", "qa_flowrateaudit"], [12, 1, 1, "", "qa_flowrateverification"], [12, 1, 1, "", "qa_one_point_qc"], [12, 1, 1, "", "qa_pep_audit"], [12, 1, 1, "", "quarterlysummary"], [12, 1, 1, "", "sampledata"], [12, 1, 1, "", "transactionsample"]], "pyaqsapi.byma": [[13, 0, 0, "-", "byma"]], "pyaqsapi.byma.byma": [[13, 1, 1, "", "qa_annualpeferomanceeval"], [13, 1, 1, "", "qa_annualperformanceevaltransaction"], [13, 1, 1, "", "qa_blanks"], [13, 1, 1, "", "qa_collocated_assessments"], [13, 1, 1, "", "qa_flowrateaudit"], [13, 1, 1, "", "qa_flowrateverification"], [13, 1, 1, "", "qa_one_point_qc"], [13, 1, 1, "", "qa_pep_audit"], [13, 1, 1, "", "transactionsample"]], "pyaqsapi.bypqao": [[14, 0, 0, "-", "bypqao"]], "pyaqsapi.bypqao.bypqao": [[14, 1, 1, "", "qa_annualperformanceeval"], [14, 1, 1, "", "qa_annualperformanceevaltransaction"], [14, 1, 1, "", "qa_blanks"], [14, 1, 1, "", "qa_collocated_assessments"], [14, 1, 1, "", "qa_flowrateaudit"], [14, 1, 1, "", "qa_flowrateverification"], [14, 1, 1, "", "qa_one_point_qc"], [14, 1, 1, "", "qa_pep_audit"]], "pyaqsapi.bysite": [[15, 0, 0, "-", "bysite"]], "pyaqsapi.bysite.bysite": [[15, 1, 1, "", "annualsummary"], [15, 1, 1, "", "dailysummary"], [15, 1, 1, "", "monitors"], [15, 1, 1, "", "qa_annualpeferomanceeval"], [15, 1, 1, "", "qa_annualperformanceevaltransaction"], [15, 1, 1, "", "qa_blanks"], [15, 1, 1, "", "qa_collocated_assessments"], [15, 1, 1, "", "qa_flowrateaudit"], [15, 1, 1, "", "qa_flowrateverification"], [15, 1, 1, "", "qa_one_point_qc"], [15, 1, 1, "", "qa_pep_audit"], [15, 1, 1, "", "quarterlysummary"], [15, 1, 1, "", "sampledata"], [15, 1, 1, "", "transactionsample"]], "pyaqsapi.bystate": [[16, 0, 0, "-", "bystate"]], "pyaqsapi.bystate.bystate": [[16, 1, 1, "", "annualsummary"], [16, 1, 1, "", "dailysummary"], [16, 1, 1, "", "monitors"], [16, 1, 1, "", "qa_annualperformanceeval"], [16, 1, 1, "", "qa_annualperformanceevaltransaction"], [16, 1, 1, "", "qa_blanks"], [16, 1, 1, "", "qa_collocated_assessments"], [16, 1, 1, "", "qa_flowrateaudit"], [16, 1, 1, "", "qa_flowrateverification"], [16, 1, 1, "", "qa_one_point_qc"], [16, 1, 1, "", "qa_pep_audit"], [16, 1, 1, "", "quarterlysummary"], [16, 1, 1, "", "sampledata"], [16, 1, 1, "", "transactionsample"]], "pyaqsapi.helperfunctions": [[9, 2, 1, "", "AQSAPI_V2"], [9, 1, 1, "", "aqs_credentials"], [9, 1, 1, "", "aqs_removeheader"]], "pyaqsapi.helperfunctions.AQSAPI_V2": [[9, 3, 1, "", "get_data"], [9, 3, 1, "", "get_header"], [9, 3, 1, "", "get_request_time"], [9, 3, 1, "", "get_status_code"], [9, 3, 1, "", "get_url"], [9, 3, 1, "", "set_data"], [9, 3, 1, "", "set_header"]], "pyaqsapi.listfunctions": [[9, 1, 1, "", "aqs_cbsas"], [9, 1, 1, "", "aqs_classes"], [9, 1, 1, "", "aqs_counties_by_state"], [9, 1, 1, "", "aqs_fields_by_service"], [9, 1, 1, "", "aqs_isavailable"], [9, 1, 1, "", "aqs_knownissues"], [9, 1, 1, "", "aqs_mas"], [9, 1, 1, "", "aqs_parameters_by_class"], [9, 1, 1, "", "aqs_pqaos"], [9, 1, 1, "", "aqs_revisionhistory"], [9, 1, 1, "", "aqs_sampledurations"], [9, 1, 1, "", "aqs_sites_by_county"], [9, 1, 1, "", "aqs_states"]], "pyaqsapi.metadatafunctions": [[9, 1, 1, "", "aqs_is_available"], [9, 1, 1, "", "aqs_knownissues"], [9, 1, 1, "", "aqs_revisionhistory"]], "pyaqsapi.setupfunctions": [[9, 1, 1, "", "aqs_sign_up"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "titleterms": {"pyaqsapi": [0, 2, 4, 7, 9, 10, 11, 12, 13, 14, 15, 16], "": 0, "document": 0, "epa": [0, 1], "disclaim": [0, 1], "aq": [0, 1, 6], "datamart": [0, 1], "introduct": [0, 3], "about": [0, 5, 6], "timeli": [0, 6], "data": [0, 6, 8], "raqsapi": [0, 5], "instal": [0, 2], "load": [0, 4], "us": [0, 7], "sign": [0, 7], "up": [0, 7], "set": [0, 7], "user": [0, 7], "credenti": [0, 7], "librari": [0, 7], "mart": [0, 8], "aggreg": [0, 8], "function": [0, 8], "api": 0, "refer": 0, "index": 0, "packag": [9, 10, 11, 12, 13, 14, 15, 16], "submodul": [9, 10, 11, 12, 13, 14, 15, 16], "bybox": [9, 10], "modul": [9, 10, 11, 12, 13, 14, 15, 16], "bycbsa": [9, 11], "bycounti": [9, 12], "byma": [9, 13], "bypqao": [9, 14], "bysit": [9, 15], "bystat": [9, 16], "helperfunct": 9, "listfunct": 9, "metadatafunct": 9, "setupfunct": 9, "content": [10, 11, 12, 13, 14, 15, 16]}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinxcontrib.bibtex": 9, "sphinx": 60}, "alltitles": {"pyaqsapi's documentation": [[0, "pyaqsapi-s-documentation"]], "EPA Disclaimer": [[0, "epa-disclaimer"], [1, "epa-disclaimer"]], "AQS DataMart Disclaimer": [[0, "aqs-datamart-disclaimer"], [1, "aqs-datamart-disclaimer"]], "Introduction": [[0, "introduction"], [3, "introduction"]], "About the timeliness of AQS Data": [[0, "about-the-timeliness-of-aqs-data"], [6, "about-the-timeliness-of-aqs-data"]], "About RAQSAPI": [[0, "about-raqsapi"], [5, "about-raqsapi"]], "Install pyaqsapi": [[0, "install-pyaqsapi"], [2, "install-pyaqsapi"]], "Load pyaqsapi": [[0, "load-pyaqsapi"], [4, "load-pyaqsapi"]], "Using pyaqsapi": [[0, "using-pyaqsapi"], [7, "using-pyaqsapi"]], "Sign up and setting up user credentials with the pyaqsapi library": [[0, "sign-up-and-setting-up-user-credentials-with-the-pyaqsapi-library"], [7, "sign-up-and-setting-up-user-credentials-with-the-pyaqsapi-library"]], "Data Mart aggregate functions": [[0, "data-mart-aggregate-functions"], [8, "data-mart-aggregate-functions"]], "pyaqsapi API reference documentation": [[0, "pyaqsapi-api-reference-documentation"]], "Index": [[0, "index"]], "pyaqsapi package": [[9, "pyaqsapi-package"]], "Submodules": [[9, "submodules"], [10, "submodules"], [11, "submodules"], [12, "submodules"], [13, "submodules"], [14, "submodules"], [15, "submodules"], [16, "submodules"]], "pyaqsapi.bybox.bybox module": [[9, "module-pyaqsapi.bybox.bybox"], [10, "module-pyaqsapi.bybox.bybox"]], "pyaqsapi.bycbsa.bycbsa module": [[9, "module-pyaqsapi.bycbsa.bycbsa"], [11, "module-pyaqsapi.bycbsa.bycbsa"]], "pyaqsapi.bycounty.bycounty module": [[9, "module-pyaqsapi.bycounty.bycounty"], [12, "module-pyaqsapi.bycounty.bycounty"]], "pyaqsapi.byma.byma module": [[9, "module-pyaqsapi.byma.byma"], [13, "module-pyaqsapi.byma.byma"]], "pyaqsapi.bypqao.bypqao module": [[9, "module-pyaqsapi.bypqao.bypqao"], [14, "module-pyaqsapi.bypqao.bypqao"]], "pyaqsapi.bysite.bysite module": [[9, "module-pyaqsapi.bysite.bysite"], [15, "module-pyaqsapi.bysite.bysite"]], "pyaqsapi.bystate.bystate module": [[9, "module-pyaqsapi.bystate.bystate"], [16, "module-pyaqsapi.bystate.bystate"]], "pyaqsapi.helperfunctions module": [[9, "module-pyaqsapi.helperfunctions"]], "pyaqsapi.listfunctions module": [[9, "module-pyaqsapi.listfunctions"]], "pyaqsapi.metadatafunctions module": [[9, "module-pyaqsapi.metadatafunctions"]], "pyaqsapi.setupfunctions module": [[9, "module-pyaqsapi.setupfunctions"]], "pyaqsapi.bybox package": [[10, "pyaqsapi-bybox-package"]], "Module contents": [[10, "module-pyaqsapi.bybox"], [11, "module-pyaqsapi.bycbsa"], [12, "module-pyaqsapi.bycounty"], [13, "module-pyaqsapi.byma"], [14, "module-pyaqsapi.bypqao"], [15, "module-pyaqsapi.bysite"], [16, "module-pyaqsapi.bystate"]], "pyaqsapi.bycbsa package": [[11, "pyaqsapi-bycbsa-package"]], "pyaqsapi.bycounty package": [[12, "pyaqsapi-bycounty-package"]], "pyaqsapi.byma package": [[13, "pyaqsapi-byma-package"]], "pyaqsapi.bypqao package": [[14, "pyaqsapi-bypqao-package"]], "pyaqsapi.bysite package": [[15, "pyaqsapi-bysite-package"]], "pyaqsapi.bystate package": [[16, "pyaqsapi-bystate-package"]]}, "indexentries": {"epa disclaimer": [[0, "index-0"], [1, "index-0"]], "raqsapi": [[0, "index-2"], [5, "index-0"]], "aggregate functions": [[0, "index-8"], [8, "index-1"]], "install pyaqsapi": [[0, "index-3"], [2, "index-0"]], "load pyaqsapi": [[0, "index-4"], [4, "index-0"]], "pyaqsapi aggregate functions (brief)": [[0, "index-7"], [8, "index-0"]], "services": [[0, "index-9"], [8, "index-2"]], "sign_up": [[0, "index-6"], [7, "index-1"]], "timeliness of aqs data": [[0, "index-1"], [6, "index-0"]], "use pyaqsapi": [[0, "index-5"], [7, "index-0"]], "aqsapi_v2 (class in pyaqsapi.helperfunctions)": [[9, "pyaqsapi.helperfunctions.AQSAPI_V2"]], "annualsummary() (in module pyaqsapi.bybox.bybox)": [[9, "pyaqsapi.bybox.bybox.annualsummary"], [10, "pyaqsapi.bybox.bybox.annualsummary"]], "annualsummary() (in module pyaqsapi.bycbsa.bycbsa)": [[9, "pyaqsapi.bycbsa.bycbsa.annualsummary"], [11, "pyaqsapi.bycbsa.bycbsa.annualsummary"]], "annualsummary() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.annualsummary"], [12, "pyaqsapi.bycounty.bycounty.annualsummary"]], "annualsummary() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.annualsummary"], [15, "pyaqsapi.bysite.bysite.annualsummary"]], "annualsummary() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.annualsummary"], [16, "pyaqsapi.bystate.bystate.annualsummary"]], "aqs_cbsas() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_cbsas"]], "aqs_classes() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_classes"]], "aqs_counties_by_state() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_counties_by_state"]], "aqs_credentials() (in module pyaqsapi.helperfunctions)": [[9, "pyaqsapi.helperfunctions.aqs_credentials"]], "aqs_fields_by_service() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_fields_by_service"]], "aqs_is_available() (in module pyaqsapi.metadatafunctions)": [[9, "pyaqsapi.metadatafunctions.aqs_is_available"]], "aqs_isavailable() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_isavailable"]], "aqs_knownissues() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_knownissues"]], "aqs_knownissues() (in module pyaqsapi.metadatafunctions)": [[9, "pyaqsapi.metadatafunctions.aqs_knownissues"]], "aqs_mas() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_mas"]], "aqs_parameters_by_class() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_parameters_by_class"]], "aqs_pqaos() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_pqaos"]], "aqs_removeheader() (in module pyaqsapi.helperfunctions)": [[9, "pyaqsapi.helperfunctions.aqs_removeheader"]], "aqs_revisionhistory() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_revisionhistory"]], "aqs_revisionhistory() (in module pyaqsapi.metadatafunctions)": [[9, "pyaqsapi.metadatafunctions.aqs_revisionhistory"]], "aqs_sampledurations() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_sampledurations"]], "aqs_sign_up() (in module pyaqsapi.setupfunctions)": [[9, "pyaqsapi.setupfunctions.aqs_sign_up"]], "aqs_sites_by_county() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_sites_by_county"]], "aqs_states() (in module pyaqsapi.listfunctions)": [[9, "pyaqsapi.listfunctions.aqs_states"]], "dailysummary() (in module pyaqsapi.bybox.bybox)": [[9, "pyaqsapi.bybox.bybox.dailysummary"], [10, "pyaqsapi.bybox.bybox.dailysummary"]], "dailysummary() (in module pyaqsapi.bycbsa.bycbsa)": [[9, "pyaqsapi.bycbsa.bycbsa.dailysummary"], [11, "pyaqsapi.bycbsa.bycbsa.dailysummary"]], "dailysummary() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.dailysummary"], [12, "pyaqsapi.bycounty.bycounty.dailysummary"]], "dailysummary() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.dailysummary"], [15, "pyaqsapi.bysite.bysite.dailysummary"]], "dailysummary() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.dailysummary"], [16, "pyaqsapi.bystate.bystate.dailysummary"]], "get_data() (pyaqsapi.helperfunctions.aqsapi_v2 method)": [[9, "pyaqsapi.helperfunctions.AQSAPI_V2.get_data"]], "get_header() (pyaqsapi.helperfunctions.aqsapi_v2 method)": [[9, "pyaqsapi.helperfunctions.AQSAPI_V2.get_header"]], "get_request_time() (pyaqsapi.helperfunctions.aqsapi_v2 method)": [[9, "pyaqsapi.helperfunctions.AQSAPI_V2.get_request_time"]], "get_status_code() (pyaqsapi.helperfunctions.aqsapi_v2 method)": [[9, "pyaqsapi.helperfunctions.AQSAPI_V2.get_status_code"]], "get_url() (pyaqsapi.helperfunctions.aqsapi_v2 method)": [[9, "pyaqsapi.helperfunctions.AQSAPI_V2.get_url"]], "module": [[9, "module-pyaqsapi.bybox.bybox"], [9, "module-pyaqsapi.bycbsa.bycbsa"], [9, "module-pyaqsapi.bycounty.bycounty"], [9, "module-pyaqsapi.byma.byma"], [9, "module-pyaqsapi.bypqao.bypqao"], [9, "module-pyaqsapi.bysite.bysite"], [9, "module-pyaqsapi.bystate.bystate"], [9, "module-pyaqsapi.helperfunctions"], [9, "module-pyaqsapi.listfunctions"], [9, "module-pyaqsapi.metadatafunctions"], [9, "module-pyaqsapi.setupfunctions"], [10, "module-pyaqsapi.bybox"], [10, "module-pyaqsapi.bybox.bybox"], [11, "module-pyaqsapi.bycbsa"], [11, "module-pyaqsapi.bycbsa.bycbsa"], [12, "module-pyaqsapi.bycounty"], [12, "module-pyaqsapi.bycounty.bycounty"], [13, "module-pyaqsapi.byma"], [13, "module-pyaqsapi.byma.byma"], [14, "module-pyaqsapi.bypqao"], [14, "module-pyaqsapi.bypqao.bypqao"], [15, "module-pyaqsapi.bysite"], [15, "module-pyaqsapi.bysite.bysite"], [16, "module-pyaqsapi.bystate"], [16, "module-pyaqsapi.bystate.bystate"]], "monitors() (in module pyaqsapi.bybox.bybox)": [[9, "pyaqsapi.bybox.bybox.monitors"], [10, "pyaqsapi.bybox.bybox.monitors"]], "monitors() (in module pyaqsapi.bycbsa.bycbsa)": [[9, "pyaqsapi.bycbsa.bycbsa.monitors"], [11, "pyaqsapi.bycbsa.bycbsa.monitors"]], "monitors() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.monitors"], [12, "pyaqsapi.bycounty.bycounty.monitors"]], "monitors() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.monitors"], [15, "pyaqsapi.bysite.bysite.monitors"]], "monitors() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.monitors"], [16, "pyaqsapi.bystate.bystate.monitors"]], "pyaqsapi.bybox.bybox": [[9, "module-pyaqsapi.bybox.bybox"], [10, "module-pyaqsapi.bybox.bybox"]], "pyaqsapi.bycbsa.bycbsa": [[9, "module-pyaqsapi.bycbsa.bycbsa"], [11, "module-pyaqsapi.bycbsa.bycbsa"]], "pyaqsapi.bycounty.bycounty": [[9, "module-pyaqsapi.bycounty.bycounty"], [12, "module-pyaqsapi.bycounty.bycounty"]], "pyaqsapi.byma.byma": [[9, "module-pyaqsapi.byma.byma"], [13, "module-pyaqsapi.byma.byma"]], "pyaqsapi.bypqao.bypqao": [[9, "module-pyaqsapi.bypqao.bypqao"], [14, "module-pyaqsapi.bypqao.bypqao"]], "pyaqsapi.bysite.bysite": [[9, "module-pyaqsapi.bysite.bysite"], [15, "module-pyaqsapi.bysite.bysite"]], "pyaqsapi.bystate.bystate": [[9, "module-pyaqsapi.bystate.bystate"], [16, "module-pyaqsapi.bystate.bystate"]], "pyaqsapi.helperfunctions": [[9, "module-pyaqsapi.helperfunctions"]], "pyaqsapi.listfunctions": [[9, "module-pyaqsapi.listfunctions"]], "pyaqsapi.metadatafunctions": [[9, "module-pyaqsapi.metadatafunctions"]], "pyaqsapi.setupfunctions": [[9, "module-pyaqsapi.setupfunctions"]], "qa_annualpeferomanceeval() (in module pyaqsapi.byma.byma)": [[9, "pyaqsapi.byma.byma.qa_annualpeferomanceeval"], [13, "pyaqsapi.byma.byma.qa_annualpeferomanceeval"]], "qa_annualpeferomanceeval() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.qa_annualpeferomanceeval"], [15, "pyaqsapi.bysite.bysite.qa_annualpeferomanceeval"]], "qa_annualperformanceeval() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.qa_annualperformanceeval"], [12, "pyaqsapi.bycounty.bycounty.qa_annualperformanceeval"]], "qa_annualperformanceeval() (in module pyaqsapi.bypqao.bypqao)": [[9, "pyaqsapi.bypqao.bypqao.qa_annualperformanceeval"], [14, "pyaqsapi.bypqao.bypqao.qa_annualperformanceeval"]], "qa_annualperformanceeval() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.qa_annualperformanceeval"], [16, "pyaqsapi.bystate.bystate.qa_annualperformanceeval"]], "qa_annualperformanceevaltransaction() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.qa_annualperformanceevaltransaction"], [12, "pyaqsapi.bycounty.bycounty.qa_annualperformanceevaltransaction"]], "qa_annualperformanceevaltransaction() (in module pyaqsapi.byma.byma)": [[9, "pyaqsapi.byma.byma.qa_annualperformanceevaltransaction"], [13, "pyaqsapi.byma.byma.qa_annualperformanceevaltransaction"]], "qa_annualperformanceevaltransaction() (in module pyaqsapi.bypqao.bypqao)": [[9, "pyaqsapi.bypqao.bypqao.qa_annualperformanceevaltransaction"], [14, "pyaqsapi.bypqao.bypqao.qa_annualperformanceevaltransaction"]], "qa_annualperformanceevaltransaction() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.qa_annualperformanceevaltransaction"], [15, "pyaqsapi.bysite.bysite.qa_annualperformanceevaltransaction"]], "qa_annualperformanceevaltransaction() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.qa_annualperformanceevaltransaction"], [16, "pyaqsapi.bystate.bystate.qa_annualperformanceevaltransaction"]], "qa_blanks() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.qa_blanks"], [12, "pyaqsapi.bycounty.bycounty.qa_blanks"]], "qa_blanks() (in module pyaqsapi.byma.byma)": [[9, "pyaqsapi.byma.byma.qa_blanks"], [13, "pyaqsapi.byma.byma.qa_blanks"]], "qa_blanks() (in module pyaqsapi.bypqao.bypqao)": [[9, "pyaqsapi.bypqao.bypqao.qa_blanks"], [14, "pyaqsapi.bypqao.bypqao.qa_blanks"]], "qa_blanks() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.qa_blanks"], [15, "pyaqsapi.bysite.bysite.qa_blanks"]], "qa_blanks() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.qa_blanks"], [16, "pyaqsapi.bystate.bystate.qa_blanks"]], "qa_collocated_assessments() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.qa_collocated_assessments"], [12, "pyaqsapi.bycounty.bycounty.qa_collocated_assessments"]], "qa_collocated_assessments() (in module pyaqsapi.byma.byma)": [[9, "pyaqsapi.byma.byma.qa_collocated_assessments"], [13, "pyaqsapi.byma.byma.qa_collocated_assessments"]], "qa_collocated_assessments() (in module pyaqsapi.bypqao.bypqao)": [[9, "pyaqsapi.bypqao.bypqao.qa_collocated_assessments"], [14, "pyaqsapi.bypqao.bypqao.qa_collocated_assessments"]], "qa_collocated_assessments() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.qa_collocated_assessments"], [15, "pyaqsapi.bysite.bysite.qa_collocated_assessments"]], "qa_collocated_assessments() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.qa_collocated_assessments"], [16, "pyaqsapi.bystate.bystate.qa_collocated_assessments"]], "qa_flowrateaudit() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.qa_flowrateaudit"], [12, "pyaqsapi.bycounty.bycounty.qa_flowrateaudit"]], "qa_flowrateaudit() (in module pyaqsapi.byma.byma)": [[9, "pyaqsapi.byma.byma.qa_flowrateaudit"], [13, "pyaqsapi.byma.byma.qa_flowrateaudit"]], "qa_flowrateaudit() (in module pyaqsapi.bypqao.bypqao)": [[9, "pyaqsapi.bypqao.bypqao.qa_flowrateaudit"], [14, "pyaqsapi.bypqao.bypqao.qa_flowrateaudit"]], "qa_flowrateaudit() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.qa_flowrateaudit"], [15, "pyaqsapi.bysite.bysite.qa_flowrateaudit"]], "qa_flowrateaudit() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.qa_flowrateaudit"], [16, "pyaqsapi.bystate.bystate.qa_flowrateaudit"]], "qa_flowrateverification() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.qa_flowrateverification"], [12, "pyaqsapi.bycounty.bycounty.qa_flowrateverification"]], "qa_flowrateverification() (in module pyaqsapi.byma.byma)": [[9, "pyaqsapi.byma.byma.qa_flowrateverification"], [13, "pyaqsapi.byma.byma.qa_flowrateverification"]], "qa_flowrateverification() (in module pyaqsapi.bypqao.bypqao)": [[9, "pyaqsapi.bypqao.bypqao.qa_flowrateverification"], [14, "pyaqsapi.bypqao.bypqao.qa_flowrateverification"]], "qa_flowrateverification() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.qa_flowrateverification"], [15, "pyaqsapi.bysite.bysite.qa_flowrateverification"]], "qa_flowrateverification() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.qa_flowrateverification"], [16, "pyaqsapi.bystate.bystate.qa_flowrateverification"]], "qa_one_point_qc() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.qa_one_point_qc"], [12, "pyaqsapi.bycounty.bycounty.qa_one_point_qc"]], "qa_one_point_qc() (in module pyaqsapi.byma.byma)": [[9, "pyaqsapi.byma.byma.qa_one_point_qc"], [13, "pyaqsapi.byma.byma.qa_one_point_qc"]], "qa_one_point_qc() (in module pyaqsapi.bypqao.bypqao)": [[9, "pyaqsapi.bypqao.bypqao.qa_one_point_qc"], [14, "pyaqsapi.bypqao.bypqao.qa_one_point_qc"]], "qa_one_point_qc() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.qa_one_point_qc"], [15, "pyaqsapi.bysite.bysite.qa_one_point_qc"]], "qa_one_point_qc() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.qa_one_point_qc"], [16, "pyaqsapi.bystate.bystate.qa_one_point_qc"]], "qa_pep_audit() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.qa_pep_audit"], [12, "pyaqsapi.bycounty.bycounty.qa_pep_audit"]], "qa_pep_audit() (in module pyaqsapi.byma.byma)": [[9, "pyaqsapi.byma.byma.qa_pep_audit"], [13, "pyaqsapi.byma.byma.qa_pep_audit"]], "qa_pep_audit() (in module pyaqsapi.bypqao.bypqao)": [[9, "pyaqsapi.bypqao.bypqao.qa_pep_audit"], [14, "pyaqsapi.bypqao.bypqao.qa_pep_audit"]], "qa_pep_audit() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.qa_pep_audit"], [15, "pyaqsapi.bysite.bysite.qa_pep_audit"]], "qa_pep_audit() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.qa_pep_audit"], [16, "pyaqsapi.bystate.bystate.qa_pep_audit"]], "quarterlysummary() (in module pyaqsapi.bybox.bybox)": [[9, "pyaqsapi.bybox.bybox.quarterlysummary"], [10, "pyaqsapi.bybox.bybox.quarterlysummary"]], "quarterlysummary() (in module pyaqsapi.bycbsa.bycbsa)": [[9, "pyaqsapi.bycbsa.bycbsa.quarterlysummary"], [11, "pyaqsapi.bycbsa.bycbsa.quarterlysummary"]], "quarterlysummary() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.quarterlysummary"], [12, "pyaqsapi.bycounty.bycounty.quarterlysummary"]], "quarterlysummary() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.quarterlysummary"], [15, "pyaqsapi.bysite.bysite.quarterlysummary"]], "quarterlysummary() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.quarterlysummary"], [16, "pyaqsapi.bystate.bystate.quarterlysummary"]], "sampledata() (in module pyaqsapi.bybox.bybox)": [[9, "pyaqsapi.bybox.bybox.sampledata"], [10, "pyaqsapi.bybox.bybox.sampledata"]], "sampledata() (in module pyaqsapi.bycbsa.bycbsa)": [[9, "pyaqsapi.bycbsa.bycbsa.sampledata"], [11, "pyaqsapi.bycbsa.bycbsa.sampledata"]], "sampledata() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.sampledata"], [12, "pyaqsapi.bycounty.bycounty.sampledata"]], "sampledata() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.sampledata"], [15, "pyaqsapi.bysite.bysite.sampledata"]], "sampledata() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.sampledata"], [16, "pyaqsapi.bystate.bystate.sampledata"]], "set_data() (pyaqsapi.helperfunctions.aqsapi_v2 method)": [[9, "pyaqsapi.helperfunctions.AQSAPI_V2.set_data"]], "set_header() (pyaqsapi.helperfunctions.aqsapi_v2 method)": [[9, "pyaqsapi.helperfunctions.AQSAPI_V2.set_header"]], "transactionsample() (in module pyaqsapi.bycounty.bycounty)": [[9, "pyaqsapi.bycounty.bycounty.transactionsample"], [12, "pyaqsapi.bycounty.bycounty.transactionsample"]], "transactionsample() (in module pyaqsapi.byma.byma)": [[9, "pyaqsapi.byma.byma.transactionsample"], [13, "pyaqsapi.byma.byma.transactionsample"]], "transactionsample() (in module pyaqsapi.bysite.bysite)": [[9, "pyaqsapi.bysite.bysite.transactionsample"], [15, "pyaqsapi.bysite.bysite.transactionsample"]], "transactionsample() (in module pyaqsapi.bystate.bystate)": [[9, "pyaqsapi.bystate.bystate.transactionsample"], [16, "pyaqsapi.bystate.bystate.transactionsample"]], "pyaqsapi.bybox": [[10, "module-pyaqsapi.bybox"]], "pyaqsapi.bycbsa": [[11, "module-pyaqsapi.bycbsa"]], "pyaqsapi.bycounty": [[12, "module-pyaqsapi.bycounty"]], "pyaqsapi.byma": [[13, "module-pyaqsapi.byma"]], "pyaqsapi.bypqao": [[14, "module-pyaqsapi.bypqao"]], "pyaqsapi.bysite": [[15, "module-pyaqsapi.bysite"]], "pyaqsapi.bystate": [[16, "module-pyaqsapi.bystate"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["index", "manual/EPA_Disclaimer", "manual/Install_pyaqsapi", "manual/Introduction", "manual/Load_pyaqsapi", "manual/RAQSAPI", "manual/TimelinessofAQSdata", "manual/Using_pyaqsapi", "manual/pyaqsapiFunctions-Brief", "manual/pyaqsapiFunctions-Long"], "filenames": ["index.rst", "manual/EPA_Disclaimer.rst", "manual/Install_pyaqsapi.rst", "manual/Introduction.rst", "manual/Load_pyaqsapi.rst", "manual/RAQSAPI.rst", "manual/TimelinessofAQSdata.rst", "manual/Using_pyaqsapi.rst", "manual/pyaqsapiFunctions-Brief.rst", "manual/pyaqsapiFunctions-Long.rst"], "titles": ["pyaqsapi user documentation", "EPA Disclaimer", "Install pyaqsapi", "Introduction", "Load pyaqsapi", "About RAQSAPI", "About the timeliness of AQS Data", "Using pyaqsapi", "Data Mart aggregate functions", "Functions Exported by pyaqsapi"], "terms": {"thi": [0, 1, 3, 7, 9], "softwar": [0, 1], "applic": [0, 1], "wa": [0, 1, 4, 9], "develop": [0, 1], "u": [0, 1, 3, 7, 8, 9], "": [0, 1, 2, 3, 6, 7, 9], "environment": [0, 1, 3, 7], "protect": [0, 1, 3, 7], "usepa": [0, 1, 2], "No": [0, 1], "warranti": [0, 1], "express": [0, 1], "impli": [0, 1], "i": [0, 1, 3, 4, 5, 6, 7, 8, 9], "made": [0, 1], "regard": [0, 1, 7], "accuraci": [0, 1], "util": [0, 1], "system": [0, 1, 3, 9], "nor": [0, 1], "shall": [0, 1], "act": [0, 1], "distribut": [0, 1], "constitut": [0, 1], "ani": [0, 1, 4, 7, 9], "The": [0, 1, 3, 7, 8, 9], "ha": [0, 1, 3], "relinquish": [0, 1], "control": [0, 1, 8, 9], "inform": [0, 1, 3, 7, 9], "longer": [0, 1, 8, 9], "respons": [0, 1, 9], "integr": [0, 1], "confidenti": [0, 1], "avail": [0, 1, 3, 8, 9], "specif": [0, 1, 9], "commerci": [0, 1], "product": [0, 1], "process": [0, 1], "servic": [0, 1, 6, 7, 8, 9], "mark": [0, 1], "trademark": [0, 1], "manufactur": [0, 1], "otherwis": [0, 1], "doe": [0, 1, 5, 6, 7], "endors": [0, 1], "recommend": [0, 1], "favor": [0, 1], "seal": [0, 1], "logo": [0, 1], "manner": [0, 1], "activ": [0, 1], "unit": [0, 1, 3], "state": [0, 1, 3, 8, 9], "govern": [0, 1], "v2": [0, 1, 3], "current": [0, 1], "beta": [0, 1], "phase": [0, 1], "interfac": [0, 1, 3], "been": [0, 1, 3, 9], "final": [0, 1], "mean": [0, 1, 7, 9], "certain": [0, 1, 9], "mai": [0, 1, 7], "chang": [0, 1, 7, 9], "remov": [0, 1], "without": [0, 1, 7], "notic": [0, 1], "As": [0, 1], "result": [0, 1, 3, 8, 9], "packag": [0, 1, 2, 3, 4, 5, 7, 9], "also": [0, 1, 7], "reflect": [0, 1], "respect": [0, 1, 9], "improv": [0, 1], "design": [0, 1], "author": [0, 1], "assum": [0, 1], "liabil": [0, 1], "problem": [0, 1], "occur": [0, 1, 9], "hardwar": [0, 1], "account": [0, 1, 7, 9], "modul": [0, 3, 7, 9], "python": [0, 2, 3, 4, 5, 7], "3": [0, 3, 5, 7, 9], "program": [0, 3, 5, 9], "environ": [0, 3, 4, 5], "allow": [0, 3], "connect": [0, 3, 9], "retriev": [0, 3, 6, 7, 8, 9], "from": [0, 3, 6, 7, 8, 9], "air": [0, 3, 7, 9], "1": [0, 3, 6], "directli": [0, 3, 9], "enabl": [0, 3], "omit": [0, 3], "legaci": [0, 3], "challeng": [0, 3, 9], "includ": [0, 3, 9], "coerc": [0, 3, 9], "json": [0, 3], "object": [0, 3, 7, 9], "usabl": [0, 3], "multipl": [0, 3, 8, 9], "year": [0, 3, 8, 9], "format": [0, 3, 8, 9], "request": [0, 3, 7, 8, 9], "handl": [0, 3, 9], "pollut": [0, 3, 9], "rate": [0, 3, 8, 9], "limit": [0, 3, 9], "all": [0, 3, 6, 7, 8, 9], "basic": [0, 3], "have": [0, 3, 5, 7, 9], "implement": [0, 3, 9], "ar": [0, 2, 3, 4, 5, 7, 8, 9], "server": [0, 3, 7], "via": [0, 3, 9], "hypertext": [0, 3], "transfer": [0, 3], "protocol": [0, 3], "http": [0, 2, 3, 9], "so": [0, 3, 7], "need": [0, 3, 6, 7], "extern": [0, 3], "odbc": [0, 3], "driver": [0, 3], "configur": [0, 3], "deal": [0, 3], "secur": [0, 3], "vulner": [0, 3], "associ": [0, 3], "them": [0, 3], "most": [0, 3, 5, 9], "paramet": [0, 3, 5, 7, 9], "return_head": [0, 3, 7, 9], "which": [0, 3, 7, 8, 9], "default": [0, 3, 7, 9], "fals": [0, 3, 7, 9], "If": [0, 3, 6, 7, 9], "decid": [0, 3, 9], "true": [0, 3, 7, 9], "return": [0, 3, 7, 8, 9], "aqs_datamart_apiv2": [0, 3], "an": [0, 3, 7, 9], "instanc": [0, 3], "method": [0, 3, 7, 9], "header": [0, 3, 7], "other": [0, 3, 4, 5, 9], "relat": [0, 3, 7, 8, 9], "call": [0, 3, 7, 8, 9], "after": [0, 3, 7, 9], "each": [0, 3, 5, 7, 8, 9], "five": [0, 3], "second": [0, 3], "stall": [0, 3], "invok": [0, 3], "help": [0, 3], "prevent": [0, 3], "overload": [0, 3], "serv": [0, 3], "simpl": [0, 3, 9], "host": [0, 6], "real": [0, 6], "time": [0, 6, 7, 8, 9], "collect": [0, 6, 9], "now": [0, 6], "todai": [0, 6], "pleas": [0, 6], "airnow": [0, 6], "direct": [0, 6, 9], "question": [0, 6], "toward": [0, 6], "work": [0, 6], "cannot": [0, 6], "For": [0, 5, 6, 7, 9], "more": [0, 6, 8, 9], "detail": [0, 6, 9], "see": [0, 6, 9], "section": [0, 6, 9], "7": [0, 6, 8], "page": [0, 6], "port": [0, 5], "anyon": [0, 5], "familiar": [0, 5, 7], "feel": [0, 5, 7], "you": [0, 4, 5, 7], "similar": [0, 5, 7], "sent": [0, 5, 7, 9], "same": [0, 4, 5, 7, 9], "aim": [0, 5], "featur": [0, 5], "pariti": [0, 5], "neither": [0, 5], "project": [0, 2, 5, 7], "than": [0, 5, 9], "languag": [0, 5], "prefer": [0, 5], "benefit": [0, 5], "one": [0, 5, 7, 8, 9], "over": [0, 5], "To": [0, 2], "first": [0, 2], "clone": [0, 2], "repositori": [0, 2], "git": [0, 2], "github": [0, 2], "com": [0, 2], "next": [0, 2], "root": [0, 2], "directori": [0, 2], "pip": [0, 2], "proper": [0, 2], "depend": [0, 2], "requir": [0, 2, 9], "build": [0, 2], "r": [0, 2], "txt": [0, 2], "while": [0, 2], "still": [0, 2], "setuptool": [0, 2], "m": [0, 2], "like": [0, 4], "make": [0, 4, 8, 9], "sure": [0, 4], "virtual": [0, 4], "where": [0, 4, 8], "import": [0, 4], "those": [0, 7], "who": [0, 7], "alreadi": [0, 7], "should": [0, 7, 9], "few": [0, 7], "minor": [0, 7], "differ": [0, 7, 8, 9], "how": [0, 7, 8, 9], "panda": [0, 7, 9], "frame": [0, 7], "when": [0, 7, 9], "simpli": [0, 7], "manual": [0, 7], "aqsapi_v2": [0, 7, 9], "get_data": [0, 7], "class": [0, 7, 9], "get_head": [0, 7], "done": [0, 7], "aqs_sign_up": [0, 7, 9], "take": [0, 7, 8, 9], "input": [0, 7], "email": [0, 7, 9], "charact": [0, 7, 9], "repres": [0, 7, 9], "address": [0, 7], "want": [0, 7, 9], "success": [0, 7], "messag": [0, 7], "provid": [0, 7, 8, 9], "new": [0, 7], "kei": [0, 7, 9], "access": [0, 7], "can": [0, 7, 9], "regener": [0, 7], "exist": [0, 7, 9], "gener": [0, 7], "A": [0, 7, 9], "e": [0, 7, 9], "mail": [0, 7], "given": [0, 7, 9], "store": [0, 7, 9], "global": [0, 7], "everi": [0, 7, 9], "valid": [0, 7, 9], "reject": [0, 7], "password": [0, 7], "treat": [0, 7], "plain": [0, 7], "text": [0, 7], "attempt": [0, 7], "encrypt": [0, 7], "would": [0, 7], "usernam": [0, 7, 9], "combin": [0, 7, 9], "suppli": [0, 7], "intend": [0, 7], "authent": [0, 7], "onli": [0, 7, 9], "befor": [0, 7, 9], "aqs_credenti": [0, 7, 9], "enter": [0, 7], "both": [0, 7, 9], "either": [0, 7, 8], "note": [0, 7, 8, 9], "howev": [0, 7], "sourc": [0, 7], "do": [0, 7, 9], "creat": [0, 7], "sinc": [0, 7], "ew": [0, 7], "follow": [0, 9], "submodul": [0, 9], "bycbsa": [0, 8, 9], "byma": [0, 8, 9], "With": [0, 9], "entir": [0, 9], "aqs_cbsa": [0, 9], "aqs_class": [0, 9], "aqs_counties_by_st": [0, 9], "aqs_fields_by_servic": [0, 9], "aqs_isavail": [0, 9], "aqs_knownissu": [0, 9], "aqs_ma": [0, 9], "aqs_parameters_by_class": [0, 9], "aqs_pqao": [0, 9], "aqs_removehead": [0, 9], "aqs_revisionhistori": [0, 9], "aqs_sampledur": [0, 9], "aqs_sites_by_counti": [0, 9], "aqs_stat": [0, 9], "annualsummari": [0, 9], "dailysummari": [0, 9], "helperfunct": [0, 9], "quarterlysummari": [0, 9], "sampledata": [0, 8, 9], "qa_annualperformanceev": [0, 8, 9], "qa_annualperformanceevaltransact": [0, 8, 9], "qa_blank": [0, 8, 9], "qa_collocated_assess": [0, 8, 9], "qa_flowrateaudit": [0, 9], "qa_flowrateverif": [0, 8, 9], "qa_one_point_qc": [0, 8, 9], "qa_pep_audit": [0, 8, 9], "transactionsampl": [0, 8, 9], "qa_annualpeferomanceev": [0, 9], "bypqao": [0, 8, 9], "name": [0, 8, 9], "accord": [0, 9], "filter": [0, 9], "full": [0, 8, 9], "These": [0, 8, 9], "variou": [0, 9], "alphabet": [0, 9], "Not": [0, 9], "ref": [0, 9], "aqsobject": [0, 9], "type": [0, 9], "wheen": [0, 9], "bdate": [0, 9], "date": [0, 9], "begin": [0, 9], "select": [0, 9], "cbdate": [0, 9], "option": [0, 9], "last": [0, 9], "indic": [0, 9], "updat": [0, 9], "none": [0, 9], "cedat": [0, 9], "end": [0, 9], "countycod": [0, 9], "digit": [0, 9], "fip": [0, 9], "code": [0, 9], "counti": [0, 8, 9], "being": [0, 8, 9], "lead": [0, 9], "zero": [0, 9], "listfunct": [0, 9], "tabl": [0, 9], "durat": [0, 9], "string": [0, 9], "sampl": [0, 8, 9], "valu": [0, 9], "actual": [0, 9], "calcul": [0, 9], "8": [0, 9], "hour": [0, 9], "co": [0, 9], "o": [0, 9], "roll": [0, 9], "averag": [0, 9], "6": [0, 9], "dai": [0, 9], "pm": [0, 9], "pb": [0, 9], "month": [0, 9], "edat": [0, 9], "regist": [0, 9], "verif": [0, 8, 9], "specifi": [0, 9], "conjunct": [0, 9], "ma_cod": [0, 9], "4": [0, 9], "maxlat": [0, 9], "maximum": [0, 8, 9], "geograph": [0, 9], "decim": [0, 9], "north": [0, 9], "posit": [0, 9], "south": [0, 9], "maxlon": [0, 9], "east": [0, 9], "west": [0, 9], "80": [0, 9], "less": [0, 9], "70": [0, 9], "minlat": [0, 9], "minimum": [0, 9], "minlon": [0, 9], "singl": [0, 9], "datafram": [0, 9], "gov": [0, 9], "aqsweb": [0, 9], "data_api": [0, 9], "html": [0, 9], "_": [0, 9], "complet": [0, 8, 9], "through": [0, 9], "sitenum": [0, 9], "site": [0, 8, 9], "number": [0, 9], "within": [0, 8, 9], "statefip": [0, 9], "2": [0, 9], "pqao_cod": [0, 9], "two": [0, 9], "meta": [0, 9], "statu": [0, 9], "overview": [0, 9], "known": [0, 9], "issu": [0, 9], "usual": [0, 9], "identifi": [0, 9], "intern": [0, 9], "some": [0, 9], "correct": [0, 9], "queri": [0, 9], "histori": [0, 9], "group": [0, 8, 9], "By": [0, 9], "categori": [0, 9], "datat": [0, 9], "instead": [0, 9], "argument": [0, 9], "construct": [0, 9], "criteria": [0, 9], "receiv": [0, 9], "county_cod": [0, 9], "three": [0, 9], "encod": [0, 9], "contain": [0, 9], "restrict": [0, 8, 9], "amount": [0, 8, 9], "per": [0, 8, 9], "abl": [0, 8, 9], "repeat": [0, 8, 9], "There": [0, 8, 9], "5": [0, 9], "arrang": [0, 9], "10": [0, 9], "fourteen": [0, 9], "oper": [0, 9], "sampler": [0, 9], "etc": [0, 9], "fine": [0, 9], "grain": [0, 9], "report": [0, 9], "hourli": [0, 9], "sometim": [0, 9], "minut": [0, 9], "12": [0, 9], "sever": [0, 9], "geographi": [0, 9], "accept": [0, 9], "addit": [0, 9], "o_3": [0, 9], "daili": [0, 8, 9], "summari": [0, 8, 9], "summar": [0, 9], "level": [0, 9], "midnight": [0, 9], "basi": [0, 9], "local": [0, 9], "annual": [0, 8, 9], "yearli": [0, 9], "maxima": [0, 9], "percentil": [0, 9], "annualdata": [0, 8, 9], "quarterli": [0, 9], "quarterlydata": [0, 9], "blank": [0, 8, 9], "unexpos": [0, 9], "devic": [0, 9], "g": [0, 9], "transport": [0, 9], "expos": [0, 9], "assess": [0, 8, 9], "contamin": [0, 9], "dure": [0, 9], "colloc": [0, 8, 9], "pair": [0, 9], "place": [0, 9], "independ": [0, 9], "calibr": [0, 9], "audit": [0, 8, 9], "flow": [0, 8, 9], "must": [0, 9], "fix": [0, 9], "verifi": [0, 9], "measur": [0, 9], "At": [0, 9], "least": [0, 9], "twice": [0, 9], "expert": [0, 9], "One": [0, 8, 9], "point": [0, 8, 9], "raw": [0, 8, 9], "check": [0, 9], "week": [0, 9], "gaseou": [0, 9], "concentr": [0, 9], "determin": [0, 9], "perform": [0, 8, 9], "pep": [0, 8, 9], "evalu": [0, 8, 9], "estim": [0, 9], "total": [0, 9], "bia": [0, 9], "transact": [0, 8, 9], "submiss": [0, 8, 9], "rd": [0, 8, 9], "upload": [0, 9], "conduct": [0, 9], "onc": [0, 9], "percent": [0, 9], "between": [0, 9], "aqs_qa_annualperformanceev": [0, 9], "aqs_qa_annualperformanceevaltransact": [0, 9], "defin": [0, 8, 9], "censu": [0, 8, 9], "bureau": [0, 8, 9], "cbsa_cod": [0, 9], "save": [0, 9], "output": [0, 9], "anoth": [0, 9], "later": [0, 9], "thei": [0, 9], "just": [0, 9], "agenc": [1, 3, 7, 8], "refer": [1, 9], "us": [1, 2, 5, 6, 9], "data": [1, 3, 7], "mart": [1, 3, 7], "api": [1, 3, 5, 6, 7, 8], "function": [1, 3, 5, 7], "qualiti": [1, 3, 7, 8], "document": [1, 9], "user": [1, 3, 9], "pyaqsapi": [3, 5, 6, 8], "epa": [3, 6, 9], "aq": [3, 4, 7, 8, 9], "credenti": 3, "librari": [3, 9], "instal": [3, 4], "set": [3, 9], "metadata": 3, "datamart": [6, 7, 9], "raqsapi": [6, 7], "export": 7, "variabl": 7, "load": [7, 9], "monitor": [7, 8], "famili": 8, "seven": 8, "bysit": 8, "bycounti": 8, "bystat": 8, "latitud": 8, "longitud": 8, "bound": 8, "box": 8, "bybox": 8, "primari": 8, "assur": 8, "organ": 8, "core": 8, "base": 8, "statist": 8, "area": 8, "13": 8, "thirteen": 8, "dailydata": 8, "aqs_qa_flowrateaudit": 8, "list": 8, "abov": 8, "about": 9}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"pyaqsapi": [0, 2, 4, 7, 9], "user": [0, 7], "document": 0, "epa": [0, 1], "disclaim": [0, 1], "aq": [0, 1, 6], "datamart": [0, 1], "introduct": [0, 3], "about": [0, 5, 6], "timeli": [0, 6], "data": [0, 6, 8, 9], "raqsapi": [0, 5], "instal": [0, 2], "load": [0, 4], "us": [0, 7], "sign": [0, 7, 9], "up": [0, 7, 9], "set": [0, 7], "credenti": [0, 7, 9], "librari": [0, 7], "function": [0, 8, 9], "export": [0, 9], "variabl": [0, 9], "descript": [0, 9], "usag": [0, 9], "famili": [0, 9], "mart": [0, 8, 9], "api": [0, 9], "metadata": [0, 9], "list": [0, 9], "aggreg": [0, 8, 9], "bysit": [0, 9], "bycounti": [0, 9], "bystat": [0, 9], "monitor": [0, 9], "agenc": [0, 9], "ma": [0, 9], "core": [0, 9], "base": [0, 9], "statist": [0, 9], "area": [0, 9], "cbsa": [0, 9], "primari": [0, 9], "qualiti": [0, 9], "assur": [0, 9], "organ": [0, 9], "pqao": [0, 9], "latitud": [0, 9], "longitud": [0, 9], "bound": [0, 9], "box": [0, 9], "bybox": [0, 9], "miscellan": [0, 9], "refer": 0, "index": 0}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinxcontrib.bibtex": 9, "sphinx": 60}, "alltitles": {"pyaqsapi user documentation": [[0, "pyaqsapi-user-documentation"]], "EPA Disclaimer": [[0, "epa-disclaimer"], [1, "epa-disclaimer"]], "AQS DataMart Disclaimer": [[0, "aqs-datamart-disclaimer"], [1, "aqs-datamart-disclaimer"]], "Introduction": [[0, "introduction"], [3, "introduction"]], "About the timeliness of AQS Data": [[0, "about-the-timeliness-of-aqs-data"], [6, "about-the-timeliness-of-aqs-data"]], "About RAQSAPI": [[0, "about-raqsapi"], [5, "about-raqsapi"]], "Install pyaqsapi": [[0, "install-pyaqsapi"], [2, "install-pyaqsapi"]], "Load pyaqsapi": [[0, "load-pyaqsapi"], [4, "load-pyaqsapi"]], "Using pyaqsapi": [[0, "using-pyaqsapi"], [7, "using-pyaqsapi"]], "Sign up and setting up user credentials with the pyaqsapi library": [[0, "sign-up-and-setting-up-user-credentials-with-the-pyaqsapi-library"], [7, "sign-up-and-setting-up-user-credentials-with-the-pyaqsapi-library"]], "Functions Exported by pyaqsapi": [[0, "functions-exported-by-pyaqsapi"], [9, "functions-exported-by-pyaqsapi"]], "Variable descriptions and usage": [[0, "variable-descriptions-and-usage"], [9, "variable-descriptions-and-usage"]], "pyaqsapi functional families": [[0, "pyaqsapi-functional-families"], [9, "pyaqsapi-functional-families"]], "Sign up and credentials": [[0, "sign-up-and-credentials"], [9, "sign-up-and-credentials"]], "Data Mart API metadata functions": [[0, "data-mart-api-metadata-functions"], [9, "data-mart-api-metadata-functions"]], "Data Mart API list functions": [[0, "data-mart-api-list-functions"], [9, "data-mart-api-list-functions"]], "Data Mart aggregate functions": [[0, "data-mart-aggregate-functions"], [8, "data-mart-aggregate-functions"], [9, "data-mart-aggregate-functions"]], "Data Mart aggregate functions bysite": [[0, "data-mart-aggregate-functions-bysite"], [9, "data-mart-aggregate-functions-bysite"]], "Data Mart aggregate functions bycounty": [[0, "data-mart-aggregate-functions-bycounty"], [9, "data-mart-aggregate-functions-bycounty"]], "Data Mart aggregate functions bystate": [[0, "data-mart-aggregate-functions-bystate"], [9, "data-mart-aggregate-functions-bystate"]], "Data Mart aggregate functions by Monitoring agency (MA)": [[0, "data-mart-aggregate-functions-by-monitoring-agency-ma"], [9, "data-mart-aggregate-functions-by-monitoring-agency-ma"]], "Data Mart aggregate functions by Core Based Statistical Area (cbsa)": [[0, "data-mart-aggregate-functions-by-core-based-statistical-area-cbsa"], [9, "data-mart-aggregate-functions-by-core-based-statistical-area-cbsa"]], "Data Mart aggregate functions by Primary Quality Assurance Organization (pqao)": [[0, "data-mart-aggregate-functions-by-primary-quality-assurance-organization-pqao"], [9, "data-mart-aggregate-functions-by-primary-quality-assurance-organization-pqao"]], "Data Mart aggregate functions by latitude/longitude bounding box (bybox)": [[0, "data-mart-aggregate-functions-by-latitude-longitude-bounding-box-bybox"], [9, "data-mart-aggregate-functions-by-latitude-longitude-bounding-box-bybox"]], "pyaqsapi Miscellaneous functions": [[0, "pyaqsapi-miscellaneous-functions"], [9, "pyaqsapi-miscellaneous-functions"]], "pyaqsapi API reference documentation": [[0, "pyaqsapi-api-reference-documentation"]], "pyaqsapi index": [[0, "pyaqsapi-index"]]}, "indexentries": {"epa disclaimer": [[0, "index-0"], [1, "index-0"]], "functions exported by pyaqsapi": [[0, "index-7"], [9, "index-0"]], "raqsapi": [[0, "index-2"], [5, "index-0"]], "install pyaqsapi": [[0, "index-3"], [2, "index-0"]], "load pyaqsapi": [[0, "index-4"], [4, "index-0"]], "sign_up": [[0, "index-6"], [7, "index-1"]], "timeliness of aqs data": [[0, "index-1"], [6, "index-0"]], "use pyaqsapi": [[0, "index-5"], [7, "index-0"]], "aggregate functions": [[8, "index-0"]], "services": [[8, "index-1"]]}}) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 58a038b..a730a87 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,13 +36,14 @@ "numpydoc", "sphinx.ext.napoleon", "sphinxcontrib.bibtex", + "sphinx.ext.autosectionlabel", ] # bibtext file location bibtex_bibfiles = ["manual/pyaqsapi.bib"] # Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] +# templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -54,8 +55,14 @@ "setup.py", "*modules.rst", "*setup.rst", + "pyaqsapi*.rst", + "*pyaqsapiFunctions-Brief.rst", + "genindex.rst", ] +# get rid of those duplicate label warnings when embedding a child rst file +# into another rst file. +suppress_warnings = ["autosectionlabel.*"] # -- Options for HTML output -------------------------------------------------- diff --git a/docs/genindex.rst b/docs/genindex.rst new file mode 100644 index 0000000..66a2352 --- /dev/null +++ b/docs/genindex.rst @@ -0,0 +1,2 @@ +Index +===== \ No newline at end of file diff --git a/docs/ignored_wordlist.txt b/docs/ignored_wordlist.txt index 6b6197c..349fd37 100644 --- a/docs/ignored_wordlist.txt +++ b/docs/ignored_wordlist.txt @@ -1,7 +1,7 @@ annualdata annualsummary -annualpeferomanceeval -annualpeferomanceevaltransaction +annualperformanceeval +annualperformanceevaltransaction aqs Barnstable bdate @@ -29,6 +29,8 @@ flowrateaudit flowrateverification Gastonia helperfunctions +isavailable +knownissues listfunctions maxima maxlat @@ -46,8 +48,11 @@ pyaqsapiFunctions qa qc quarterly +quarterlydata quarterlysummary RAQSAPI +removeheader +revisionhistory rst sampledata sampleduration diff --git a/docs/index.rst b/docs/index.rst index 08a44d9..8745d98 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,12 +3,16 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +.. sectionauthor:: Clinton Mccrowey epa.gov> + +=========================== +pyaqsapi user documentation +=========================== -pyaqsapi's documentation -========================= .. toctree:: :maxdepth: 2 :numbered: + :hidden: .. include:: manual/EPA_Disclaimer.rst .. include:: manual/Introduction.rst @@ -19,12 +23,17 @@ pyaqsapi's documentation .. include:: manual/Using_pyaqsapi.rst .. This is temporary until the long version is finished -.. include:: manual/pyaqsapiFunctions-Brief.rst +.. +.. include:: manual/pyaqsapiFunctions-Long.rst + pyaqsapi API reference documentation -==================================== +------------------------------------ + * :ref:`modindex` -Index -===== + +pyaqsapi index +-------------- + * :ref:`genindex` diff --git a/docs/manual/pyaqsapiFunctions-Brief.rst b/docs/manual/pyaqsapiFunctions-Brief.rst index dd38309..0a972a6 100644 --- a/docs/manual/pyaqsapiFunctions-Brief.rst +++ b/docs/manual/pyaqsapiFunctions-Brief.rst @@ -1,4 +1,4 @@ -.. index:: pyaqsapi aggregate functions (brief) +:orphan: Data Mart aggregate functions ============================= @@ -34,25 +34,24 @@ Note that not all aggregations are available for each service. These thirteen services are: - - \ Monitors (\*monitors) - - \ Sample Data (\*sampledata) - - \ Daily Summary Data (\*dailydata) - - \ Annual Summary Data (annualdata) - - \ Quality Assurance - Blanks Data (\*qa_blanks) - - \ Quality Assurance - Collocated Assessments - (\*qa_collocated_assessments) - - \ Quality Assurance - Flow Rate Verifications (\*qa_flowrateverification) - - \ Quality Assurance - Flow Rate Audits (\*aqs_qa_flowrateaudit) - - \ Quality Assurance - One Point Quality Control Raw Data - (\*qa_one_point_qc) - - \ Quality Assurance - PEP Audits (\*qa_pep_audit) - - \ Transaction Sample - AQS Submission data in transaction Format (RD) - (\*transactionsample) - - \ Quality Assurance - Annual Performance Evaluations - (\*qa_annualpeferomanceeval) - - \ Quality Assurance - Annual Performance Evaluations in the AQS - \ Submission transaction format (RD) - \ (\*qa_annualpeferomanceevaltransaction) + * Monitors (monitors) + * Sample Data (sampledata) + * Daily Summary Data (dailydata) + * Annual Summary Data (annualdata) + * Quality Assurance - Blanks Data (qa_blanks) + * Quality Assurance - Collocated Assessments + (qa_collocated_assessments) + * Quality Assurance - Flow Rate Verifications (qa_flowrateverification) + * Quality Assurance - Flow Rate Audits (aqs_qa_flowrateaudit) + * Quality Assurance - One Point Quality Control Raw Data + (qa_one_point_qc) + * Quality Assurance - PEP Audits (qa_pep_audit) + * Transaction Sample - AQS Submission data in transaction Format (RD) + (transactionsample) + * Quality Assurance - Annual Performance Evaluations + (qa_annualperformanceeval) + * Quality Assurance - Annual Performance Evaluations in the AQS + Submission transaction format (RD) (qa_annualperformanceevaltransaction) Aggregate functions are named aqs..() where diff --git a/docs/manual/pyaqsapiFunctions-Long.rst b/docs/manual/pyaqsapiFunctions-Long.rst new file mode 100644 index 0000000..7da7e15 --- /dev/null +++ b/docs/manual/pyaqsapiFunctions-Long.rst @@ -0,0 +1,841 @@ +.. index:: Functions Exported by pyaqsapi + +Functions Exported by pyaqsapi +==================================================== +The pyaqsapi package includes the following submodules which are not +loaded by default: +:: + +* pyaqsapi.bysite +* pyaqsapi.bycounty +* pyaqsapi.bycounty +* pyaqsapi.bycbsa +* pyaqsapi.bybox +* pyaqsapi.byma +* pyaqsapi.ma + +With these submodules loaded to entire list of functions exported by the +pyaqsapi package includes: + +:: + +* pyaqsapi.aqs_cbsas, +* pyaqsapi.aqs_classes, +* pyaqsapi.aqs_counties_by_state, +* pyaqsapi.aqs_credentials, +* pyaqsapi.aqs_credentials, +* pyaqsapi.aqs_fields_by_service, +* pyaqsapi.aqs_fields_by_service, +* pyaqsapi.aqs_isavailable, +* pyaqsapi.aqs_isavailable, +* pyaqsapi.aqs_knownissues, +* pyaqsapi.aqs_knownissues, +* pyaqsapi.aqs_mas, +* pyaqsapi.aqs_parameters_by_class, +* pyaqsapi.aqs_pqaos, +* pyaqsapi.aqs_removeheader, +* pyaqsapi.aqs_revisionhistory, +* pyaqsapi.aqs_revisionhistory, +* pyaqsapi.aqs_sampledurations, +* pyaqsapi.aqs_sign_up, +* pyaqsapi.aqs_sign_up, +* pyaqsapi.aqs_sites_by_county, +* pyaqsapi.aqs_states, +* pyaqsapi.bybox.annualsummary, +* pyaqsapi.bybox.dailysummary, +* pyaqsapi.bybox.helperfunctions, +* pyaqsapi.bybox.monitors, +* pyaqsapi.bybox.quarterlysummary, +* pyaqsapi.bybox.sampledata, +* pyaqsapi.bycbsa.annualsummary, +* pyaqsapi.bycbsa.dailysummary, +* pyaqsapi.bycbsa.helperfunctions, +* pyaqsapi.bycbsa.monitors, +* pyaqsapi.bycbsa.quarterlysummary, +* pyaqsapi.bycbsa.sampledata, +* pyaqsapi.bycounty.annualsummary, +* pyaqsapi.bycounty.dailysummary, +* pyaqsapi.bycounty.helperfunctions, +* pyaqsapi.bycounty.monitors, +* pyaqsapi.bycounty.qa_annualperformanceeval, +* pyaqsapi.bycounty.qa_annualperformanceevaltransaction, +* pyaqsapi.bycounty.qa_blanks, +* pyaqsapi.bycounty.qa_collocated_assessments, +* pyaqsapi.bycounty.qa_flowrateaudit, +* pyaqsapi.bycounty.qa_flowrateverification, +* pyaqsapi.bycounty.qa_one_point_qc, +* pyaqsapi.bycounty.qa_pep_audit, +* pyaqsapi.bycounty.quarterlysummary, +* pyaqsapi.bycounty.sampledata, +* pyaqsapi.bycounty.transactionsample, +* pyaqsapi.byma.qa_annualpeferomanceeval, +* pyaqsapi.byma.qa_annualperformanceevaltransaction, +* pyaqsapi.byma.qa_blanks, +* pyaqsapi.byma.qa_collocated_assessments, +* pyaqsapi.byma.qa_flowrateaudit, +* pyaqsapi.byma.qa_flowrateverification, +* pyaqsapi.byma.qa_one_point_qc, +* pyaqsapi.byma.qa_pep_audit, +* pyaqsapi.byma.transactionsample, +* pyaqsapi.bypqao.qa_annualperformanceeval, +* pyaqsapi.bypqao.qa_annualperformanceevaltransaction, +* pyaqsapi.bypqao.qa_blanks, +* pyaqsapi.bypqao.qa_collocated_assessments, +* pyaqsapi.bypqao.qa_flowrateaudit, +* pyaqsapi.bypqao.qa_flowrateverification, +* pyaqsapi.bypqao.qa_one_point_qc, +* pyaqsapi.bypqao.qa_pep_audit, +* pyaqsapi.bysite.annualsummary, +* pyaqsapi.bysite.dailysummary, +* pyaqsapi.bysite.helperfunctions, +* pyaqsapi.bysite.monitors, +* pyaqsapi.bysite.qa_annualpeferomanceeval, +* pyaqsapi.bysite.qa_annualperformanceevaltransaction, +* pyaqsapi.bysite.qa_blanks, +* pyaqsapi.bysite.qa_collocated_assessments, +* pyaqsapi.bysite.qa_flowrateaudit, +* pyaqsapi.bysite.qa_flowrateverification, +* pyaqsapi.bysite.qa_one_point_qc, +* pyaqsapi.bysite.qa_pep_audit, +* pyaqsapi.bysite.quarterlysummary, +* pyaqsapi.bysite.sampledata, +* pyaqsapi.bysite.transactionsample, +* pyaqsapi.bystate.annualsummary, +* pyaqsapi.bystate.dailysummary, +* pyaqsapi.bystate.helperfunctions, +* pyaqsapi.bystate.monitors, +* pyaqsapi.bystate.qa_annualperformanceeval, +* pyaqsapi.bystate.qa_annualperformanceevaltransaction, +* pyaqsapi.bystate.qa_blanks, +* pyaqsapi.bystate.qa_collocated_assessments, +* pyaqsapi.bystate.qa_flowrateaudit, +* pyaqsapi.bystate.qa_flowrateverification, +* pyaqsapi.bystate.qa_one_point_qc, +* pyaqsapi.bystate.qa_pep_audit, +* pyaqsapi.bystate.quarterlysummary, +* pyaqsapi.bystate.sampledata, +* pyaqsapi.bystate.transactionsample + + +pyaqsapi functions are named according to the service and filter variables that +are available by the AQS Data Mart API. Refer to `Air Quality System (AQS) API +`_ for full details of the +AQS DataMart API. + + +Variable descriptions and usage +=============================== +These are all the available variables that can be used with various functions +exported from the pyaqsapi library listed alphabetically. Not all of these +variables are used with every function, and not all of these parameters are +required. See the :ref: `pyaqsapi functional families` section to +see which parameters are used with each function. + +* AQSobject: + an object of type AQSAPI_V2 that is returned from pyaqsapi + aggregate functions wheen return_header is True. + +* bdate: + a date object which represents the begin date of the data selection. + Only data on or after this date will be returned. + +* cbdate (optional): + a date object which represents the "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. + +* cedate (optional): + a date object which represents the "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. + +* countycode: + a character object which represents the 3 digit state FIPS code for the + county being requested (with leading zero(s)). Refer to + :ref: `listfunctions` for a table of available county codes for each state. + +* duration (optional): + a character string that represents the parameter duration code that limits + returned data to a specific sample duration. The default value of None + will result in no filtering based on duration code. Valid durations + include actual sample durations and not calculated durations such as 8 hour + CO or O\ :sub:`3`\ rolling averages, 3/6 day PM averages or Pb 3 month + rolling averages. Refer to :ref: `aqs_sampledurations()` for a table of all + available duration codes. + +* edate: + a date object which represents the end date of the data selection. Only + data on or before this date will be returned. + +* email: + a character object which represents the email account that will be used to + register with the AQS API or change an existing user's key. A verification + email will be sent to the account specified. + +* key: + a character object which represents the key used in conjunction with the + username given to connect to AQS Data Mart. + +* MA_code: + a character object which represents the 4 digit AQS Monitoring Agency code + (with leading zeroes). + +* maxlat: + a character object which represents the maximum latitude of a geographic + box. Decimal latitude with north begin positive. Only data south of this + latitude will be returned. + +* maxlon: + a character object which represents the maximum longitude of a + geographic box. Decimal longitude with east being positive. Only + data west of this longitude will be returned. Note that -80 is less + than -70. + +* minlat: + a character object which represents the minimum latitude of a + geographic box. Decimal latitude with north being positive. + Only data north of this latitude will be returned. + +* minlon: + a character object which represents the minimum longitude of a + geographic box. Decimal longitude with east begin positive. Only + data east of this longitude will be returned. + +* parameter: + a character list or single character object which represents the parameter + code of the air pollutant related to the data being requested. + +* return_Header: + If False (default) only returns data requested as a pandas DataFrame. If + True returns a AQSAPI_V2 object. + +* service: + a string which represents the services provided by the AQS API. For a list + of available services refer to + `_` + for the complete listing of services available through the EPA + AQS Datamart API + +* sitenum: + a character object which represents the 4 digit site number (with + leading zeros) within the county and state being requested. + +* stateFIPS: + a character object which represents the 2 digit state FIPS code + (with leading zero) for the state being requested. + +* pqao_code: + a character object which represents the 4 digit AQS Primary Quality + Assurance Organization code (with leading zeroes). + +* username: + a character object which represents the email account that will be used to + connect to the AQS API. + +pyaqsapi functional families +============================ + +Sign up and credentials +----------------------- +The functions included in this family of functions are: + +:: + +* aqs_credentials +* aqs_sign_up + +These functions are used to sign up with Data Mart and to store credential + information to use with pyaqsapi. The aqs_sign_up function takes + one parameter: + +* email: + +The aqs_credentials function takes two parameters: + +* username: +* key: + +Data Mart API metadata functions +-------------------------------- +The functions included in this family of functions are: + +:: + +* aqs_isavailable +* aqs_knownissues +* aqs_fields_by_service +* aqs_revisionhistory + +These functions return Data Mart meta data + +The aqs_isavailable function takes no parameters and returns a + table which details the status of the AQS API. + +The aqs_fields_by_service function takes one parameter, service, + which is a character object which represents the services provided by + the AQS API. For a list of available services see + `Air Quality System (AQS) API - Services Overview + `_ + +The aqs_knownissues function takes no parameters and Returns a + table of any known issues with system functionality or the data. These are + usually issues that have been identified internally and will require some + time to correct in Data Mart or the API. This function implements a direct + API call to Data Mart and returns data directly from the API. Issues + returned via this function do not include any issues from the pyaqsapi + package. + +The aqs_revisionhistory function is used to query Data Mart for the + change history to the API. + +Data Mart API list functions +---------------------------- +The functions included in this family of functions are: +:: + +* aqs_cbsas, +* aqs_classes, +* aqs_counties_by_state, +* aqs_fields_by_service, +* aqs_isavailable, +* aqs_knownissues, +* aqs_mas, +* aqs_parameters_by_class, +* aqs_pqaos, +* aqs_revisionhistory, +* aqs_sampledurations, +* aqs_sites_by_county, +* aqs_states + + +List functions return the API status, API options or groupings that can be used + in conjunction with other API calls. By default each function in this + category returns results as a DataTable. If return_header parameter is set + to True a AQSAPI_v2 object is returned instead. + +aqs_cbsas returns a table of all available Core Based Statistical + Areas (cbsas) and their respective cbsa codes. + +aqs_states takes no arguments and returns a table of the available + states and their respective state FIPS codes. + +aqs_sampledurations takes no arguments and returns a table of the + available sample duration code used to construct other requests. + +aqs_classes takes no arguments and returns a table of parameter + classes (groups of parameters, i.e. "criteria" or "all"). + +aqs_counties_by_state takes one parameter, stateFIPS, which is a two + digit state FIPS code for the state being requested represented as a + character object and returns a table of counties and their + respective FIPS code for the state requested. Use aqs_states to + receive a table of valid state FIPS codes. + +aqs_sites_by_county takes two parameters, stateFIPS, which is a + two digit state FIPS code for the state being requested and county_code + which is a three digit county FIPS code for the county being requested, + both stateFIPS and county_code should be encoded as a character object. + This function returns a table of all air monitoring sites with the + requested state and county FIPS code combination. + +aqs_pqaos takes no parameters and returns an AQSAPI_V2 + object containing a table of primary quality assurance + organizations (pqaos). + +aqs_mas takes no parameters and returns an AQSAPI_V2 + object containing a table of monitoring agencies (MA). + +Data Mart aggregate functions +----------------------------- + +..note:: + AQS Data Mart API restricts the maximum amount of monitoring data to one + full year of data per API call. These functions are able to return multiple + years of data by making repeated calls to the API. Each call to the Data + Mart API will take time to complete. The more years of data being requested + the longer pyaqsapi will take to return the results. + +These functions retrieve aggregated data from the Data Mart API and are + grouped by how each function aggregates the data. There are 5 different + families of related aggregate functions. These families are arranged by how + the Data Mart API groups the returned data, bysite, bycounty, bystate, + by (bybox) and + by (bycbsa). Within each family + of aggregated data functions there are functions that call on the 10 + different services that the Data Mart API provides. All Aggregate + functions return a pandas DataFrame by default. If the return_Header + parameter is set to True an AQSAPI_V2 object is returned instead. + +These fourteen services are: + +1. **Monitors**: Returns operational information about the samplers (monitors) + used to collect the data. Includes identifying information, + operational dates, operating organizations, etc. Functions + using this service contain monitors in the function + name. + +2. **Sample Data**: Returns sample data - the most fine grain data reported to + EPA. Usually hourly, sometimes 5-minute, 12-hour, etc. + This service is available in several geographic selections + based on geography: site, county, state, cbsa (core based + statistical area, a grouping of counties), or + by latitude/longitude bounding box. Functions using this + service contain sampledata in the function name. + All Sample Data functions accept two additional, optional + parameters; cbdate and cedate. + + + cbdate: a 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. + + + cedate: a 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. + + + duration: an optional character string that represents the parameter + duration code that limits returned data to + a specific sample duration. The default value of + None results in no filtering based on + duration code. Valid durations include actual sample + durations and not calculated durations such as 8 hour + CO or $O_3$ rolling averages, 3/6 day PM averages or + Pb 3 month rolling averages. Refer to + [aqs_sampledurations()] for a list of all available + duration codes. + +3. **Daily Summary Data**: Returns data summarized at the daily level. All daily + summaries are calculated on midnight to midnight + basis in local time. Variables returned include + date, mean value, maximum value, etc. Functions + using this service contain Dailysummary in + the function name. All Daily Summary Data functions + accept two additional parameters; cbdate and cedate + + + cbdate: a 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. + + + cedate: a 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. + +4. **Annual Summary Data**: Returns data summarized at the yearly level. + Variables include mean value, maxima, + percentiles, etc. Functions using this service + contain annualdata in the function name. All + Annual Summary Data functions accept two + additional parameters; cbdate and cedate. + + + cbdate: a 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. + + + cedate: a 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. + +5. **Quarterly Summary Data**: Returns data summarized at the quarterly level. + Variables include mean value, maxima, + percentiles, etc. Functions using this service + contain quarterlydata in the function name. All + Annual Summary Data functions accept two + additional parameters; cbdate and cedate. + + + cbdate: a 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. + + + cedate: a 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. + +6. **Quality Assurance - Blanks Data**: + Quality assurance data - blanks samples. + 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. Functions using this service contain + qa_blanks in the function name. + +7. **Quality Assurance - Collocated Assessments**: + Quality assurance data - collocated assessments. + Collocated assessments are pairs of samples + collected by different samplers at the same time + and place. (These are "operational" samplers, + assessments with independently calibrated samplers + are called "audits".). Functions using this service + contain qa_collocated_assessments in the + function name. + +8. **Quality Assurance - Flow Rate Verifications**: + Quality assurance data - flow rate verifications. + Several times per year, each PM monitor must have + it's (fixed) flow rate verified by an operator taking + a measurement of the flow rate. Functions using this + service contain qa_flowrateverification in + the function name. + +9. **Quality Assurance - Flow Rate Audits**: + Quality assurance data - flow rate audits. At least twice + year, each PM monitor must have it's flow rate + measurement audited by an expert using a different + method than is used for flow rate verifications. + Functions using this service contain + qa_flowrateaudit in the function name. + +10. **Quality Assurance - One Point Quality Control Raw Data**: + Quality assurance data - one point quality control check + raw data. At least every two weeks, certain gaseous + monitors must be challenged with a known concentration to + determine monitor performance. Functions using this + service contain qa_one_point_qc in the function + name. + +11. **Quality Assurance - pep Audits**: + Quality assurance data - performance evaluation program + (pep) audits. pep audits are independent assessments used + to estimate total measurement system bias with a primary + quality assurance organization. Functions using this + service contain qa_pep_audit in the function + name. + +12. **Transaction Sample - AQS Submission data in transaction format (RD)**: + Transaction sample data - The raw transaction sample data + uploaded to AQS by the agency responsible for data + submissions in RD format. Functions using this + service contain transactionsample in the + function name. Transaction sample data is only available + aggregated by site, county, state or monitoring agency. + +13. **Quality Assurance - Annual Performance Evaluations**: + Quality assurance data - Annual performance evaluations. + A performance evaluation must be conducted on each primary + monitor once per year. The percent differences between + known and measured concentrations at several levels are + used to assess the quality of the monitoring data. + Functions using this service contain + aqs_qa_annualperformanceeval in the function + name. Annual performance in transaction format are + only available aggregated by site, county, state, + monitoring agency, and primary quality assurance + organization. Annual performance evaluations are only + available aggregated by site, county, state, + monitoring agency, and primary quality assurance + organization. + +14. **Quality Assurance - Annual performance Evaluations in transaction** \ + **format (RD)**: + Quality assurance data - The raw transaction annual + performance evaluations data in RD format. Functions using + this service contain + aqs_qa_annualperformanceevaltransaction in the + function name. Annual performance evaluations in transaction + format are only available aggregated by site, county, state, + monitoring agency, and primary quality assurance + organization. + + +Data Mart aggregate functions bysite +-------------------------------------- +The pyaqsapi.bysite module exports the following functions: +:: + +* bysite.annualsummary, +* bysite.dailysummary, +* bysite.helperfunctions, +* bysite.monitors, +* bysite.qa_annualpeferomanceeval, +* bysite.qa_annualperformanceevaltransaction, +* bysite.qa_blanks, +* bysite.qa_collocated_assessments, +* bysite.qa_flowrateaudit, +* bysite.qa_flowrateverification, +* bysite.qa_one_point_qc, +* bysite.qa_pep_audit, +* bysite.quarterlysummary, +* bysite.sampledata, +* bysite.transactionsample + +Functions in this family of functions aggregate data at the site level. All + bysite functions accept the following variables: + +* parameter: +* bdate: +* edate: +* stateFIPS: +* countycode: +* sitenum: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata functions and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata functions and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +Data Mart aggregate functions bycounty +---------------------------------------- +The pyaqsapi.bycounty module exports the following functions: +:: + +* bycounty.annualsummary, +* bycounty.dailysummary, +* bycounty.helperfunctions, +* bycounty.monitors, +* bycounty.qa_annualperformanceeval, +* bycounty.qa_annualperformanceevaltransaction, +* bycounty.qa_blanks, +* bycounty.qa_collocated_assessments, +* bycounty.qa_flowrateaudit, +* bycounty.qa_flowrateverification, +* bycounty.qa_one_point_qc, +* bycounty.qa_pep_audit, +* bycounty.quarterlysummary, +* bycounty.sampledata, +* bycounty.transactionsample + +Functions in this family of functions aggregate data at the county level. + All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* stateFIPS: +* countycode: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +Data Mart aggregate functions bystate +--------------------------------------- +The pyaqsapi.bystate module exports the following functions: +:: + +* bystate.annualsummary, +* bystate.dailysummary, +* bystate.helperfunctions, +* bystate.monitors, +* bystate.qa_annualperformanceeval, +* bystate.qa_annualperformanceevaltransaction, +* bystate.qa_blanks, +* bystate.qa_collocated_assessments, +* bystate.qa_flowrateaudit, +* bystate.qa_flowrateverification, +* bystate.qa_one_point_qc, +* bystate.qa_pep_audit, +* bystate.quarterlysummary, +* bystate.sampledata, +* bystate.transactionsample + +Functions in this family of functions aggregate data at the state level. + All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* stateFIPS: +* countycode: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +Data Mart aggregate functions by Monitoring agency (MA) +------------------------------------------------------- +The pyaqsapi.byma module exports the following functions: +:: + +* byma.qa_annualpeferomanceeval, +* byma.qa_annualperformanceevaltransaction, +* byma.qa_blanks, +* byma.qa_collocated_assessments, +* byma.qa_flowrateaudit, +* byma.qa_flowrateverification, +* byma.qa_one_point_qc, +* byma.qa_pep_audit, +* byma.transactionsample + +Functions in this family of functions aggregate data at the state level. + All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* stateFIPS: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata functions and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + + +functions in this family of functions aggregate data at the Monitoring Agency + (MA) level. All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* MA_code: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +Data Mart aggregate functions by Core Based Statistical Area (cbsa) +------------------------------------------------------------------- +The pyaqsapi.bycbsa module exports the following functions: +:: + +* bycbsa.annualsummary, +* bycbsa.dailysummary, +* bycbsa.helperfunctions, +* bycbsa.monitors, +* bycbsa.quarterlysummary, +* bycbsa.sampledata + +Functions in this family of functions aggregate data at the Core Based + Statistical Area (cbsa, as defined by the US Census Bureau) level. + All functions accept the following variables: + +* parameter: +* bdate: +* edate: +* cbsa_code: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + + +Data Mart aggregate functions by Primary Quality Assurance Organization (pqao) +------------------------------------------------------------------------------ +The pyaqsapi.bypqao module exports the following functions: +:: + +* bypqao.qa_annualperformanceeval, +* bypqao.qa_annualperformanceevaltransaction, +* bypqao.qa_blanks, +* bypqao.qa_collocated_assessments, +* bypqao.qa_flowrateaudit, +* bypqao.qa_flowrateverification, +* bypqao.qa_one_point_qc, +* bypqao.qa_pep_audit + +Functions in this family of functions aggregate data at the Primary Quality + Assurance Organization (pqao) level. All functions accept the following + variables: + +* parameter: +* bdate: +* edate: +* pqao_code: +* return_header (optional): set to False by default. + +Data Mart aggregate functions by latitude/longitude bounding box (bybox) +-------------------------------------------------------------------------- +The pyaqsapi.bybox module exports the following functions: +:: + +* bybox.annualsummary, +* bybox.dailysummary, +* bybox.helperfunctions, +* bybox.monitors, +* bybox.quarterlysummary, +* bybox.sampledata + +Functions in this family of functions aggregate data by a + latitude/longitude bounding box (bybox) level. All functions accept the + following variables: + +* parameter: +* bdate: +* edate: +* minlat: +* minlon: +* maxlon: +* maxlat: +* cbdate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* cedate (optional): (This parameter is only used in conjunction with + sampledata, dailysummary, + annualdata and + quarterlysummary functions). +* return_header (optional): set to False by default. +* duration (optional): (This parameter is only used in conjunction with + sampledata functions). + +pyaqsapi Miscellaneous functions +-------------------------------- + +These are miscellaneous functions exported by pyaqsapi. + +aqs_removeheader is the function that the pyaqsapi library +uses internally to coerce an AQSAPI_V2 object into a pandas DataFrame. +This is useful if the user saves the output from another pyaqsapi function +with return_header = True set but later decides that they want just a +simple pandas DataFrame object. This function takes only one variable: + +* AQSobject: + + diff --git a/docs/modules.rst b/docs/modules.rst index 6610862..6b67e55 100644 --- a/docs/modules.rst +++ b/docs/modules.rst @@ -1,5 +1,5 @@ -pyaqsapi -======== +pyaqsapi Reference API Documentation +==================================== .. toctree:: :maxdepth: 4 diff --git a/docs/pyaqsapi.rst b/docs/pyaqsapi.rst index 05090ed..b2cad20 100644 --- a/docs/pyaqsapi.rst +++ b/docs/pyaqsapi.rst @@ -1,8 +1,30 @@ -pyaqsapi package +pyaqsapi API reference documentation ================ -Submodules ----------- +pyaqsapi base Package +~~~~~~~~~~~~~~~~~~~~~ +.. automodule:: pyaqsapi.helperfunctions + :members: + :undoc-members: + :show-inheritance: + +.. automodule:: pyaqsapi.listfunctions + :members: + :undoc-members: + :show-inheritance: + +.. automodule:: pyaqsapi.metadatafunctions + :members: + :undoc-members: + :show-inheritance: + +.. automodule:: pyaqsapi.setupfunctions + :members: + :undoc-members: + :show-inheritance: + +pyaqsapi Submodules +------------------- pyaqsapi.bybox.bybox module ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/pycodestlyecheck.txt b/docs/pycodestlyecheck.txt deleted file mode 100644 index e69de29..0000000