deploy: 2e0d151

iAniket23 · Nov 15, 2024 · 693d1fd · 693d1fd
commit 693d1fd
Show file tree

Hide file tree

Showing 85 changed files with 13,319 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: c98e4b9e82fe8f3c7abb82aeb2c5a6e4
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/fissionmunk.doctree b/.doctrees/fissionmunk.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/modules.doctree b/.doctrees/modules.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_modules/fissionmunk/ControlRod.html b/_modules/fissionmunk/ControlRod.html
diff --git a/_modules/fissionmunk/Core.html b/_modules/fissionmunk/Core.html
diff --git a/_modules/fissionmunk/Fuel.html b/_modules/fissionmunk/Fuel.html
diff --git a/_modules/fissionmunk/FuelElement.html b/_modules/fissionmunk/FuelElement.html
diff --git a/_modules/fissionmunk/Material.html b/_modules/fissionmunk/Material.html
@@ -0,0 +1,119 @@
+
+
+<!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.0" />
+  <title>fissionmunk.Material &mdash; FissionMunk 0.0.2 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=e59714d7" />
+
+
+      <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=e3a6060d"></script>
+      <script src="../../_static/doctools.js?v=9bcbadda"></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" /> 
+</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">
+            FissionMunk
+          </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>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">fissionmunk</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">FissionMunk</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="../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">fissionmunk.Material</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for fissionmunk.Material</h1><div class="highlight"><pre>
+<span></span><span class="kn">import</span> <span class="nn">enum</span>
+
+<div class="viewcode-block" id="MaterialType">
+<a class="viewcode-back" href="../../fissionmunk.html#fissionmunk.Material.MaterialType">[docs]</a>
+<span class="k">class</span> <span class="nc">MaterialType</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The type of material that is being used in the simulation.</span>
+
+<span class="sd">    :param enum: The type of material that is being used in the simulation.</span>
+<span class="sd">    :type enum: enum.Enum</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">WATER</span> <span class="o">=</span> <span class="s2">&quot;water&quot;</span>
+    <span class="n">GRAPHITE</span> <span class="o">=</span> <span class="s2">&quot;graphite&quot;</span>
+    <span class="n">BORON</span> <span class="o">=</span> <span class="s2">&quot;boron&quot;</span>
+    <span class="n">XENON</span> <span class="o">=</span> <span class="s2">&quot;xenon&quot;</span>
+    <span class="n">FISSILE</span> <span class="o">=</span> <span class="s2">&quot;fissile&quot;</span>
+    <span class="n">NON_FISSILE</span> <span class="o">=</span> <span class="s2">&quot;non-fissile&quot;</span>
+    <span class="n">BORON_CARBIDE</span> <span class="o">=</span> <span class="s2">&quot;boron carbide&quot;</span></div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Aniket Mishra.</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/_modules/fissionmunk/Moderator.html b/_modules/fissionmunk/Moderator.html
@@ -0,0 +1,227 @@
+
+
+<!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.0" />
+  <title>fissionmunk.Moderator &mdash; FissionMunk 0.0.2 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=e59714d7" />
+
+
+      <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=e3a6060d"></script>
+      <script src="../../_static/doctools.js?v=9bcbadda"></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" /> 
+</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">
+            FissionMunk
+          </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>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">fissionmunk</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">FissionMunk</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="../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">fissionmunk.Moderator</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for fissionmunk.Moderator</h1><div class="highlight"><pre>
+<span></span><span class="c1"># Slows down neutron speed and bring it to Fission speed</span>
+<span class="kn">import</span> <span class="nn">pymunk</span>
+<span class="kn">from</span> <span class="nn">.Material</span> <span class="kn">import</span> <span class="n">MaterialType</span> <span class="k">as</span> <span class="n">Material</span>
+
+<div class="viewcode-block" id="Moderator">
+<a class="viewcode-back" href="../../index.html#fissionmunk.Moderator.Moderator">[docs]</a>
+<span class="k">class</span> <span class="nc">Moderator</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The Moderator class represents a moderator in the simulation.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">width</span><span class="p">,</span> <span class="n">position</span><span class="p">,</span> <span class="n">material</span> <span class="o">=</span> <span class="n">Material</span><span class="o">.</span><span class="n">WATER</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The constructor for the Moderator class.</span>
+
+<span class="sd">        :param length: The length of the moderator.</span>
+<span class="sd">        :type length: float</span>
+<span class="sd">        :param width: The width of the moderator.</span>
+<span class="sd">        :type width: float</span>
+<span class="sd">        :param position: The position of the moderator.</span>
+<span class="sd">        :type position: tuple</span>
+<span class="sd">        :param material: The material of the moderator, defaults to Material.WATER</span>
+<span class="sd">        :type material: MaterialType, optional</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">length</span> <span class="o">=</span> <span class="n">length</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">width</span> <span class="o">=</span> <span class="n">width</span>
+
+        <span class="c1"># check if the material is valid</span>
+        <span class="k">assert</span> <span class="n">material</span> <span class="ow">in</span> <span class="n">Material</span><span class="p">,</span> <span class="s2">&quot;Invalid material&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">material</span> <span class="o">=</span> <span class="n">material</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">shape</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_moderator</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">position</span> <span class="o">=</span> <span class="n">position</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">shape</span><span class="o">.</span><span class="n">collision_type</span> <span class="o">=</span> <span class="mi">2</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">shape</span><span class="o">.</span><span class="n">sensor</span> <span class="o">=</span> <span class="kc">True</span>
+
+<div class="viewcode-block" id="Moderator.create_moderator">
+<a class="viewcode-back" href="../../index.html#fissionmunk.Moderator.Moderator.create_moderator">[docs]</a>
+    <span class="k">def</span> <span class="nf">create_moderator</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The create_moderator method creates the moderator body and shape.</span>
+
+<span class="sd">        :return: The moderator body and shape.</span>
+<span class="sd">        :rtype: tuple</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">rect_body</span> <span class="o">=</span> <span class="n">pymunk</span><span class="o">.</span><span class="n">Body</span><span class="p">(</span><span class="n">body_type</span><span class="o">=</span><span class="n">pymunk</span><span class="o">.</span><span class="n">Body</span><span class="o">.</span><span class="n">STATIC</span><span class="p">)</span>
+        <span class="n">rect_shape</span> <span class="o">=</span> <span class="n">pymunk</span><span class="o">.</span><span class="n">Poly</span><span class="o">.</span><span class="n">create_box</span><span class="p">(</span><span class="n">rect_body</span><span class="p">,</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">length</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">width</span><span class="p">))</span>
+        <span class="k">return</span> <span class="n">rect_body</span><span class="p">,</span> <span class="n">rect_shape</span></div>
+
+
+    <span class="c1"># Getters and Setters</span>
+<div class="viewcode-block" id="Moderator.get_body">
+<a class="viewcode-back" href="../../index.html#fissionmunk.Moderator.Moderator.get_body">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_body</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The get_body method returns the body of the moderator.</span>
+
+<span class="sd">        :return: The body of the moderator.</span>
+<span class="sd">        :rtype: pymunk.Body</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span></div>
+
+
+<div class="viewcode-block" id="Moderator.get_shape">
+<a class="viewcode-back" href="../../index.html#fissionmunk.Moderator.Moderator.get_shape">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_shape</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The get_shape method returns the shape of the moderator.</span>
+
+<span class="sd">        :return: The shape of the moderator.</span>
+<span class="sd">        :rtype: pymunk.Shape</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">shape</span></div>
+
+
+<div class="viewcode-block" id="Moderator.get_length">
+<a class="viewcode-back" href="../../index.html#fissionmunk.Moderator.Moderator.get_length">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_length</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The get_length method returns the length of the moderator.</span>
+
+<span class="sd">        :return: The length of the moderator.</span>
+<span class="sd">        :rtype: float</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">length</span></div>
+
+
+<div class="viewcode-block" id="Moderator.get_width">
+<a class="viewcode-back" href="../../index.html#fissionmunk.Moderator.Moderator.get_width">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_width</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The get_width method returns the width of the moderator.</span>
+
+<span class="sd">        :return: The width of the moderator.</span>
+<span class="sd">        :rtype: float</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">width</span></div>
+
+
+<div class="viewcode-block" id="Moderator.get_position">
+<a class="viewcode-back" href="../../index.html#fissionmunk.Moderator.Moderator.get_position">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_position</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The get_position method returns the position of the moderator.</span>
+
+<span class="sd">        :return: The position of the moderator.</span>
+<span class="sd">        :rtype: tuple</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">position</span></div>
+
+<div class="viewcode-block" id="Moderator.set_position">
+<a class="viewcode-back" href="../../index.html#fissionmunk.Moderator.Moderator.set_position">[docs]</a>
+    <span class="k">def</span> <span class="nf">set_position</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">position</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The set_position method sets the position of the moderator.</span>
+
+<span class="sd">        :param position: The position of the moderator.</span>
+<span class="sd">        :type position: tuple</span>
+<span class="sd">        :return: None</span>
+<span class="sd">        :rtype: None</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">position</span> <span class="o">=</span> <span class="n">position</span>
+        <span class="k">return</span> <span class="kc">None</span></div>
+
+
+<div class="viewcode-block" id="Moderator.get_material">
+<a class="viewcode-back" href="../../index.html#fissionmunk.Moderator.Moderator.get_material">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_material</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The get_material method returns the material of the moderator.</span>
+
+<span class="sd">        :return: The material of the moderator.</span>
+<span class="sd">        :rtype: MaterialType</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">material</span></div>
+</div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Aniket Mishra.</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>