fix trivial issues in documentation, update copyright year, run black

LICENSE.rst

@@ -1,7 +1,7 @@
 MIT License
 -----------
 
-Copyright (c) 2023 United State Environmental Protection Agency
+Copyright (c) 2024 United State Environmental Protection Agency
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -143,7 +143,7 @@ method to retrieve header information.
 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,[2] this function takes one input, “email,” which
+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
 to use as a user credential to the AQS Data Mart service. After a successful
 call to aqs_sign_up an email message will be sent to the email address provided

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: 5bf8cd74b4b18152df948e47bb3beeec
+config: 3cebc56d58d6ed3f3392a68420c06fa8
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_sources/index.rst.txt

@@ -17,7 +17,8 @@ pyaqsapi's documentation
 .. include:: manual/Install_pyaqsapi.rst
 .. include:: manual/Load_pyaqsapi.rst
 .. include:: manual/Using_pyaqsapi.rst
-#this is temporary until the Long version is finished
+..
+    This is temporary until the long version is finished
 .. include:: manual/pyaqsapiFunctions-Brief.rst
 
 pyaqsapi API reference documentation

docs/_build/html/_sources/manual/Introduction.rst.txt

@@ -1,4 +1,3 @@
-============
 Introduction
 ============
 The pyaqsapi module for the python 3 programming environment allows a python 3

docs/_build/html/_sources/manual/Using_pyaqsapi.rst.txt

@@ -18,7 +18,7 @@ method to retrieve header information.
 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,[2] this function takes one input, “email,” which
+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
 to use as a user credential to the AQS Data Mart service. After a successful
 call to aqs_sign_up an email message will be sent to the email address provided

docs/_build/html/genindex.html

@@ -88,7 +88,7 @@ <h1 id="index">Index</h1>
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="manual/pyaqsapiFunctions-Brief.html#index-1">aggregate functions</a>
+      <li><a href="index.html#index-8">aggregate functions</a>, <a href="manual/pyaqsapiFunctions-Brief.html#index-1">[1]</a>
 </li>
       <li><a href="pyaqsapi.bybox.html#pyaqsapi.bybox.bybox.annualsummary">annualsummary() (in module pyaqsapi.bybox.bybox)</a>, <a href="pyaqsapi.html#pyaqsapi.bybox.bybox.annualsummary">[1]</a>
 
@@ -275,7 +275,7 @@ <h2 id="M">M</h2>
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="manual/pyaqsapiFunctions-Brief.html#index-0">pyaqsapi aggregate functions (brief)</a>
+      <li><a href="index.html#index-7">pyaqsapi aggregate functions (brief)</a>, <a href="manual/pyaqsapiFunctions-Brief.html#index-0">[1]</a>
 </li>
       <li>
     pyaqsapi.bybox
@@ -551,7 +551,7 @@ <h2 id="S">S</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="manual/pyaqsapiFunctions-Brief.html#index-2">services</a>
+      <li><a href="index.html#index-9">services</a>, <a href="manual/pyaqsapiFunctions-Brief.html#index-2">[1]</a>
 </li>
       <li><a href="pyaqsapi.html#pyaqsapi.helperfunctions.AQSAPI_V2.set_data">set_data() (pyaqsapi.helperfunctions.AQSAPI_V2 method)</a>
 </li>
@@ -597,7 +597,7 @@ <h2 id="U">U</h2>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/index.html

@@ -46,16 +46,15 @@
               <div class="local-toc"><ul>
 <li><a class="reference internal" href="#">pyaqsapi's documentation</a></li>
 <li><a class="reference internal" href="#epa-disclaimer">EPA Disclaimer</a></li>
-<li><a class="reference internal" href="#aqs-datamart-disclaimer">AQS DataMart Disclaimer</a><ul>
+<li><a class="reference internal" href="#aqs-datamart-disclaimer">AQS DataMart Disclaimer</a></li>
 <li><a class="reference internal" href="#introduction">Introduction</a></li>
