deploy: ec9a61b

GEOUNED-org · Jun 13, 2024 · 25374c1 · 25374c1
1 parent dd75a54
commit 25374c1
Show file tree

Hide file tree

Showing 23 changed files with 44 additions and 34 deletions.
diff --git a/dev/.buildinfo b/dev/.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: 72c7f4f95cbb6337c365d0c4d763b746
+config: f322c2929e56484b36684c711b12ba3b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/dev/.doctrees/developer_guide.doctree b/dev/.doctrees/developer_guide.doctree
diff --git a/dev/.doctrees/environment.pickle b/dev/.doctrees/environment.pickle
diff --git a/dev/.doctrees/index.doctree b/dev/.doctrees/index.doctree
diff --git a/dev/_modules/geouned/GEOUNED/core.html b/dev/_modules/geouned/GEOUNED/core.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>geouned.GEOUNED.core &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>geouned.GEOUNED.core &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -34,7 +34,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="../../../_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="../../../_static/documentation_options.js?v=c9165867"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/geouned/GEOUNED/core';</script>

diff --git a/dev/_modules/geouned/GEOUNED/utils/data_classes.html b/dev/_modules/geouned/GEOUNED/utils/data_classes.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>geouned.GEOUNED.utils.data_classes &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>geouned.GEOUNED.utils.data_classes &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -34,7 +34,7 @@
 <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="../../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="../../../../_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="../../../../_static/documentation_options.js?v=c9165867"></script>
     <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/geouned/GEOUNED/utils/data_classes';</script>

diff --git a/dev/_modules/index.html b/dev/_modules/index.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>Overview: module code &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -34,7 +34,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="../_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="../_static/documentation_options.js?v=c9165867"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/index';</script>

diff --git a/dev/_sources/developer_guide.rst.txt b/dev/_sources/developer_guide.rst.txt
@@ -53,6 +53,12 @@ As our main dependency FreeCAD is not available on PYPi but we can install it fr
 
     mamba install -c conda-forge freecad -y
 
+To be able to run test cases and stochastic volume calculation, it is needed to install ``openmc`` and ``pytest`` from conda-forge.
+
+.. code-block:: sh
+
+    mamba install -c conda-forge pytest openmc
+
 Fork the GEOUNED-org/GEOUNED repository by clicking this link, unchecking the Copy the main branch only check box and clicking create fork
 
 `https://github.com/GEOUNED-org/GEOUNED/fork <https://github.com/GEOUNED-org/GEOUNED/fork>`_

diff --git a/dev/_static/documentation_options.js b/dev/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.dev1+g47d7463',
+    VERSION: '0.1.dev1+gec9a61b',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/dev/developer_guide.html b/dev/developer_guide.html
@@ -8,7 +8,7 @@
     <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>Developer guide &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>Developer guide &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -35,7 +35,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="_static/documentation_options.js?v=c9165867"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'developer_guide';</script>
@@ -463,6 +463,10 @@ <h2>Developer install with Mamba<a class="headerlink" href="#developer-install-w
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>freecad<span class="w"> </span>-y
 </pre></div>
 </div>
+<p>To be able to run test cases and stochastic volume calculation, it is needed to install <code class="docutils literal notranslate"><span class="pre">openmc</span></code> and <code class="docutils literal notranslate"><span class="pre">pytest</span></code> from conda-forge.</p>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>pytest<span class="w"> </span>openmc
+</pre></div>
+</div>
 <p>Fork the GEOUNED-org/GEOUNED repository by clicking this link, unchecking the Copy the main branch only check box and clicking create fork</p>
 <p><a class="github reference external" href="https://github.com/GEOUNED-org/GEOUNED/fork">GEOUNED-org/GEOUNED</a></p>
 <p>Assuming that you have <a class="reference external" href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent">setup</a> and <a class="reference external" href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account">added</a> SSH keys then we can clone your forked GEOUNED repository.

diff --git a/dev/genindex.html b/dev/genindex.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>Index &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -34,7 +34,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="_static/documentation_options.js?v=c9165867"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'genindex';</script>

diff --git a/dev/index.html b/dev/index.html
@@ -8,7 +8,7 @@
     <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>Geouned Documentation &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>Geouned Documentation &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -35,7 +35,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="_static/documentation_options.js?v=c9165867"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
@@ -397,7 +397,7 @@
 
   <section id="geouned-documentation">
 <h1>Geouned Documentation<a class="headerlink" href="#geouned-documentation" title="Link to this heading">#</a></h1>
-<p><strong>Version</strong>: 0.1.dev1+g47d7463</p>
+<p><strong>Version</strong>: 0.1.dev1+gec9a61b</p>
 <p>GEOUNED converts CAD to Constructive Solid Geometry (CSG) formats for use in
 Monte Carlo transport codes.
 Supported codes include OpenMC, PHITS, Serpent and MCNP.</p>

diff --git a/dev/install/index.html b/dev/install/index.html
@@ -8,7 +8,7 @@
     <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>Install &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>Install &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -35,7 +35,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="../_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="../_static/documentation_options.js?v=c9165867"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'install/index';</script>

diff --git a/dev/install/install_linux.html b/dev/install/install_linux.html
@@ -8,7 +8,7 @@
     <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>1. Linux &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>1. Linux &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -35,7 +35,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="../_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="../_static/documentation_options.js?v=c9165867"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'install/install_linux';</script>

diff --git a/dev/install/install_windows.html b/dev/install/install_windows.html
@@ -8,7 +8,7 @@
     <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>2. Windows &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>2. Windows &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -35,7 +35,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="../_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="../_static/documentation_options.js?v=c9165867"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'install/install_windows';</script>

diff --git a/dev/methodology.html b/dev/methodology.html
@@ -8,7 +8,7 @@
     <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>Methodology &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>Methodology &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -35,7 +35,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="_static/documentation_options.js?v=c9165867"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'methodology';</script>

diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/python_api.html b/dev/python_api.html
@@ -8,7 +8,7 @@
     <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>Python API reference &#8212; GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <title>Python API reference &#8212; GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -35,7 +35,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="_static/documentation_options.js?v=c9165867"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'python_api';</script>

diff --git a/dev/search.html b/dev/search.html
@@ -6,7 +6,7 @@
 
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - GEOUNED 0.1.dev1+g47d7463 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - GEOUNED 0.1.dev1+gec9a61b documentation</title>
 
 
 
@@ -33,7 +33,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="_static/documentation_options.js?v=9bc818b5"></script>
+    <script src="_static/documentation_options.js?v=c9165867"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'search';</script>