finalizing docs

iannesbitt · Jun 27, 2023 · 6a5e988 · 6a5e988
1 parent e32e19b
commit 6a5e988
Show file tree

Hide file tree

Showing 27 changed files with 341 additions and 19 deletions.
diff --git a/docs/_sources/defs.rst.txt b/docs/_sources/defs.rst.txt
@@ -4,6 +4,30 @@
 .. automodule:: pyegt.defs
     :members:
 
+.. py:data:: MODEL_LIST
+    :type: list
+
+    The full list of models from NGS and VDatum APIs described here,
+    concatenated from :py:data:`pyegt.defs.NGS_MODELS` and
+    :py:data:`pyegt.defs.VDATUM_MODELS`::
+
+        MODEL_LIST = [
+            'GEOID99', 'G99SSS', 'GEOID03', 'USGG2003', 'GEOID06', 'USGG2009',
+            'GEOID09', 'XUSHG', 'USGG2012', 'GEOID12A', 'GEOID12B', 'GEOID18',
+            'NAVD88', 'NGVD29', 'ASVD02', 'W0_USGG2012', 'GUVD04', 'NMVD03',
+            'PRVD02', 'VIVD09', 'CRD', 'EGM2008', 'EGM1996', 'EGM1984',
+            'XGEOID16B', 'XGEOID17B', 'XGEOID18B', 'XGEOID19B', 'XGEOID20B',
+            'IGLD85', 'LWD_IGLD85', 'OHWM_IGLD85', 'CRD', 'LMSL', 'MLLW',
+            'MLW', 'MTL', 'DTL', 'MHW', 'MHHW', 'LWD', 'NAD27', 'NAD83_1986',
+            'NAD83_2011', 'NAD83_NSRS2007', 'NAD83_MARP00', 'NAD83_PACP00',
+            'WGS84_G1674', 'ITRF2014', 'IGS14', 'ITRF2008', 'IGS08',
+            'ITRF2005', 'IGS2005', 'WGS84_G1150', 'ITRF2000', 'IGS00', 'IGb00',
+            'ITRF96', 'WGS84_G873', 'ITRF94', 'ITRF93', 'ITRF92', 'SIOMIT92',
+            'WGS84_G730', 'ITRF91', 'ITRF90', 'ITRF89', 'ITRF88',
+            'WGS84_TRANSIT', 'WGS84_G1762', 'WGS84_G2139'
+        ]
+
+
 ................
 
 * :ref:`genindex`

diff --git a/docs/_sources/height.rst.txt b/docs/_sources/height.rst.txt
@@ -3,6 +3,7 @@
 
 .. automodule:: pyegt.height
     :members:
+    :special-members: __dict__, __eq__, __float__, __repr__, __str__
 
 ................
 

diff --git a/docs/defs.html b/docs/defs.html
@@ -60,6 +60,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#pyegt.defs.NGS_MODELS"><code class="docutils literal notranslate"><span class="pre">NGS_MODELS</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#pyegt.defs.REGIONS"><code class="docutils literal notranslate"><span class="pre">REGIONS</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#pyegt.defs.VDATUM_MODELS"><code class="docutils literal notranslate"><span class="pre">VDATUM_MODELS</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#pyegt.defs.MODEL_LIST"><code class="docutils literal notranslate"><span class="pre">MODEL_LIST</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="test.html"><code class="docutils literal notranslate"><span class="pre">pyegt.test</span></code></a></li>
@@ -137,6 +138,31 @@
 </div>
 </dd></dl>
 
