updated docs

aurorax-space · Jan 27, 2025 · 37f855d · 37f855d
1 parent 2122426
commit 37f855d
Show file tree

Hide file tree

Showing 13 changed files with 1,026 additions and 231 deletions.
diff --git a/docs/generated/index.js b/docs/generated/index.js
diff --git a/docs/generated/pyaurorax/data/ucalgary/index.html b/docs/generated/pyaurorax/data/ucalgary/index.html
@@ -996,19 +996,19 @@ <h3>Methods</h3>
 
     Attributes:
         uid (str): 
-            4-letter unique identifier (traditionally referred to as the site UID)
+            The 4-letter unique identifier (traditionally referred to as the site UID)
 
         full_name (str): 
-            full location string for the observatory
+            Full location string for the observatory
 
         geodetic_latitude (float): 
-            geodetic latitude for the observatory, in decimal format (-90 to 90)
+            Geodetic latitude for the observatory, in decimal format (-90 to 90)
 
         geodetic_longitude (float): 
-            geodetic longitude for the observatory, in decimal format (-180 to 180)
+            Geodetic longitude for the observatory, in decimal format (-180 to 180)
 
         provider (str): 
-            Data provider.
+            Data provider
     &#34;&#34;&#34;
 
     def __init__(self, uid: str, full_name: str, geodetic_latitude: float, geodetic_longitude: float):
@@ -1048,15 +1048,15 @@ <h3>Methods</h3>
 <h2 id="attributes">Attributes</h2>
 <dl>
 <dt><strong><code>uid</code></strong> :&ensp;<code>str</code></dt>
-<dd>4-letter unique identifier (traditionally referred to as the site UID)</dd>
+<dd>The 4-letter unique identifier (traditionally referred to as the site UID)</dd>
 <dt><strong><code>full_name</code></strong> :&ensp;<code>str</code></dt>
-<dd>full location string for the observatory</dd>
+<dd>Full location string for the observatory</dd>
 <dt><strong><code>geodetic_latitude</code></strong> :&ensp;<code>float</code></dt>
-<dd>geodetic latitude for the observatory, in decimal format (-90 to 90)</dd>
+<dd>Geodetic latitude for the observatory, in decimal format (-90 to 90)</dd>
 <dt><strong><code>geodetic_longitude</code></strong> :&ensp;<code>float</code></dt>
-<dd>geodetic longitude for the observatory, in decimal format (-180 to 180)</dd>
+<dd>Geodetic longitude for the observatory, in decimal format (-180 to 180)</dd>
 <dt><strong><code>provider</code></strong> :&ensp;<code>str</code></dt>
-<dd>Data provider.</dd>
+<dd>Data provider</dd>
 </dl></div>
 <h3>Methods</h3>
 <dl>

diff --git a/docs/generated/pyaurorax/search/availability/classes/availability_result.html b/docs/generated/pyaurorax/search/availability/classes/availability_result.html
@@ -81,11 +81,13 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
     Attributes:
         data_source (pyaurorax.search.DataSource): 
-            the data source that the records are associated with
+            The data source that the records are associated with
+
         available_ephemeris (Dict): 
-            the ephemeris availability information
+            The ephemeris availability information
+
         available_data_products (Dict): 
-            the data product availability information
+            The data product availability information
     &#34;&#34;&#34;
     data_source: DataSource
     available_data_products: Optional[Dict] = None
@@ -95,11 +97,11 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <h2 id="attributes">Attributes</h2>
 <dl>
 <dt><strong><code>data_source</code></strong> :&ensp;<code><a title="pyaurorax.search.DataSource" href="../../index.html#pyaurorax.search.DataSource">DataSource</a></code></dt>
-<dd>the data source that the records are associated with</dd>
+<dd>The data source that the records are associated with</dd>
 <dt><strong><code>available_ephemeris</code></strong> :&ensp;<code>Dict</code></dt>
-<dd>the ephemeris availability information</dd>
+<dd>The ephemeris availability information</dd>
 <dt><strong><code>available_data_products</code></strong> :&ensp;<code>Dict</code></dt>
-<dd>the data product availability information</dd>
+<dd>The data product availability information</dd>
 </dl></div>
 <h3>Class variables</h3>
 <dl>

