Deploying to gh-pages from @ bfcf230 🚀

ESA-VirES · Dec 16, 2024 · da1791f · da1791f
1 parent f965cfd
commit da1791f
Show file tree

Hide file tree

Showing 14 changed files with 263 additions and 8 deletions.
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -18,6 +18,7 @@
   :caption: Package Documentation
 
   Installation <installation>
+  Usage <usage>
   License <license>
 
 ..   Module Reference <api/modules>

diff --git a/_sources/usage.rst.txt b/_sources/usage.rst.txt
@@ -0,0 +1,53 @@
+Usage
+=====
+
+WIP
+
+Magnetic Models
+---------------
+
+- how to load and evaluate magnetic models
+- generic model interface
+- core and lithospheric models
+- magnetospheric models
+- ionospheric models
+- combined and composed models
+- field line tracing
+
+Coordinate Conversions
+----------------------
+- magnetic coordinates
+    - Quasi-Dipole coordinates (with and without the base vectors)
+    - Magnetic Local Time
+    - dipole coordinates
+    - magnetic universal time
+- geographic coordinates
+    - spherical coordinates
+    - Cartesian coordinates
+    - geodetic (WGS84) coordinates
+- vector rotations between different coordinate frames
+
+Time Conversions
+----------------
+- MJD2000 <=> decimal year
+- MDD2000 => year fraction
+
+Sun Positions
+-------------
+
+- ``sunpos``
+
+Utilities
+---------
+
+- vector operations
+
+Low Level Spherical Harmonics
+-----------------------------
+- ``legendre``
+- ``loncossin``
+- ``relradpow``
+- ``sheval``
+- ``sheval_dipole``
+- ``sphargrd``
+- ``spharpot``
diff --git a/doctrees/environment.pickle b/doctrees/environment.pickle
diff --git a/doctrees/index.doctree b/doctrees/index.doctree
diff --git a/doctrees/usage.doctree b/doctrees/usage.doctree
diff --git a/genindex.html b/genindex.html
@@ -51,6 +51,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 

diff --git a/index.html b/index.html
@@ -53,6 +53,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 

diff --git a/installation.html b/installation.html
@@ -20,7 +20,7 @@
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="License" href="license.html" />
+    <link rel="next" title="Usage" href="usage.html" />
     <link rel="prev" title="Introduction" href="index.html" /> 
 </head>
 
@@ -59,6 +59,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#test-installation">Test Installation</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 
@@ -239,7 +240,7 @@ <h2>Test Installation<a class="headerlink" href="#test-installation" title="Perm
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="index.html" class="btn btn-neutral float-left" title="Introduction" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="license.html" class="btn btn-neutral float-right" title="License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="usage.html" class="btn btn-neutral float-right" title="Usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/introduction.html b/introduction.html
@@ -52,6 +52,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 

diff --git a/license.html b/license.html
@@ -20,7 +20,7 @@
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="Installation" href="installation.html" /> 
+    <link rel="prev" title="Usage" href="usage.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -53,6 +53,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Documentation</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">License</a></li>
 </ul>
 
@@ -104,7 +105,7 @@ <h1>License<a class="headerlink" href="#license" title="Permalink to this headin
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="usage.html" class="btn btn-neutral float-left" title="Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 
   <hr/>

diff --git a/objects.inv b/objects.inv
@@ -3,6 +3,4 @@
 # Version: 
 # The remainder of this file is compressed using zlib.
 xڅ�Q
-� ��=��`�����BO�4�������
-}3�/1�~2�y�z��.mMo����3Q�#h���ǐ�D
-Q���[�k-�Z��k-?ن^CHp4j��ȅX�99��{��W�PO>t/�i#����	Ԫ]/r����IY��+
+� ��=��`���`����R5�����b��^$���h,|d"sA���Yښ�M(��3Q�#h�f��c�`"��ʥ�[�i-�Z��k-?x���`oԈ�_�����u����`����GWr�۝�@���"g�<�?*bI�����{�R|���

diff --git a/search.html b/search.html
@@ -54,6 +54,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 

diff --git a/searchindex.js b/searchindex.js