Add documentation repository

mathias77515 · Sep 11, 2024 · ee94884 · ee94884
1 parent 2e6792d
commit ee94884
Show file tree

Hide file tree

Showing 132 changed files with 410 additions and 588 deletions.
diff --git a/docs/CMM.pipeline.rst b/docs/CMM.pipeline.rst
diff --git a/docs/CMM.preset.preset_.rst b/docs/CMM.preset.preset_.rst
diff --git a/docs/CMM.preset.preset_acquisition.rst b/docs/CMM.preset.preset_acquisition.rst
diff --git a/docs/CMM.preset.preset_components.rst b/docs/CMM.preset.preset_components.rst
diff --git a/docs/CMM.preset.preset_external_data.rst b/docs/CMM.preset.preset_external_data.rst
diff --git a/docs/CMM.preset.preset_gain.rst b/docs/CMM.preset.preset_gain.rst
diff --git a/docs/CMM.preset.preset_mixingmatrix.rst b/docs/CMM.preset.preset_mixingmatrix.rst
diff --git a/docs/CMM.preset.preset_qubic.rst b/docs/CMM.preset.preset_qubic.rst
diff --git a/docs/CMM.preset.preset_sky.rst b/docs/CMM.preset.preset_sky.rst
diff --git a/docs/CMM.preset.preset_tools.rst b/docs/CMM.preset.preset_tools.rst
diff --git a/docs/CMM.preset.rst b/docs/CMM.preset.rst
diff --git a/docs/CMM.rst b/docs/CMM.rst
diff --git a/docs/FMM.main.rst b/docs/FMM.main.rst
diff --git a/docs/FMM.pipeline.rst b/docs/FMM.pipeline.rst
diff --git a/docs/FMM.rst b/docs/FMM.rst
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/_build/doctrees/CMM.preset.doctree b/docs/_build/doctrees/CMM.preset.doctree
diff --git a/docs/_build/doctrees/CMM.preset.preset_.doctree b/docs/_build/doctrees/CMM.preset.preset_.doctree
diff --git a/docs/_build/html/.nojekyll b/docs/_build/html/.nojekyll
diff --git a/docs/_build/html/_sources/CMM.preset.preset_.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_.rst.txt
diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/conf.py b/docs/conf.py
@@ -6,7 +6,7 @@
 import sys
 import os
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../src'))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