+<dl class="py data">
+<dt class="sig sig-object py" id="pyegt.defs.MODEL_LIST">
+<span class="sig-prename descclassname"><span class="pre">pyegt.defs.</span></span><span class="sig-name descname"><span class="pre">MODEL_LIST</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><span class="pre">list</span></a></em><a class="headerlink" href="#pyegt.defs.MODEL_LIST" title="Permalink to this definition"></a></dt>
+<dd><p>The full list of models from NGS and VDatum APIs described here,
+concatenated from <a class="reference internal" href="#pyegt.defs.NGS_MODELS" title="pyegt.defs.NGS_MODELS"><code class="xref py py-data docutils literal notranslate"><span class="pre">pyegt.defs.NGS_MODELS</span></code></a> and
+<a class="reference internal" href="#pyegt.defs.VDATUM_MODELS" title="pyegt.defs.VDATUM_MODELS"><code class="xref py py-data docutils literal notranslate"><span class="pre">pyegt.defs.VDATUM_MODELS</span></code></a>:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">MODEL_LIST</span> <span class="o">=</span> <span class="p">[</span>
+    <span class="s1">&#39;GEOID99&#39;</span><span class="p">,</span> <span class="s1">&#39;G99SSS&#39;</span><span class="p">,</span> <span class="s1">&#39;GEOID03&#39;</span><span class="p">,</span> <span class="s1">&#39;USGG2003&#39;</span><span class="p">,</span> <span class="s1">&#39;GEOID06&#39;</span><span class="p">,</span> <span class="s1">&#39;USGG2009&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;GEOID09&#39;</span><span class="p">,</span> <span class="s1">&#39;XUSHG&#39;</span><span class="p">,</span> <span class="s1">&#39;USGG2012&#39;</span><span class="p">,</span> <span class="s1">&#39;GEOID12A&#39;</span><span class="p">,</span> <span class="s1">&#39;GEOID12B&#39;</span><span class="p">,</span> <span class="s1">&#39;GEOID18&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;NAVD88&#39;</span><span class="p">,</span> <span class="s1">&#39;NGVD29&#39;</span><span class="p">,</span> <span class="s1">&#39;ASVD02&#39;</span><span class="p">,</span> <span class="s1">&#39;W0_USGG2012&#39;</span><span class="p">,</span> <span class="s1">&#39;GUVD04&#39;</span><span class="p">,</span> <span class="s1">&#39;NMVD03&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;PRVD02&#39;</span><span class="p">,</span> <span class="s1">&#39;VIVD09&#39;</span><span class="p">,</span> <span class="s1">&#39;CRD&#39;</span><span class="p">,</span> <span class="s1">&#39;EGM2008&#39;</span><span class="p">,</span> <span class="s1">&#39;EGM1996&#39;</span><span class="p">,</span> <span class="s1">&#39;EGM1984&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;XGEOID16B&#39;</span><span class="p">,</span> <span class="s1">&#39;XGEOID17B&#39;</span><span class="p">,</span> <span class="s1">&#39;XGEOID18B&#39;</span><span class="p">,</span> <span class="s1">&#39;XGEOID19B&#39;</span><span class="p">,</span> <span class="s1">&#39;XGEOID20B&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;IGLD85&#39;</span><span class="p">,</span> <span class="s1">&#39;LWD_IGLD85&#39;</span><span class="p">,</span> <span class="s1">&#39;OHWM_IGLD85&#39;</span><span class="p">,</span> <span class="s1">&#39;CRD&#39;</span><span class="p">,</span> <span class="s1">&#39;LMSL&#39;</span><span class="p">,</span> <span class="s1">&#39;MLLW&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;MLW&#39;</span><span class="p">,</span> <span class="s1">&#39;MTL&#39;</span><span class="p">,</span> <span class="s1">&#39;DTL&#39;</span><span class="p">,</span> <span class="s1">&#39;MHW&#39;</span><span class="p">,</span> <span class="s1">&#39;MHHW&#39;</span><span class="p">,</span> <span class="s1">&#39;LWD&#39;</span><span class="p">,</span> <span class="s1">&#39;NAD27&#39;</span><span class="p">,</span> <span class="s1">&#39;NAD83_1986&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;NAD83_2011&#39;</span><span class="p">,</span> <span class="s1">&#39;NAD83_NSRS2007&#39;</span><span class="p">,</span> <span class="s1">&#39;NAD83_MARP00&#39;</span><span class="p">,</span> <span class="s1">&#39;NAD83_PACP00&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;WGS84_G1674&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF2014&#39;</span><span class="p">,</span> <span class="s1">&#39;IGS14&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF2008&#39;</span><span class="p">,</span> <span class="s1">&#39;IGS08&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;ITRF2005&#39;</span><span class="p">,</span> <span class="s1">&#39;IGS2005&#39;</span><span class="p">,</span> <span class="s1">&#39;WGS84_G1150&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF2000&#39;</span><span class="p">,</span> <span class="s1">&#39;IGS00&#39;</span><span class="p">,</span> <span class="s1">&#39;IGb00&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;ITRF96&#39;</span><span class="p">,</span> <span class="s1">&#39;WGS84_G873&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF94&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF93&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF92&#39;</span><span class="p">,</span> <span class="s1">&#39;SIOMIT92&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;WGS84_G730&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF91&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF90&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF89&#39;</span><span class="p">,</span> <span class="s1">&#39;ITRF88&#39;</span><span class="p">,</span>
+    <span class="s1">&#39;WGS84_TRANSIT&#39;</span><span class="p">,</span> <span class="s1">&#39;WGS84_G1762&#39;</span><span class="p">,</span> <span class="s1">&#39;WGS84_G2139&#39;</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+</dd></dl>
+
 <hr class="docutils" />
 <ul class="simple">
 <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -85,7 +85,8 @@
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#A"><strong>A</strong></a>
+ <a href="#_"><strong>_</strong></a>
+ | <a href="#A"><strong>A</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
  | <a href="#H"><strong>H</strong></a>
@@ -98,6 +99,22 @@ <h1 id="index">Index</h1>
  | <a href="#V"><strong>V</strong></a>
 
 </div>
+<h2 id="_">_</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="height.html#pyegt.height.HeightModel.__eq__">__eq__() (pyegt.height.HeightModel method)</a>
+</li>
+      <li><a href="height.html#pyegt.height.HeightModel.__float__">__float__() (pyegt.height.HeightModel method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="height.html#pyegt.height.HeightModel.__repr__">__repr__() (pyegt.height.HeightModel method)</a>
+</li>
+      <li><a href="height.html#pyegt.height.HeightModel.__str__">__str__() (pyegt.height.HeightModel method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -175,6 +192,8 @@ <h2 id="I">I</h2>
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="defs.html#pyegt.defs.MODEL_LIST">MODEL_LIST (in module pyegt.defs)</a>
+</li>
       <li><a href="utils.html#pyegt.utils.model_search">model_search() (in module pyegt.utils)</a>
 </li>
       <li>