-</ul>
-</li>
 <li><a class="reference internal" href="#about-the-timeliness-of-aqs-data">About the timeliness of AQS Data</a></li>
 <li><a class="reference internal" href="#about-raqsapi">About RAQSAPI</a></li>
 <li><a class="reference internal" href="#install-pyaqsapi">Install pyaqsapi</a></li>
 <li><a class="reference internal" href="#load-pyaqsapi">Load pyaqsapi</a></li>
 <li><a class="reference internal" href="#using-pyaqsapi">Using pyaqsapi</a></li>
 <li><a class="reference internal" href="#sign-up-and-setting-up-user-credentials-with-the-pyaqsapi-library">Sign up and setting up user credentials with the pyaqsapi library</a></li>
+<li><a class="reference internal" href="#data-mart-aggregate-functions">Data Mart aggregate functions</a></li>
 <li><a class="reference internal" href="#pyaqsapi-api-reference-documentation">pyaqsapi API reference documentation</a></li>
 <li><a class="reference internal" href="#index">Index</a></li>
 </ul>
@@ -122,8 +121,9 @@ <h1>AQS DataMart Disclaimer<a class="headerlink" href="#aqs-datamart-disclaimer"
 software, service, hardware, or user accounts that may utilize this
 package.</p>
 </div>
+</section>
 <section id="introduction">
-<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h2>
+<h1>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h1>
 <p>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
@@ -144,7 +144,6 @@ <h2>Introduction<a class="headerlink" href="#introduction" title="Link to this h
 second stall is invoked to help prevent overloading the Data Mart API server
 and to serve as a simple rate limit.</p>
 </section>
-</section>
 <section id="about-the-timeliness-of-aqs-data">
 <span id="index-1"></span><h1>About the timeliness of AQS Data<a class="headerlink" href="#about-the-timeliness-of-aqs-data" title="Link to this heading"></a></h1>
 <p>EPA's AQS Datamart API, the service that pyaqsapi retrieves data from, does not
@@ -206,7 +205,7 @@ <h2>Introduction<a class="headerlink" href="#introduction" title="Link to this h
 <section id="sign-up-and-setting-up-user-credentials-with-the-pyaqsapi-library">
 <span id="index-6"></span><h1>Sign up and setting up user credentials with the pyaqsapi library<a class="headerlink" href="#sign-up-and-setting-up-user-credentials-with-the-pyaqsapi-library" title="Link to this heading"></a></h1>
 <p>If you have not already done so you will need to sign up with AQS Data Mart
-using aqs_sign_up function,[2] this function takes one input, “email,” which
+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
 to use as a user credential to the AQS Data Mart service. After a successful
 call to aqs_sign_up an email message will be sent to the email address provided
@@ -239,8 +238,63 @@ <h2>Introduction<a class="headerlink" href="#introduction" title="Link to this h
 same credentials used in RAQSAPI in pyaqsapi since RAQSAPI ewes the the same
 AQS Data Mart API as pyaqsapi.</p>
 </div>
