Add docs file for documentation

mathias77515 · Sep 11, 2024 · 4a036b5 · 4a036b5
1 parent 0100be5
commit 4a036b5
Show file tree

Hide file tree

Showing 103 changed files with 14,054 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,42 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import sys
+import os
+
+sys.path.insert(0, os.path.abspath('../src'))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'QUBIC Simulation Pipelines'
+copyright = '2024, Mathias Regnier & Tom Laclavère'
+author = 'Mathias Regnier & Tom Laclavère'
+release = '0.8'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    'sphinx_autodoc_typehints',
+    "numpydoc",
+    'sphinx.ext.mathjax',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
@@ -0,0 +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: 0d6811bd6709feaeca229028a861418f
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/.doctrees/CMM.doctree b/docs/html/.doctrees/CMM.doctree
diff --git a/docs/html/.doctrees/CMM.pipeline.doctree b/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_acquisition.doctree b/docs/html/.doctrees/CMM.preset.preset_acquisition.doctree
diff --git a/docs/html/.doctrees/CMM.preset.preset_components.doctree b/docs/html/.doctrees/CMM.preset.preset_components.doctree
diff --git a/docs/html/.doctrees/CMM.preset.preset_external_data.doctree b/docs/html/.doctrees/CMM.preset.preset_external_data.doctree
diff --git a/docs/html/.doctrees/CMM.preset.preset_gain.doctree b/docs/html/.doctrees/CMM.preset.preset_gain.doctree
diff --git a/docs/html/.doctrees/CMM.preset.preset_mixingmatrix.doctree b/docs/html/.doctrees/CMM.preset.preset_mixingmatrix.doctree
diff --git a/docs/html/.doctrees/CMM.preset.preset_qubic.doctree b/docs/html/.doctrees/CMM.preset.preset_qubic.doctree
diff --git a/docs/html/.doctrees/CMM.preset.preset_sky.doctree b/docs/html/.doctrees/CMM.preset.preset_sky.doctree
diff --git a/docs/html/.doctrees/CMM.preset.preset_tools.doctree b/docs/html/.doctrees/CMM.preset.preset_tools.doctree
diff --git a/docs/html/.doctrees/FMM.doctree b/docs/html/.doctrees/FMM.doctree
diff --git a/docs/html/.doctrees/FMM.main.doctree b/docs/html/.doctrees/FMM.main.doctree
diff --git a/docs/html/.doctrees/FMM.pipeline.doctree b/docs/html/.doctrees/FMM.pipeline.doctree
diff --git a/docs/html/.doctrees/environment.pickle b/docs/html/.doctrees/environment.pickle
diff --git a/docs/html/.doctrees/index.doctree b/docs/html/.doctrees/index.doctree
diff --git a/docs/html/.doctrees/modules.doctree b/docs/html/.doctrees/modules.doctree
diff --git a/docs/html/.nojekyll b/docs/html/.nojekyll
diff --git a/docs/html/CMM.html b/docs/html/CMM.html
@@ -0,0 +1,176 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="./">
+<head>
+  <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 package &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" />
+
+
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <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=a0e24af7"></script>
+        <script src="_static/doctools.js?v=9a2dae69"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+        <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
+    <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 package" href="CMM.preset.html" />
+    <link rel="prev" title="QUBIC Simulation Pipelines documentation" href="index.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="index.html" class="icon icon-home">
+            QUBIC Simulation Pipelines
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="#">CMM package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.html">CMM.preset package</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CMM.pipeline.html">CMM.pipeline module</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="FMM.html">FMM package</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">QUBIC Simulation Pipelines</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">CMM package</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/CMM.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="module-CMM">
+<span id="cmm-package"></span><h1>CMM package<a class="headerlink" href="#module-CMM" title="Link to this heading"></a></h1>
+<section id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading"></a></h2>
+<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#submodules">Submodules</a><ul>
+<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>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_components.html">CMM.preset.preset_components module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CMM.preset.preset_components.html#CMM.preset.preset_components.PresetComponents"><code class="docutils literal notranslate"><span class="pre">PresetComponents</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_external_data.html">CMM.preset.preset_external_data module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CMM.preset.preset_external_data.html#CMM.preset.preset_external_data.PresetExternal"><code class="docutils literal notranslate"><span class="pre">PresetExternal</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_gain.html">CMM.preset.preset_gain module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CMM.preset.preset_gain.html#CMM.preset.preset_gain.PresetGain"><code class="docutils literal notranslate"><span class="pre">PresetGain</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_mixingmatrix.html">CMM.preset.preset_mixingmatrix module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CMM.preset.preset_mixingmatrix.html#CMM.preset.preset_mixingmatrix.PresetMixingMatrix"><code class="docutils literal notranslate"><span class="pre">PresetMixingMatrix</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_qubic.html">CMM.preset.preset_qubic module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CMM.preset.preset_qubic.html#CMM.preset.preset_qubic.PresetQubic"><code class="docutils literal notranslate"><span class="pre">PresetQubic</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_sky.html">CMM.preset.preset_sky module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CMM.preset.preset_sky.html#CMM.preset.preset_sky.PresetSky"><code class="docutils literal notranslate"><span class="pre">PresetSky</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="CMM.preset.preset_tools.html">CMM.preset.preset_tools module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CMM.preset.preset_tools.html#CMM.preset.preset_tools.PresetTools"><code class="docutils literal notranslate"><span class="pre">PresetTools</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</section>
+<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.pipeline.html">CMM.pipeline module</a></li>
+</ul>
+</div>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="index.html" class="btn btn-neutral float-left" title="QUBIC Simulation Pipelines documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="CMM.preset.html" class="btn btn-neutral float-right" title="CMM.preset package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Mathias Regnier &amp; Tom Laclavère.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/docs/html/CMM.pipeline.html b/docs/html/CMM.pipeline.html
@@ -0,0 +1,120 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="./">
+<head>
+  <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.pipeline 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" />
+
+
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <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=a0e24af7"></script>
+        <script src="_static/doctools.js?v=9a2dae69"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <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="FMM package" href="FMM.html" />
+    <link rel="prev" title="CMM.preset.preset_tools module" href="CMM.preset.preset_tools.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="index.html" class="icon icon-home">
+            QUBIC Simulation Pipelines
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CMM.html">CMM package</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="CMM.html#subpackages">Subpackages</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="CMM.html#submodules">Submodules</a><ul class="current">
+<li class="toctree-l3 current"><a class="current reference internal" href="#">CMM.pipeline module</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="FMM.html">FMM package</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">QUBIC Simulation Pipelines</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <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 active">CMM.pipeline module</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/CMM.pipeline.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-pipeline-module">
+<h1>CMM.pipeline module<a class="headerlink" href="#cmm-pipeline-module" title="Link to this heading"></a></h1>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="CMM.preset.preset_tools.html" class="btn btn-neutral float-left" title="CMM.preset.preset_tools module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="FMM.html" class="btn btn-neutral float-right" title="FMM package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Mathias Regnier &amp; Tom Laclavère.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>