diff --git a/docs/_build/html/.buildinfo → docs/html/.buildinfo b/docs/_build/html/.buildinfo → docs/html/.buildinfo
diff --git a/docs/_build/doctrees/CMM.doctree → docs/html/.doctrees/CMM.doctree b/docs/_build/doctrees/CMM.doctree → docs/html/.doctrees/CMM.doctree
diff --git a/docs/_build/doctrees/CMM.pipeline.doctree → docs/html/.doctrees/CMM.pipeline.doctree b/docs/_build/doctrees/CMM.pipeline.doctree → docs/html/.doctrees/CMM.pipeline.doctree
diff --git a/docs/html/.doctrees/CMM.preset.doctree b/docs/html/.doctrees/CMM.preset.doctree
diff --git a/docs/html/.doctrees/CMM.preset.preset.doctree b/docs/html/.doctrees/CMM.preset.preset.doctree
diff --git a/...ees/CMM.preset.preset_acquisition.doctree → ...ees/CMM.preset.preset_acquisition.doctree b/...ees/CMM.preset.preset_acquisition.doctree → ...ees/CMM.preset.preset_acquisition.doctree
diff --git a/...rees/CMM.preset.preset_components.doctree → ...rees/CMM.preset.preset_components.doctree b/...rees/CMM.preset.preset_components.doctree → ...rees/CMM.preset.preset_components.doctree
diff --git a/...s/CMM.preset.preset_external_data.doctree → ...s/CMM.preset.preset_external_data.doctree b/...s/CMM.preset.preset_external_data.doctree → ...s/CMM.preset.preset_external_data.doctree
diff --git a/...d/doctrees/CMM.preset.preset_gain.doctree → .../.doctrees/CMM.preset.preset_gain.doctree b/...d/doctrees/CMM.preset.preset_gain.doctree → .../.doctrees/CMM.preset.preset_gain.doctree
diff --git a/...es/CMM.preset.preset_mixingmatrix.doctree → ...es/CMM.preset.preset_mixingmatrix.doctree b/...es/CMM.preset.preset_mixingmatrix.doctree → ...es/CMM.preset.preset_mixingmatrix.doctree
diff --git a/.../doctrees/CMM.preset.preset_qubic.doctree → ....doctrees/CMM.preset.preset_qubic.doctree b/.../doctrees/CMM.preset.preset_qubic.doctree → ....doctrees/CMM.preset.preset_qubic.doctree
diff --git a/...ld/doctrees/CMM.preset.preset_sky.doctree → ...l/.doctrees/CMM.preset.preset_sky.doctree b/...ld/doctrees/CMM.preset.preset_sky.doctree → ...l/.doctrees/CMM.preset.preset_sky.doctree
diff --git a/.../doctrees/CMM.preset.preset_tools.doctree → ....doctrees/CMM.preset.preset_tools.doctree b/.../doctrees/CMM.preset.preset_tools.doctree → ....doctrees/CMM.preset.preset_tools.doctree
diff --git a/docs/_build/doctrees/FMM.doctree → docs/html/.doctrees/FMM.doctree b/docs/_build/doctrees/FMM.doctree → docs/html/.doctrees/FMM.doctree
diff --git a/docs/_build/doctrees/FMM.main.doctree → docs/html/.doctrees/FMM.main.doctree b/docs/_build/doctrees/FMM.main.doctree → docs/html/.doctrees/FMM.main.doctree
diff --git a/docs/_build/doctrees/FMM.pipeline.doctree → docs/html/.doctrees/FMM.pipeline.doctree b/docs/_build/doctrees/FMM.pipeline.doctree → docs/html/.doctrees/FMM.pipeline.doctree
diff --git a/docs/_build/doctrees/environment.pickle → docs/html/.doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle → docs/html/.doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree → docs/html/.doctrees/index.doctree b/docs/_build/doctrees/index.doctree → docs/html/.doctrees/index.doctree
diff --git a/docs/_build/doctrees/modules.doctree → docs/html/.doctrees/modules.doctree b/docs/_build/doctrees/modules.doctree → docs/html/.doctrees/modules.doctree
diff --git a/docs/.nojekyll → docs/html/.nojekyll b/docs/.nojekyll → docs/html/.nojekyll
diff --git a/docs/_build/html/CMM.html → docs/html/CMM.html b/docs/_build/html/CMM.html → docs/html/CMM.html
@@ -92,12 +92,11 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="CMM.preset.html">CMM.preset package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="CMM.preset.html#CMM.preset.PresetInitialisation"><code class="docutils literal notranslate"><span class="pre">PresetInitialisation</span></code></a><ul>
-<li class="toctree-l3"><a class="reference internal" href="CMM.preset.html#CMM.preset.PresetInitialisation.initialize"><code class="docutils literal notranslate"><span class="pre">PresetInitialisation.initialize()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="CMM.preset.html#submodules">Submodules</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset.html">CMM.preset.preset module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CMM.preset.preset.html#CMM.preset.preset.PresetInitialisation"><code class="docutils literal notranslate"><span class="pre">PresetInitialisation</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="CMM.preset.html#submodules">Submodules</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_.html">CMM.preset.preset_ module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_acquisition.html">CMM.preset.preset_acquisition module</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="CMM.preset.preset_acquisition.html#CMM.preset.preset_acquisition.PresetAcquisition"><code class="docutils literal notranslate"><span class="pre">PresetAcquisition</span></code></a></li>
 </ul>

diff --git a/docs/_build/html/CMM.pipeline.html → docs/html/CMM.pipeline.html b/docs/_build/html/CMM.pipeline.html → docs/html/CMM.pipeline.html
diff --git a/docs/_build/html/CMM.preset.html → docs/html/CMM.preset.html b/docs/_build/html/CMM.preset.html → docs/html/CMM.preset.html
@@ -22,7 +22,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="CMM.preset.preset_ module" href="CMM.preset.preset_.html" />
+    <link rel="next" title="CMM.preset.preset module" href="CMM.preset.preset.html" />
     <link rel="prev" title="CMM package" href="CMM.html" /> 
 </head>
 
@@ -50,7 +50,6 @@
 <li class="toctree-l1 current"><a class="reference internal" href="CMM.html">CMM package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="CMM.html#subpackages">Subpackages</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">CMM.preset package</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#CMM.preset.PresetInitialisation"><code class="docutils literal notranslate"><span class="pre">PresetInitialisation</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
 </ul>
 </li>