diff --git a/docs/generated/pyaurorax/search/availability/index.html b/docs/generated/pyaurorax/search/availability/index.html
@@ -106,24 +106,32 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         Args:
             start (datetime.date): 
                 Start date to retrieve availability info for (inclusive)
+
             end (datetime.date): 
                 End date to retrieve availability info for (inclusive)
+
             program (str): 
                 Program name to filter sources by, defaults to `None`
+
             platform (str): 
                 Platform name to filter sources by, defaults to `None`
+
             instrument_type (str): 
                 Instrument type to filter sources by, defaults to `None`
+
             source_type (str): 
                 The data source type to filter for, defaults to `None`. Options are in 
                 the pyaurorax.search.sources module, or at the top level using the 
                 pyaurorax.search.SOURCE_TYPE_* variables.
+
             owner (str): 
                 Owner email address to filter sources by, defaults to `None`
+
             format (str): 
                 The format of the data sources returned, defaults to `FORMAT_FULL_RECORD`. 
                 Other options are in the pyaurorax.search.sources module, or at the top level using 
                 the pyaurorax.search.FORMAT_* variables.
+
             slow (bool): 
                 Query the data using a slower, but more accurate method, defaults to `False`
 
@@ -151,24 +159,32 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         Args:
             start (datetime.date): 
                 Start date to retrieve availability info for (inclusive)
+
             end (datetime.date): 
                 End date to retrieve availability info for (inclusive)
+
             program (str): 
                 Program name to filter sources by, defaults to `None`
+
             platform (str): 
                 Platform name to filter sources by, defaults to `None`
+
             instrument_type (str): 
                 Instrument type to filter sources by, defaults to `None`
+
             source_type (str): 
                 The data source type to filter for, defaults to `None`. Options are in 
                 the pyaurorax.search.sources module, or at the top level using the 
                 pyaurorax.search.SOURCE_TYPE_* variables.
+
             owner (str): 
                 Owner email address to filter sources by, defaults to `None`
+
             format (str): 
                 The format of the data sources returned, defaults to `FORMAT_FULL_RECORD`. 
                 Other options are in the pyaurorax.search.sources module, or at the top level using 
                 the pyaurorax.search.FORMAT_* variables.
+
             slow (bool): 
                 Query the data using a slower, but more accurate method, defaults to `False`
 
@@ -208,24 +224,32 @@ <h3>Methods</h3>
     Args:
         start (datetime.date): 
             Start date to retrieve availability info for (inclusive)
+
         end (datetime.date): 
             End date to retrieve availability info for (inclusive)
+
         program (str): 
             Program name to filter sources by, defaults to `None`
+
         platform (str): 
             Platform name to filter sources by, defaults to `None`
+
         instrument_type (str): 
             Instrument type to filter sources by, defaults to `None`
+
         source_type (str): 
             The data source type to filter for, defaults to `None`. Options are in 
             the pyaurorax.search.sources module, or at the top level using the 
             pyaurorax.search.SOURCE_TYPE_* variables.
+
         owner (str): 
             Owner email address to filter sources by, defaults to `None`
+
         format (str): 
             The format of the data sources returned, defaults to `FORMAT_FULL_RECORD`. 
             Other options are in the pyaurorax.search.sources module, or at the top level using 
             the pyaurorax.search.FORMAT_* variables.
+
         slow (bool): 
             Query the data using a slower, but more accurate method, defaults to `False`
 
@@ -295,24 +319,32 @@ <h2 id="raises">Raises</h2>
     Args:
         start (datetime.date): 
             Start date to retrieve availability info for (inclusive)
+
         end (datetime.date): 
             End date to retrieve availability info for (inclusive)
+
         program (str): 
             Program name to filter sources by, defaults to `None`
+
         platform (str): 
             Platform name to filter sources by, defaults to `None`
+
         instrument_type (str): 
             Instrument type to filter sources by, defaults to `None`
+
         source_type (str): 
             The data source type to filter for, defaults to `None`. Options are in 
             the pyaurorax.search.sources module, or at the top level using the 
             pyaurorax.search.SOURCE_TYPE_* variables.
+
         owner (str): 
             Owner email address to filter sources by, defaults to `None`
+
         format (str): 
             The format of the data sources returned, defaults to `FORMAT_FULL_RECORD`. 
             Other options are in the pyaurorax.search.sources module, or at the top level using 
             the pyaurorax.search.FORMAT_* variables.