-<p>#this is temporary until the Long version is finished
-.. include:: manual/pyaqsapiFunctions-Brief.rst</p>
+</section>
+<section id="data-mart-aggregate-functions">
+<span id="index-7"></span><h1>Data Mart aggregate functions<a class="headerlink" href="#data-mart-aggregate-functions" title="Link to this heading"></a></h1>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>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.</p>
+</div>
+<p>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.</p>
+<p id="index-8">These seven families are:</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>by site (aqs.bysite)</p></li>
+<li><p>by county (aqs.bycounty)</p></li>
+<li><p>by state (aqs.bystate)</p></li>
+<li><p>by latitude/longitude bounding box (aqs.bybox)</p></li>
+<li><p>by monitoring agency (aqs.byma)</p></li>
+<li><p>by Primary Quality Assurance Organization (aqs.bypqao)</p></li>
+<li><p>by core based statistical area (as defined by the US census Bureau)
+(aqs.bycbsa).</p></li>
+</ul>
+</div></blockquote>
+<p>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.</p>
+<p id="index-9">These thirteen services are:</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>Monitors (*monitors)</p></li>
+<li><p>Sample Data (*sampledata)</p></li>
+<li><p>Daily Summary Data (*dailydata)</p></li>
+<li><p>Annual Summary Data (annualdata)</p></li>
+<li><p>Quality Assurance - Blanks Data (*qa_blanks)</p></li>
+<li><p>Quality Assurance - Collocated Assessments
+(*qa_collocated_assessments)</p></li>
+<li><p>Quality Assurance - Flow Rate Verifications (*qa_flowrateverification)</p></li>
+<li><p>Quality Assurance - Flow Rate Audits (*aqs_qa_flowrateaudit)</p></li>
+<li><p>Quality Assurance - One Point Quality Control Raw Data
+(*qa_one_point_qc)</p></li>
+<li><p>Quality Assurance - PEP Audits (*qa_pep_audit)</p></li>
+<li><p>Transaction Sample - AQS Submission data in transaction Format (RD)
+(*transactionsample)</p></li>
+<li><p>Quality Assurance - Annual Performance Evaluations
+(*qa_annualpeferomanceeval)</p></li>
+<li><p>Quality Assurance - Annual Performance Evaluations in the AQS
+Submission transaction format (RD)
+(*qa_annualpeferomanceevaltransaction)</p></li>
+</ul>
+</div></blockquote>
+<p>Aggregate functions are named aqs.&lt;aggregation&gt;.&lt;service&gt;() where &lt;service&gt;
+is one of the 13 services listed above and &lt;aggregation&gt; is either
+&quot;bysite“, ”bycounty“, ”bystate“, ”bybox“, ”bycbsa&quot;, &quot;byma&quot; or &quot;bypqao&quot;.</p>
 </section>
 <section id="pyaqsapi-api-reference-documentation">
 <h1>pyaqsapi API reference documentation<a class="headerlink" href="#pyaqsapi-api-reference-documentation" title="Link to this heading"></a></h1>
@@ -263,7 +317,7 @@ <h1>Index<a class="headerlink" href="#index" title="Link to this heading"></a
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/manual/EPA_Disclaimer.html

@@ -115,7 +115,7 @@ <h1>AQS DataMart Disclaimer<a class="headerlink" href="#aqs-datamart-disclaimer"
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/manual/Install_pyaqsapi.html

@@ -99,7 +99,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/manual/Introduction.html

@@ -102,7 +102,7 @@ <h1>Introduction<a class="headerlink" href="#introduction" title="Link to this h
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/manual/Load_pyaqsapi.html

@@ -89,7 +89,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/manual/RAQSAPI.html

@@ -90,7 +90,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/manual/TimelinessofAQSdata.html

@@ -88,7 +88,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/manual/Using_pyaqsapi.html

@@ -87,7 +87,7 @@
 <section id="sign-up-and-setting-up-user-credentials-with-the-pyaqsapi-library">
 <span id="index-1"></span><h1>Sign up and setting up user credentials with the pyaqsapi library<a class="headerlink" href="#sign-up-and-setting-up-user-credentials-with-the-pyaqsapi-library" title="Link to this heading"></a></h1>
 <p>If you have not already done so you will need to sign up with AQS Data Mart
-using aqs_sign_up function,[2] this function takes one input, “email,” which
+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
 to use as a user credential to the AQS Data Mart service. After a successful
 call to aqs_sign_up an email message will be sent to the email address provided
@@ -130,7 +130,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/manual/pyaqsapiFunctions-Brief.html

@@ -137,7 +137,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/py-modindex.html

@@ -186,7 +186,7 @@ <h1>Python Module Index</h1>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/pyaqsapi.bybox.html

@@ -327,7 +327,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/pyaqsapi.bycbsa.html

@@ -350,7 +350,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/pyaqsapi.bycounty.html

@@ -838,7 +838,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/pyaqsapi.byma.html

@@ -494,7 +494,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/pyaqsapi.bypqao.html

@@ -462,7 +462,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/pyaqsapi.bysite.html

@@ -858,7 +858,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/pyaqsapi.bystate.html

@@ -750,7 +750,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/pyaqsapi.html

@@ -4190,7 +4190,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/_build/html/search.html

@@ -89,7 +89,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, US Environmental Protection Agency.</p>
+    <p>&#169; Copyright 2024, US Environmental Protection Agency.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a