@@ -89,43 +88,17 @@
 
   <section id="module-CMM.preset">
 <span id="cmm-preset-package"></span><h1>CMM.preset package<a class="headerlink" href="#module-CMM.preset" title="Link to this heading"></a></h1>
-<dl class="py class">
-<dt class="sig sig-object py" id="CMM.preset.PresetInitialisation">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">CMM.preset.</span></span><span class="sig-name descname"><span class="pre">PresetInitialisation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">comm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed_noise</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CMM/preset.html#PresetInitialisation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CMM.preset.PresetInitialisation" title="Link to this definition"></a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>Preset initialization.</p>
-<p>Instance to initialize the Components Map-Making reading all the preset files.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>comm</strong> (<em>MPI communicator</em>) – MPI common communicator (define by MPI.COMM_WORLD).</p></li>
-<li><p><strong>seed</strong> (<em>int</em>) – Seed for random CMB realization.</p></li>
-<li><p><strong>seed_noise</strong> (<em>int</em>) – Seed for random noise realization.</p></li>
-</ul>
-</dd>
-</dl>
-<p class="rubric">Methods</p>
-<table class="autosummary longtable docutils align-default">
-<tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="#CMM.preset.PresetInitialisation.initialize" title="CMM.preset.PresetInitialisation.initialize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">initialize</span></code></a>()</p></td>
-<td><p>Initialization.</p></td>
-</tr>
-</tbody>
-</table>
-<dl class="py method">
-<dt class="sig sig-object py" id="CMM.preset.PresetInitialisation.initialize">
-<span class="sig-name descname"><span class="pre">initialize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CMM/preset.html#PresetInitialisation.initialize"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CMM.preset.PresetInitialisation.initialize" title="Link to this definition"></a></dt>
-<dd><p>Initialization.</p>
-<p>Method that initialize and return all the preset instances that will be used in Component Map-Making Pipeline.</p>
-</dd></dl>
-
-</dd></dl>
-
 <section id="submodules">
 <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CMM.preset.preset_.html">CMM.preset.preset_ module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CMM.preset.preset.html">CMM.preset.preset module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="CMM.preset.preset.html#CMM.preset.preset.PresetInitialisation"><code class="docutils literal notranslate"><span class="pre">PresetInitialisation</span></code></a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset.html#CMM.preset.preset.PresetInitialisation.initialize"><code class="docutils literal notranslate"><span class="pre">PresetInitialisation.initialize()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="CMM.preset.preset_acquisition.html">CMM.preset.preset_acquisition module</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="CMM.preset.preset_acquisition.html#CMM.preset.preset_acquisition.PresetAcquisition"><code class="docutils literal notranslate"><span class="pre">PresetAcquisition</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_acquisition.html#CMM.preset.preset_acquisition.PresetAcquisition.seed_noise"><code class="docutils literal notranslate"><span class="pre">PresetAcquisition.seed_noise</span></code></a></li>
@@ -264,7 +237,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="CMM.html" class="btn btn-neutral float-left" title="CMM package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="CMM.preset.preset_.html" class="btn btn-neutral float-right" title="CMM.preset.preset_ module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="CMM.preset.preset.html" class="btn btn-neutral float-right" title="CMM.preset.preset module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/docs/_build/html/CMM.preset.preset_.html → docs/html/CMM.preset.preset.html b/docs/_build/html/CMM.preset.preset_.html → docs/html/CMM.preset.preset.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>CMM.preset.preset_ module &mdash; QUBIC Simulation Pipelines 0.8 documentation</title>
+  <title>CMM.preset.preset module &mdash; QUBIC Simulation Pipelines 0.8 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" />
 
@@ -49,7 +49,6 @@
 <li class="toctree-l1 current"><a class="reference internal" href="CMM.html">CMM package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="CMM.html#subpackages">Subpackages</a><ul class="current">
 <li class="toctree-l3 current"><a class="reference internal" href="CMM.preset.html">CMM.preset package</a><ul class="current">
-<li class="toctree-l4"><a class="reference internal" href="CMM.preset.html#CMM.preset.PresetInitialisation"><code class="docutils literal notranslate"><span class="pre">PresetInitialisation</span></code></a></li>
 <li class="toctree-l4 current"><a class="reference internal" href="CMM.preset.html#submodules">Submodules</a></li>
 </ul>
 </li>
