docs updates

docs/generated/pyaurorax/index.html

@@ -377,8 +377,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         return self.__progress_bar_backend
 
     @progress_bar_backend.setter
-    def progress_bar_backend(self, value: str):
-        value = value.lower()
+    def progress_bar_backend(self, value: Literal[&#34;auto&#34;, &#34;standard&#34;, &#34;notebook&#34;]):
+        value = value.lower()  # type: ignore
         if (value != &#34;auto&#34; and value != &#34;standard&#34; and value != &#34;notebook&#34;):
             raise AuroraXInitializationError(&#34;Invalid progress bar backend. Allowed values are &#39;auto&#39;, &#39;standard&#39; or &#39;notebook&#39;.&#34;)
         self.__progress_bar_backend = value

docs/generated/pyaurorax/search/api/classes/request.html

@@ -145,6 +145,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
         Raises:
             pyaurorax.exceptions.AuroraXAPIError: error during API call
+            pyaurorax.exceptions.AuroraXUnauthorizedError: unauthorized user attempted to perform this action
+            pyaurorax.exceptions.AuroraXMaintenanceError: AuroraX API is currently undergoing maintenance
         &#34;&#34;&#34;
         # sanitize data
         body_santized = json.dumps(self.body, default=self.__json_converter)
@@ -266,6 +268,8 @@ <h3>Methods</h3>
 
     Raises:
         pyaurorax.exceptions.AuroraXAPIError: error during API call
+        pyaurorax.exceptions.AuroraXUnauthorizedError: unauthorized user attempted to perform this action
+        pyaurorax.exceptions.AuroraXMaintenanceError: AuroraX API is currently undergoing maintenance
     &#34;&#34;&#34;
     # sanitize data
     body_santized = json.dumps(self.body, default=self.__json_converter)
@@ -352,6 +356,10 @@ <h2 id="raises">Raises</h2>
 <dl>
 <dt><code><a title="pyaurorax.exceptions.AuroraXAPIError" href="../../../exceptions.html#pyaurorax.exceptions.AuroraXAPIError">AuroraXAPIError</a></code></dt>
 <dd>error during API call</dd>
+<dt><code><a title="pyaurorax.exceptions.AuroraXUnauthorizedError" href="../../../exceptions.html#pyaurorax.exceptions.AuroraXUnauthorizedError">AuroraXUnauthorizedError</a></code></dt>
+<dd>unauthorized user attempted to perform this action</dd>
+<dt><code><a title="pyaurorax.exceptions.AuroraXMaintenanceError" href="../../../exceptions.html#pyaurorax.exceptions.AuroraXMaintenanceError">AuroraXMaintenanceError</a></code></dt>
+<dd>AuroraX API is currently undergoing maintenance</dd>
 </dl></div>
 </dd>
 </dl>

docs/generated/pyaurorax/search/api/index.html

@@ -154,6 +154,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
         Raises:
             pyaurorax.exceptions.AuroraXAPIError: error during API call
+            pyaurorax.exceptions.AuroraXUnauthorizedError: unauthorized user attempted to perform this action
+            pyaurorax.exceptions.AuroraXMaintenanceError: AuroraX API is currently undergoing maintenance
         &#34;&#34;&#34;
         # sanitize data
         body_santized = json.dumps(self.body, default=self.__json_converter)
@@ -275,6 +277,8 @@ <h3>Methods</h3>
 
     Raises:
         pyaurorax.exceptions.AuroraXAPIError: error during API call
+        pyaurorax.exceptions.AuroraXUnauthorizedError: unauthorized user attempted to perform this action
+        pyaurorax.exceptions.AuroraXMaintenanceError: AuroraX API is currently undergoing maintenance
     &#34;&#34;&#34;
     # sanitize data
     body_santized = json.dumps(self.body, default=self.__json_converter)
@@ -361,6 +365,10 @@ <h2 id="raises">Raises</h2>
 <dl>
 <dt><code><a title="pyaurorax.exceptions.AuroraXAPIError" href="../../exceptions.html#pyaurorax.exceptions.AuroraXAPIError">AuroraXAPIError</a></code></dt>
 <dd>error during API call</dd>
+<dt><code><a title="pyaurorax.exceptions.AuroraXUnauthorizedError" href="../../exceptions.html#pyaurorax.exceptions.AuroraXUnauthorizedError">AuroraXUnauthorizedError</a></code></dt>
+<dd>unauthorized user attempted to perform this action</dd>
+<dt><code><a title="pyaurorax.exceptions.AuroraXMaintenanceError" href="../../exceptions.html#pyaurorax.exceptions.AuroraXMaintenanceError">AuroraXMaintenanceError</a></code></dt>
+<dd>AuroraX API is currently undergoing maintenance</dd>
 </dl></div>
 </dd>
 </dl>

docs/generated/pyaurorax/search/conjunctions/index.html

@@ -226,6 +226,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
         Returns:
             a `pyaurorax.search.ConjunctionSearch` object
+
+        Raises:
+            pyaurorax.exceptions.AuroraXSearchError: the API experienced a search error
         &#34;&#34;&#34;
         return func_search(
             self.__aurorax_obj,
@@ -257,6 +260,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
         Returns:
             the &#34;SQL-like&#34; string describing the conjunction search object
+
+        Raises:
+            pyaurorax.exceptions.AuroraXError: invalid arguments
         &#34;&#34;&#34;
         return func_describe(self.__aurorax_obj, search_obj, query_dict)
 
@@ -320,6 +326,9 @@ <h3>Methods</h3>
 
     Returns:
         the &#34;SQL-like&#34; string describing the conjunction search object
+
+    Raises:
+        pyaurorax.exceptions.AuroraXError: invalid arguments
     &#34;&#34;&#34;
     return func_describe(self.__aurorax_obj, search_obj, query_dict)</code></pre>
 </details>
@@ -333,7 +342,12 @@ <h2 id="args">Args</h2>
 <dd>the conjunction search query represented as a raw dictionary, optional</dd>
 </dl>
 <h2 id="returns">Returns</h2>
-<p>the "SQL-like" string describing the conjunction search object</p></div>
+<p>the "SQL-like" string describing the conjunction search object</p>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code><a title="pyaurorax.exceptions.AuroraXError" href="../../exceptions.html#pyaurorax.exceptions.AuroraXError">AuroraXError</a></code></dt>
+<dd>invalid arguments</dd>
+</dl></div>
 </dd>
 <dt id="pyaurorax.search.conjunctions.ConjunctionsManager.get_request_url"><code class="name flex">
 <span>def <span class="ident">get_request_url</span></span>(<span>self, request_id: str) ‑> str</span>
@@ -494,6 +508,9 @@ <h2 id="returns">Returns</h2>
 
     Returns:
         a `pyaurorax.search.ConjunctionSearch` object
+
+    Raises:
+        pyaurorax.exceptions.AuroraXSearchError: the API experienced a search error
     &#34;&#34;&#34;
     return func_search(
         self.__aurorax_obj,
@@ -602,7 +619,12 @@ <h2 id="args">Args</h2>
 <dd>show the progress of the request using the request log, defaults</dd>
 </dl>
 <h2 id="returns">Returns</h2>
-<p>a <code><a title="pyaurorax.search.ConjunctionSearch" href="../index.html#pyaurorax.search.ConjunctionSearch">ConjunctionSearch</a></code> object</p></div>
+<p>a <code><a title="pyaurorax.search.ConjunctionSearch" href="../index.html#pyaurorax.search.ConjunctionSearch">ConjunctionSearch</a></code> object</p>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code><a title="pyaurorax.exceptions.AuroraXSearchError" href="../../exceptions.html#pyaurorax.exceptions.AuroraXSearchError">AuroraXSearchError</a></code></dt>
+<dd>the API experienced a search error</dd>
+</dl></div>
 </dd>
 </dl>
 </dd>

docs/generated/pyaurorax/search/conjunctions/swarmaurora/index.html

@@ -110,6 +110,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 the browser type to load using. Default is your default browser. Some common other 
                 options are &#34;google-chrome&#34;, &#34;firefox&#34;, or &#34;safari&#34;. For all available options, refer 
                 to https://docs.python.org/3/library/webbrowser.html#webbrowser.get
+
+        Raises:
+            pyaurorax.exceptions.AuroraXError: unsupported browser specified
         &#34;&#34;&#34;
         return func_open_in_browser(search_obj, browser)
 
@@ -240,6 +243,9 @@ <h2 id="returns">Returns</h2>
             the browser type to load using. Default is your default browser. Some common other 
             options are &#34;google-chrome&#34;, &#34;firefox&#34;, or &#34;safari&#34;. For all available options, refer 
             to https://docs.python.org/3/library/webbrowser.html#webbrowser.get
+
+    Raises:
+        pyaurorax.exceptions.AuroraXError: unsupported browser specified
     &#34;&#34;&#34;
     return func_open_in_browser(search_obj, browser)</code></pre>
 </details>
@@ -253,7 +259,12 @@ <h2 id="args">Args</h2>
 <p>browser (str)):
 the browser type to load using. Default is your default browser. Some common other
 options are "google-chrome", "firefox", or "safari". For all available options, refer
-to <a href="https://docs.python.org/3/library/webbrowser.html#webbrowser.get">https://docs.python.org/3/library/webbrowser.html#webbrowser.get</a></p></div>
+to <a href="https://docs.python.org/3/library/webbrowser.html#webbrowser.get">https://docs.python.org/3/library/webbrowser.html#webbrowser.get</a></p>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code><a title="pyaurorax.exceptions.AuroraXError" href="../../../exceptions.html#pyaurorax.exceptions.AuroraXError">AuroraXError</a></code></dt>
+<dd>unsupported browser specified</dd>
+</dl></div>
 </dd>
 </dl>
 </dd>

docs/generated/pyaurorax/search/index.html

@@ -3468,6 +3468,36 @@ <h2 id="returns">Returns</h2>
         self.__data_products = DataProductsManager(self.__aurorax_obj)
         self.__conjunctions = ConjunctionsManager(self.__aurorax_obj)
 
+        # initialize class vars
+        self.DataSource = DataSource
+        self.Location = Location
+        self.AvailabilityResult = AvailabilityResult
+        self.EphemerisData = EphemerisData
+        self.EphemerisSearch = EphemerisSearch
+        self.DataProductData = DataProductData
+        self.DataProductSearch = DataProductSearch
+        self.Conjunction = Conjunction
+        self.ConjunctionSearch = ConjunctionSearch
+
+        # initialize static vars
+        self.FORMAT_BASIC_INFO = FORMAT_BASIC_INFO
+        self.FORMAT_BASIC_INFO_WITH_METADATA = FORMAT_BASIC_INFO_WITH_METADATA
+        self.FORMAT_FULL_RECORD = FORMAT_FULL_RECORD
+        self.FORMAT_IDENTIFIER_ONLY = FORMAT_IDENTIFIER_ONLY
+        self.FORMAT_DEFAULT = FORMAT_DEFAULT
+        self.SOURCE_TYPE_EVENT_LIST = SOURCE_TYPE_EVENT_LIST
+        self.SOURCE_TYPE_GROUND = SOURCE_TYPE_GROUND
+        self.SOURCE_TYPE_HEO = SOURCE_TYPE_HEO
+        self.SOURCE_TYPE_LEO = SOURCE_TYPE_LEO
+        self.SOURCE_TYPE_LUNAR = SOURCE_TYPE_LUNAR
+        self.DATA_PRODUCT_TYPE_KEOGRAM = DATA_PRODUCT_TYPE_KEOGRAM
+        self.DATA_PRODUCT_TYPE_MONTAGE = DATA_PRODUCT_TYPE_MONTAGE
+        self.DATA_PRODUCT_TYPE_MOVIE = DATA_PRODUCT_TYPE_MOVIE
+        self.DATA_PRODUCT_TYPE_SUMMARY_PLOT = DATA_PRODUCT_TYPE_SUMMARY_PLOT
+        self.DATA_PRODUCT_TYPE_DATA_AVAILABILITY = DATA_PRODUCT_TYPE_DATA_AVAILABILITY
+        self.CONJUNCTION_TYPE_NBTRACE = CONJUNCTION_TYPE_NBTRACE
+        self.CONJUNCTION_TYPE_SBTRACE = CONJUNCTION_TYPE_SBTRACE
+
     # ------------------------------------------
     # properties for submodule managers
     # ------------------------------------------

docs/generated/pyaurorax/tools/classes/keogram.html

@@ -374,7 +374,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             set to True, the plotting variables `(fig, ax)` will be returned.
 
         Raises:
-            ValueError: Issues with the y-axis choice.
+            ValueError: issues encountered with the y-axis choice
         &#34;&#34;&#34;
         # check return mode
         if (returnfig is True and savefig is True):
@@ -627,7 +627,7 @@ <h3>Methods</h3>
         set to True, the plotting variables `(fig, ax)` will be returned.
 
     Raises:
-        ValueError: Issues with the y-axis choice.
+        ValueError: issues encountered with the y-axis choice
     &#34;&#34;&#34;
     # check return mode
     if (returnfig is True and savefig is True):
@@ -826,7 +826,7 @@ <h2 id="returns">Returns</h2>
 <h2 id="raises">Raises</h2>
 <dl>
 <dt><code>ValueError</code></dt>
-<dd>Issues with the y-axis choice.</dd>
+<dd>issues encountered with the y-axis choice</dd>
 </dl></div>
 </dd>
 <dt id="pyaurorax.tools.classes.keogram.Keogram.pretty_print"><code class="name flex">

docs/generated/pyaurorax/tools/classes/montage.html

@@ -207,7 +207,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             set to True, the plotting variables `(fig, ax)` will be returned.
 
         Raises:
-            ValueError: Issues with the y-axis choice, or rows/cols choice.
+            ValueError: issues with the y-axis choice, or rows/cols choice.
         &#34;&#34;&#34;
         # check rows and cols
         if (rows * cols != self.data.shape[-1]):
@@ -410,7 +410,7 @@ <h3>Methods</h3>
         set to True, the plotting variables `(fig, ax)` will be returned.
 
     Raises:
-        ValueError: Issues with the y-axis choice, or rows/cols choice.
+        ValueError: issues with the y-axis choice, or rows/cols choice.
     &#34;&#34;&#34;
     # check rows and cols
     if (rows * cols != self.data.shape[-1]):
@@ -571,7 +571,7 @@ <h2 id="returns">Returns</h2>
 <h2 id="raises">Raises</h2>
 <dl>
 <dt><code>ValueError</code></dt>
-<dd>Issues with the y-axis choice, or rows/cols choice.</dd>
+<dd>issues with the y-axis choice, or rows/cols choice.</dd>
 </dl></div>
 </dd>
 <dt id="pyaurorax.tools.classes.montage.Montage.pretty_print"><code class="name flex">

docs/generated/pyaurorax/tools/classes/mosaic.html

@@ -631,15 +631,15 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             The object&#39;s contour_data parameter is populated appropriately.
 
         Raises:
-            ValueError: issues encountered with supplied parameters.
+            ValueError: issues encountered with supplied parameters
         &#34;&#34;&#34;
         # Make sure some form of lat/lon is provided
         if (constant_lats is None) and (constant_lons is None) and (lats is None) and (lons is None):
             raise ValueError(&#34;No latitudes or longitudes provided.&#34;)
 
         # If manually passing in lats &amp; lons, make sure both are provided
         if (lats is not None or lons is not None) and (lats is None or lons is None):
-            raise (ValueError(&#34;Manually supplying contour requires both lats and lons.&#34;))
+            raise ValueError(&#34;Manually supplying contour requires both lats and lons.&#34;)
 
         # Check that color exists in matplotlib
         if color not in matplotlib.colors.CSS4_COLORS:
@@ -1033,15 +1033,15 @@ <h2 id="raises">Raises</h2>
         The object&#39;s contour_data parameter is populated appropriately.
 
     Raises:
-        ValueError: issues encountered with supplied parameters.
+        ValueError: issues encountered with supplied parameters
     &#34;&#34;&#34;
     # Make sure some form of lat/lon is provided
     if (constant_lats is None) and (constant_lons is None) and (lats is None) and (lons is None):
         raise ValueError(&#34;No latitudes or longitudes provided.&#34;)
 
     # If manually passing in lats &amp; lons, make sure both are provided
     if (lats is not None or lons is not None) and (lats is None or lons is None):
-        raise (ValueError(&#34;Manually supplying contour requires both lats and lons.&#34;))
+        raise ValueError(&#34;Manually supplying contour requires both lats and lons.&#34;)
 
     # Check that color exists in matplotlib
     if color not in matplotlib.colors.CSS4_COLORS:
@@ -1173,7 +1173,7 @@ <h2 id="returns">Returns</h2>
 <h2 id="raises">Raises</h2>
 <dl>
 <dt><code>ValueError</code></dt>
-<dd>issues encountered with supplied parameters.</dd>
+<dd>issues encountered with supplied parameters</dd>
 </dl></div>
 </dd>
 <dt id="pyaurorax.tools.classes.mosaic.Mosaic.plot"><code class="name flex">

docs/generated/pyaurorax/tools/grid_files/index.html

@@ -108,7 +108,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             The prepared RGBA grid array.
 
         Raises:
-            ValueError: issues encountered with supplied parameters.
+            ValueError: issues encountered with supplied parameters
         &#34;&#34;&#34;
         return func_prep_grid_image(self.__aurorax_obj, grid, fill_val, scale, cmap)</code></pre>
 </details>
@@ -149,7 +149,7 @@ <h3>Methods</h3>
         The prepared RGBA grid array.
 
     Raises:
-        ValueError: issues encountered with supplied parameters.
+        ValueError: issues encountered with supplied parameters
     &#34;&#34;&#34;
     return func_prep_grid_image(self.__aurorax_obj, grid, fill_val, scale, cmap)</code></pre>
 </details>
@@ -171,7 +171,7 @@ <h2 id="returns">Returns</h2>
 <h2 id="raises">Raises</h2>
 <dl>
 <dt><code>ValueError</code></dt>
-<dd>issues encountered with supplied parameters.</dd>
+<dd>issues encountered with supplied parameters</dd>
 </dl></div>
 </dd>
 </dl>