updated doc

wenbinyugroup · Sep 5, 2020 · 6a1e261 · 6a1e261
1 parent 6cc6f6e
commit 6a1e261
Show file tree

Hide file tree

Showing 59 changed files with 2,296 additions and 395 deletions.
diff --git a/cross_section.pyc b/cross_section.pyc
diff --git a/doc/build/doctrees/beam.doctree b/doc/build/doctrees/beam.doctree
diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle
diff --git a/doc/build/doctrees/index.doctree b/doc/build/doctrees/index.doctree
diff --git a/doc/build/doctrees/iogebt.doctree b/doc/build/doctrees/iogebt.doctree
diff --git a/doc/build/doctrees/iovabs.doctree b/doc/build/doctrees/iovabs.doctree
diff --git a/doc/build/doctrees/ms_analysis.doctree b/doc/build/doctrees/ms_analysis.doctree
diff --git a/doc/build/doctrees/ms_module.doctree b/doc/build/doctrees/ms_module.doctree
diff --git a/doc/build/doctrees/prebeam.doctree b/doc/build/doctrees/prebeam.doctree
diff --git a/doc/build/doctrees/sg_io.doctree b/doc/build/doctrees/sg_io.doctree
diff --git a/doc/build/doctrees/sg_module.doctree b/doc/build/doctrees/sg_module.doctree
diff --git a/doc/build/doctrees/utils.doctree b/doc/build/doctrees/utils.doctree
diff --git a/doc/build/html/_sources/beam.rst.txt b/doc/build/html/_sources/beam.rst.txt
@@ -0,0 +1,21 @@
+Class Module for Beam
+=====================
+
+.. highlight:: python
+
+::
+
+    import msgpi.ms.beam
+
+Beam segment
+------------
+
+.. autoclass:: msgpi.ms.beam.BeamSegment
+    :members:
+
+Beam
+----
+
+.. autoclass:: msgpi.ms.beam.Beam
+    :members:
+
diff --git a/doc/build/html/_sources/index.rst.txt b/doc/build/html/_sources/index.rst.txt
@@ -10,11 +10,9 @@ Welcome to Some scripts's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   sg
-   iovabs
-   ioutils
-   presg
-   analysis
+   sg_module
+   ms_module
+   utils
 
 Indices and tables
 ==================

diff --git a/doc/build/html/_sources/iogebt.rst.txt b/doc/build/html/_sources/iogebt.rst.txt
@@ -0,0 +1,27 @@
+I/O Module for GEBT
+===================
+
+.. highlight:: python
+
+::
+
+    import msgpi.ms.iogebt
+
+Reading Functions
+-----------------
+
+.. autofunction:: msgpi.ms.iogebt.readGEBTIn
+
+.. autofunction:: msgpi.ms.iogebt.readGEBTOut
+
+.. autofunction:: msgpi.ms.iogebt.readGEBTOutNode
+
+.. autofunction:: msgpi.ms.iogebt.readGEBTOutStatic
+
+.. autofunction:: msgpi.ms.iogebt.readGEBTOutEigen
+
+Writing Functions
+-----------------
+
+.. autofunction:: msgpi.ms.iogebt.writeGEBTIn
+
diff --git a/doc/build/html/_sources/ms_analysis.rst.txt b/doc/build/html/_sources/ms_analysis.rst.txt
@@ -0,0 +1,16 @@
+analysis Module for GEBT
+========================
+
+.. highlight:: python
+
+::
+
+    import msgpi.ms.analysis
+
+
+.. autofunction:: msgpi.ms.analysis.solveGEBT
+
+.. autofunction:: msgpi.ms.analysis.runGEBT
+
+.. autofunction:: msgpi.ms.analysis.solvePLECS
+
diff --git a/doc/build/html/_sources/ms_module.rst.txt b/doc/build/html/_sources/ms_module.rst.txt
@@ -0,0 +1,11 @@
+Structure Module
+================
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Contents:
+
+  beam
+  iogebt
+  prebeam
+  ms_analysis
diff --git a/doc/build/html/_sources/prebeam.rst.txt b/doc/build/html/_sources/prebeam.rst.txt
@@ -0,0 +1,14 @@
+prebeam Module for GEBT
+=======================
+
+.. highlight:: python
+
+::
+
+    import msgpi.ms.prebeam
+
+Preprocessing Function
+----------------------
+
+.. autofunction:: msgpi.ms.prebeam.preBeam
+
diff --git a/doc/build/html/_sources/sg_io.rst.txt b/doc/build/html/_sources/sg_io.rst.txt
@@ -0,0 +1,9 @@
+SG I/O Module
+=============
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Contents:
+
+  iovabs
+  ioutils
diff --git a/doc/build/html/_sources/sg_module.rst.txt b/doc/build/html/_sources/sg_module.rst.txt
@@ -0,0 +1,12 @@
+SG Module
+=============
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Contents:
+
+  sg
+  presg
+  iovabs
+  ioutils
+  analysis
diff --git a/doc/build/html/_sources/utils.rst.txt b/doc/build/html/_sources/utils.rst.txt
@@ -0,0 +1,12 @@
+Utility Functions
+=================
+
+.. highlight:: python
+
+::
+
+    import msgpi.utils
+
+.. autofunction:: msgpi.utils.calcRotationTensorFromParameters
+
+.. autofunction:: msgpi.utils.calcCab
diff --git a/doc/build/html/analysis.html b/doc/build/html/analysis.html
@@ -35,7 +35,8 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="presg Module" href="presg.html" /> 
+    <link rel="next" title="Structure Module" href="ms_module.html" />
+    <link rel="prev" title="I/O Utility Functions" href="ioutils.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -81,11 +82,15 @@
 
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="sg.html">Class Module for MSM Structure Gene</a></li>
-<li class="toctree-l1"><a class="reference internal" href="iovabs.html">SG I/O Module for VABS</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ioutils.html">I/O Utility Functions</a></li>
-<li class="toctree-l1"><a class="reference internal" href="presg.html">presg Module</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">analysis Module</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="sg_module.html">SG I/O Module</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="sg.html">Class Module for MSM Structure Gene</a></li>
+<li class="toctree-l2"><a class="reference internal" href="presg.html">presg Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="iovabs.html">SG I/O Module for VABS</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ioutils.html">I/O Utility Functions</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">analysis Module</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="ms_module.html">Structure Module</a></li>
 </ul>
 
 
@@ -131,6 +136,8 @@
 
       <li><a href="index.html">Docs</a> &raquo;</li>
 
+          <li><a href="sg_module.html">SG I/O Module</a> &raquo;</li>
+
       <li>analysis Module</li>
 
 
@@ -221,8 +228,10 @@ <h1>analysis Module<a class="headerlink" href="#analysis-module" title="Permalin
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
+        <a href="ms_module.html" class="btn btn-neutral float-right" title="Structure Module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+
 
-        <a href="presg.html" class="btn btn-neutral float-left" title="presg Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="ioutils.html" class="btn btn-neutral float-left" title="I/O Utility Functions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>