@@ -77,18 +76,50 @@
       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
           <li class="breadcrumb-item"><a href="CMM.html">CMM package</a></li>
           <li class="breadcrumb-item"><a href="CMM.preset.html">CMM.preset package</a></li>
-      <li class="breadcrumb-item active">CMM.preset.preset_ module</li>
+      <li class="breadcrumb-item active">CMM.preset.preset module</li>
       <li class="wy-breadcrumbs-aside">
-            <a href="_sources/CMM.preset.preset_.rst.txt" rel="nofollow"> View page source</a>
+            <a href="_sources/CMM.preset.preset.rst.txt" rel="nofollow"> View page source</a>
       </li>
   </ul>
   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="cmm-preset-preset-module">
-<h1>CMM.preset.preset_ module<a class="headerlink" href="#cmm-preset-preset-module" title="Link to this heading"></a></h1>
+  <section id="module-CMM.preset.preset">
+<span id="cmm-preset-preset-module"></span><h1>CMM.preset.preset module<a class="headerlink" href="#module-CMM.preset.preset" title="Link to this heading"></a></h1>
+<dl class="py class">
+<dt class="sig sig-object py" id="CMM.preset.preset.PresetInitialisation">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">CMM.preset.preset.</span></span><span class="sig-name descname"><span class="pre">PresetInitialisation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">comm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed_noise</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CMM/preset/preset.html#PresetInitialisation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CMM.preset.preset.PresetInitialisation" title="Link to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Preset initialization.</p>
+<p>Instance to initialize the Components Map-Making reading all the preset files.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>comm</strong> (<em>MPI communicator</em>) – MPI common communicator (define by MPI.COMM_WORLD).</p></li>
+<li><p><strong>seed</strong> (<em>int</em>) – Seed for random CMB realization.</p></li>
+<li><p><strong>seed_noise</strong> (<em>int</em>) – Seed for random noise realization.</p></li>
+</ul>
+</dd>
+</dl>
+<p class="rubric">Methods</p>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="#CMM.preset.preset.PresetInitialisation.initialize" title="CMM.preset.preset.PresetInitialisation.initialize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">initialize</span></code></a>()</p></td>
+<td><p>Initialization.</p></td>
+</tr>
+</tbody>
+</table>
+<dl class="py method">
+<dt class="sig sig-object py" id="CMM.preset.preset.PresetInitialisation.initialize">
+<span class="sig-name descname"><span class="pre">initialize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CMM/preset/preset.html#PresetInitialisation.initialize"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#CMM.preset.preset.PresetInitialisation.initialize" title="Link to this definition"></a></dt>
+<dd><p>Initialization.</p>
+<p>Method that initialize and return all the preset instances that will be used in Component Map-Making Pipeline.</p>
+</dd></dl>
+
+</dd></dl>
+
 </section>
 
 

diff --git a/...d/html/CMM.preset.preset_acquisition.html → docs/html/CMM.preset.preset_acquisition.html b/...d/html/CMM.preset.preset_acquisition.html → docs/html/CMM.preset.preset_acquisition.html
@@ -23,7 +23,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="CMM.preset.preset_components module" href="CMM.preset.preset_components.html" />
-    <link rel="prev" title="CMM.preset.preset_ module" href="CMM.preset.preset_.html" /> 
+    <link rel="prev" title="CMM.preset.preset module" href="CMM.preset.preset.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -50,7 +50,6 @@
 <li class="toctree-l1 current"><a class="reference internal" href="CMM.html">CMM package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="CMM.html#subpackages">Subpackages</a><ul class="current">
 <li class="toctree-l3 current"><a class="reference internal" href="CMM.preset.html">CMM.preset package</a><ul class="current">
-<li class="toctree-l4"><a class="reference internal" href="CMM.preset.html#CMM.preset.PresetInitialisation"><code class="docutils literal notranslate"><span class="pre">PresetInitialisation</span></code></a></li>
 <li class="toctree-l4 current"><a class="reference internal" href="CMM.preset.html#submodules">Submodules</a></li>
 </ul>
 </li>
@@ -456,7 +455,7 @@
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="CMM.preset.preset_.html" class="btn btn-neutral float-left" title="CMM.preset.preset_ module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="CMM.preset.preset.html" class="btn btn-neutral float-left" title="CMM.preset.preset module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="CMM.preset.preset_components.html" class="btn btn-neutral float-right" title="CMM.preset.preset_components module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>