updated doc for v1.2.1

AdrienPlacais · Jan 29, 2024 · e82371e · e82371e
1 parent 9b820ce
commit e82371e
Show file tree

Hide file tree

Showing 84 changed files with 550 additions and 687 deletions.
diff --git a/doctrees/environment.pickle b/doctrees/environment.pickle
diff --git a/doctrees/index.doctree b/doctrees/index.doctree
diff --git a/doctrees/manual/introduction.doctree b/doctrees/manual/introduction.doctree
diff --git a/doctrees/manual/notebooks/.virtual_documents/particle_monitor.doctree b/doctrees/manual/notebooks/.virtual_documents/particle_monitor.doctree
diff --git a/doctrees/manual/notebooks/particle_monitor.doctree b/doctrees/manual/notebooks/particle_monitor.doctree
diff --git a/doctrees/nbsphinx/manual/notebooks/particle_monitor.ipynb b/doctrees/nbsphinx/manual/notebooks/particle_monitor.ipynb
diff --git a/...manual_notebooks_particle_monitor_9_0.png → ...anual_notebooks_particle_monitor_10_0.png b/...manual_notebooks_particle_monitor_9_0.png → ...anual_notebooks_particle_monitor_10_0.png
diff --git a/...anual_notebooks_particle_monitor_18_0.png → ...anual_notebooks_particle_monitor_19_0.png b/...anual_notebooks_particle_monitor_18_0.png → ...anual_notebooks_particle_monitor_19_0.png
diff --git a/doctrees/nbsphinx/manual_notebooks_particle_monitor_22_0.jpg b/doctrees/nbsphinx/manual_notebooks_particle_monitor_22_0.jpg
diff --git a/doctrees/nbsphinx/manual_notebooks_particle_monitor_22_0.png b/doctrees/nbsphinx/manual_notebooks_particle_monitor_22_0.png
diff --git a/doctrees/nbsphinx/manual_notebooks_particle_monitor_28_0.jpg b/doctrees/nbsphinx/manual_notebooks_particle_monitor_28_0.jpg
diff --git a/doctrees/nbsphinx/manual_notebooks_particle_monitor_28_0.png b/doctrees/nbsphinx/manual_notebooks_particle_monitor_28_0.png
diff --git a/...manual_notebooks_particle_monitor_7_0.png → ...manual_notebooks_particle_monitor_8_0.png b/...manual_notebooks_particle_monitor_7_0.png → ...manual_notebooks_particle_monitor_8_0.png
diff --git a/doctrees/simulia_multipactor_lib.visualization.plot_3d.doctree b/doctrees/simulia_multipactor_lib.visualization.plot_3d.doctree
diff --git a/html/.buildinfo b/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 48f493b14ddddd5b13e8bce225263c11
+config: 70a5430c4613be22eb310fa6fcc18ee9
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/html/_images/manual_notebooks_particle_monitor_10_0.png b/html/_images/manual_notebooks_particle_monitor_10_0.png
diff --git a/html/_images/manual_notebooks_particle_monitor_19_0.png b/html/_images/manual_notebooks_particle_monitor_19_0.png
diff --git a/html/_images/manual_notebooks_particle_monitor_22_0.png b/html/_images/manual_notebooks_particle_monitor_22_0.png
diff --git a/html/_images/manual_notebooks_particle_monitor_28_0.png b/html/_images/manual_notebooks_particle_monitor_28_0.png
diff --git a/html/_images/manual_notebooks_particle_monitor_8_0.png b/html/_images/manual_notebooks_particle_monitor_8_0.png
diff --git a/html/_images/trajectories.png b/html/_images/trajectories.png
diff --git a/html/_sources/index.rst.txt b/html/_sources/index.rst.txt
@@ -2,7 +2,7 @@ Welcome to Simulia Multipactor Library documentation!
 =====================================================
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 4
    :caption: Contents:
    :titlesonly:
    :glob:

diff --git a/html/_sources/manual/examples.rst.txt b/html/_sources/manual/examples.rst.txt
diff --git a/html/_sources/manual/introduction.rst.txt b/html/_sources/manual/introduction.rst.txt
@@ -1,7 +1,7 @@
 Introduction
 ============
 This library is a set of tool to treat results from CST and SPARK3D.
-All illustrations shown below are produced with the scripts from the :doc:`examples` section.
+All illustrations shown below are produced with the scripts from the Jupyter notebook examples.
 
 
 Compute exponential growth factors
