Skip to content

Files

Latest commit

schmoelderschmoelder
Deploying to master from @ cadet/CADET-Website@c8143de 🚀
Jan 16, 2025
bb0c9dc · Jan 16, 2025

History

History

v5.0.3

README.html

<!DOCTYPE html>

<html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>CADET Documentation &#8212; CADET</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=2bcfc6fe" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="canonical" href="https://cadet.github.io/master/README.html" />
    <link rel="icon" href="_static/cadet_icon.png"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  

  
  

  </head><body>
  <div class="document">
    
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">CADET-Core</a></h1>



<p class="blurb">CADET - An open platform for integrated process modelling and simulation</p>






<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started/index.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="modelling/index.html">Modelling</a></li>
<li class="toctree-l1"><a class="reference internal" href="simulation/index.html">Simulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="interface/index.html">Interface specifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer_guide/index.html">Developer Guide</a></li>
<li class="toctree-l1"><a class="reference external" href="https://cadet.github.io/CADET-Match/master/index.html">CADET-Match</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="zbibliography.html">Bibliography</a></li>
<li class="toctree-l1"><a class="reference external" href="https://www.fz-juelich.de/en/legal-notice">Legal notice</a></li>
</ul>


<search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3>Releases</h3>
<ul>
  <li><a href="../v4.3.0/index.html">v4.3.0</a></li>
  <li><a href="../v4.4.0/index.html">v4.4.0</a></li>
  <li><a href="../v5.0.0/README.html">v5.0.0</a></li>
  <li><a href="../v5.0.1/README.html">v5.0.1</a></li>
  <li><a href="../v5.0.2/README.html">v5.0.2</a></li>
  <li><a href="README.html">v5.0.3</a></li>
</ul>
<h3>Branches</h3>
<ul>
  <li><a href="../master/README.html">master</a></li>
  <li><a href="../chore/developer_guide/README.html">chore/developer_guide</a></li>
</ul>

        </div>
      </div>
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            


  <section id="cadet-documentation">
<h1>CADET Documentation<a class="headerlink" href="#cadet-documentation" title="Link to this heading">¶</a></h1>
<p>To build the documentation locally, in the <code class="docutils literal notranslate"><span class="pre">doc</span></code> folder, install sphinx and other dependencies by running</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>

</pre></div>
</div>
<p>Then, in the <code class="docutils literal notranslate"><span class="pre">doc</span></code> folder, run:</p>
<p><code class="docutils literal notranslate"><span class="pre">sphinx-build</span> <span class="pre">-b</span> <span class="pre">html</span> <span class="pre">.</span> <span class="pre">build</span></code></p>
<p>The output is in the <code class="docutils literal notranslate"><span class="pre">build</span></code> directory and can be opened with any browser.</p>
<p>To build the documentation for all releases and the master branch, run:</p>
<p><code class="docutils literal notranslate"><span class="pre">sphinx-multiversion</span> <span class="pre">./</span> <span class="pre">./build/</span></code>.</p>
<p>Any changes to the documentation will automatically be pushed to the github-pages repository (https://github.com/cadet/cadet.github.io) using github actions.</p>
</section>



          </div>
          
        </div>
      </div>
    <div class="clearer"></div>
  </div>
    <div class="footer">
      &#169;2008-2025.
      
      |
      <a href="_sources/README.md.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>