+
         slow (bool): 
             Query the data using a slower, but more accurate method, defaults to `False`
 
@@ -376,11 +408,13 @@ <h2 id="raises">Raises</h2>
 
     Attributes:
         data_source (pyaurorax.search.DataSource): 
-            the data source that the records are associated with
+            The data source that the records are associated with
+
         available_ephemeris (Dict): 
-            the ephemeris availability information
+            The ephemeris availability information
+
         available_data_products (Dict): 
-            the data product availability information
+            The data product availability information
     &#34;&#34;&#34;
     data_source: DataSource
     available_data_products: Optional[Dict] = None
@@ -390,11 +424,11 @@ <h2 id="raises">Raises</h2>
 <h2 id="attributes">Attributes</h2>
 <dl>
 <dt><strong><code>data_source</code></strong> :&ensp;<code><a title="pyaurorax.search.DataSource" href="../index.html#pyaurorax.search.DataSource">DataSource</a></code></dt>
-<dd>the data source that the records are associated with</dd>
+<dd>The data source that the records are associated with</dd>
 <dt><strong><code>available_ephemeris</code></strong> :&ensp;<code>Dict</code></dt>
-<dd>the ephemeris availability information</dd>
+<dd>The ephemeris availability information</dd>
 <dt><strong><code>available_data_products</code></strong> :&ensp;<code>Dict</code></dt>
-<dd>the data product availability information</dd>
+<dd>The data product availability information</dd>
 </dl></div>
 <h3>Class variables</h3>
 <dl>

diff --git a/docs/generated/pyaurorax/search/conjunctions/classes/conjunction.html b/docs/generated/pyaurorax/search/conjunctions/classes/conjunction.html
@@ -95,8 +95,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
     Attributes:
         conjunction_type (str): 
-            The type of location data used when the conjunction was found (either 
-            &#39;nbtrace&#39;, &#39;sbtrace&#39;, or &#39;geographic&#39;)
+            The type of location data used when the conjunction was found (either `nbtrace`, 
+            `sbtrace`, or `geographic`)
 
         start (datetime.datetime): 
             Start timestamp of the conjunction
@@ -114,9 +114,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             Maximum kilometer distance of the conjunction
 
         events (List[Dict]): 
-            The sub-conjunctions that make up this over-arching
-            conjunction (the conjunctions between each set of two data
-            sources)
+            The sub-conjunctions that make up this over-arching conjunction (the conjunctions 
+            between each set of two data sources)
 
         closest_epoch (datetime.datetime): 
             Timestamp for when data sources were closest
@@ -158,8 +157,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <h2 id="attributes">Attributes</h2>
 <dl>
 <dt><strong><code>conjunction_type</code></strong> :&ensp;<code>str</code></dt>
-<dd>The type of location data used when the conjunction was found (either
-'nbtrace', 'sbtrace', or 'geographic')</dd>
+<dd>The type of location data used when the conjunction was found (either <code>nbtrace</code>,
+<code>sbtrace</code>, or <code>geographic</code>)</dd>
 <dt><strong><code>start</code></strong> :&ensp;<code>datetime.datetime</code></dt>
 <dd>Start timestamp of the conjunction</dd>
 <dt><strong><code>end</code></strong> :&ensp;<code>datetime.datetime</code></dt>
@@ -171,9 +170,8 @@ <h2 id="attributes">Attributes</h2>
 <dt><strong><code>max_distance</code></strong> :&ensp;<code>float</code></dt>
 <dd>Maximum kilometer distance of the conjunction</dd>
 <dt><strong><code>events</code></strong> :&ensp;<code>List[Dict]</code></dt>
-<dd>The sub-conjunctions that make up this over-arching
-conjunction (the conjunctions between each set of two data
-sources)</dd>
+<dd>The sub-conjunctions that make up this over-arching conjunction (the conjunctions
+between each set of two data sources)</dd>
 <dt><strong><code>closest_epoch</code></strong> :&ensp;<code>datetime.datetime</code></dt>
 <dd>Timestamp for when data sources were closest</dd>
 <dt><strong><code>farthest_epoch</code></strong> :&ensp;<code>datetime.datetime</code></dt>