@@ -41,6 +41,9 @@ Compute distribution of the impact angles
 .. image:: images/collision_angle_distribution.png
    :alt: Distribution of collision angles
 
+.. note::
+   In contrary to the collision angle histogram, the collision and emission energy histograms are natively available in CST.
+
 Plot trajectories
 -----------------
 
@@ -50,6 +53,3 @@ Plot trajectories
 .. image:: images/trajectories_2.png
    :alt: Plot of some trajectories
 
-
-.. note::
-   The collision and emission energy histograms are natively available in CST.
diff --git a/html/_sources/manual/notebooks/particle_monitor.ipynb.txt b/html/_sources/manual/notebooks/particle_monitor.ipynb.txt
diff --git a/html/_sources/multipactor.constants.rst.txt b/html/_sources/multipactor.constants.rst.txt
diff --git a/html/_sources/multipactor.experimental.rst.txt b/html/_sources/multipactor.experimental.rst.txt
diff --git a/html/_sources/multipactor.helper.helper.rst.txt b/html/_sources/multipactor.helper.helper.rst.txt
diff --git a/html/_sources/multipactor.helper.rst.txt b/html/_sources/multipactor.helper.rst.txt
diff --git a/html/_sources/multipactor.lib.rst.txt b/html/_sources/multipactor.lib.rst.txt
diff --git a/html/_sources/multipactor.loaders.loader_cst.rst.txt b/html/_sources/multipactor.loaders.loader_cst.rst.txt
diff --git a/html/_sources/multipactor.loaders.loader_spark.rst.txt b/html/_sources/multipactor.loaders.loader_spark.rst.txt
diff --git a/html/_sources/multipactor.loaders.rst.txt b/html/_sources/multipactor.loaders.rst.txt
diff --git a/html/_sources/multipactor.particle_monitor.collisions.rst.txt b/html/_sources/multipactor.particle_monitor.collisions.rst.txt
diff --git a/html/_sources/multipactor.particle_monitor.collisions.util.rst.txt b/html/_sources/multipactor.particle_monitor.collisions.util.rst.txt
diff --git a/html/_sources/multipactor.particle_monitor.collisions.vedo_mesh_collisions.rst.txt b/html/_sources/multipactor.particle_monitor.collisions.vedo_mesh_collisions.rst.txt
diff --git a/html/_sources/multipactor.particle_monitor.converters.rst.txt b/html/_sources/multipactor.particle_monitor.converters.rst.txt
diff --git a/html/_sources/multipactor.particle_monitor.particle.rst.txt b/html/_sources/multipactor.particle_monitor.particle.rst.txt
diff --git a/html/_sources/multipactor.particle_monitor.particle_monitor.rst.txt b/html/_sources/multipactor.particle_monitor.particle_monitor.rst.txt
diff --git a/html/_sources/multipactor.particle_monitor.rst.txt b/html/_sources/multipactor.particle_monitor.rst.txt
diff --git a/html/_sources/multipactor.particle_monitor.studies.rst.txt b/html/_sources/multipactor.particle_monitor.studies.rst.txt
diff --git a/html/_sources/multipactor.rst.txt b/html/_sources/multipactor.rst.txt
diff --git a/html/_sources/multipactor.util.exp_growth.rst.txt b/html/_sources/multipactor.util.exp_growth.rst.txt
diff --git a/html/_sources/multipactor.util.rst.txt b/html/_sources/multipactor.util.rst.txt
diff --git a/html/_sources/multipactor.visualization.plot.rst.txt b/html/_sources/multipactor.visualization.plot.rst.txt
diff --git a/html/_sources/multipactor.visualization.plot_3d.rst.txt b/html/_sources/multipactor.visualization.plot_3d.rst.txt
diff --git a/html/_sources/multipactor.visualization.rst.txt b/html/_sources/multipactor.visualization.rst.txt
diff --git a/html/_static/documentation_options.js b/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.2-8-g13dfe48',
+    VERSION: '1.2-15-gc57d84a',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/html/genindex.html b/html/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; Simulia Multipactor Library 1.2-8-g13dfe48 documentation</title>
+  <title>Index &mdash; Simulia Multipactor Library 1.2-15-gc57d84a documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=c08a3ddd"></script>
+        <script src="_static/documentation_options.js?v=f857d308"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -35,7 +35,7 @@
             Simulia Multipactor Library
           </a>
               <div class="version">
-                1.2-8-g13dfe48
+                1.2-15-gc57d84a
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">