deploy: 692bf43

GEOUNED-org · May 16, 2024 · 8451f87 · 8451f87
commit 8451f87
Show file tree

Hide file tree

Showing 75 changed files with 9,919 additions and 0 deletions.
diff --git a/.buildinfo b/.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: ba8b2b53d022aac728b752e2882b487f
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/developer_guide.doctree b/.doctrees/developer_guide.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/install/index.doctree b/.doctrees/install/index.doctree
diff --git a/.doctrees/install/install_linux.doctree b/.doctrees/install/install_linux.doctree
diff --git a/.doctrees/install/install_windows.doctree b/.doctrees/install/install_windows.doctree
diff --git a/.doctrees/methodology.doctree b/.doctrees/methodology.doctree
diff --git a/.doctrees/python_api.doctree b/.doctrees/python_api.doctree
diff --git a/.doctrees/usage/index.doctree b/.doctrees/usage/index.doctree
diff --git a/.doctrees/usage/python_api_usage.doctree b/.doctrees/usage/python_api_usage.doctree
diff --git a/.doctrees/usage/python_cli_usage.doctree b/.doctrees/usage/python_cli_usage.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_modules/geouned/GEOUNED/core.html b/_modules/geouned/GEOUNED/core.html
diff --git a/_modules/geouned/GEOUNED/utils/data_classes.html b/_modules/geouned/GEOUNED/utils/data_classes.html
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,107 @@
+<!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>Overview: module code &mdash; GEOUNED 1.0.1 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=292eb321"></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" /> 
+</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">
+            GEOUNED
+          </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">
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="../install/index.html">Install</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Usage</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../python_api.html">Python API reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../methodology.html">Methodology</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developer_guide.html">Developer guide</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">GEOUNED</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">Overview: module code</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>All modules for which code is available</h1>
+<ul><li><a href="geouned/GEOUNED/core.html">geouned.GEOUNED.core</a></li>
+<li><a href="geouned/GEOUNED/utils/data_classes.html">geouned.GEOUNED.utils.data_classes</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, UNED.</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/_sources/developer_guide.rst.txt b/_sources/developer_guide.rst.txt
@@ -0,0 +1,4 @@
+Developer guide
+===============
+
+TOOD
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,20 @@
+.. GEOUNED documentation master file, created by
+   sphinx-quickstart on Tue Apr 30 09:47:11 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+GEOUNED
+=======
+
+GEOUNED converts CAD to Constructive Solid Geometry (CSG) formats for use in
+Monte Carlo transport codes.
+Supported codes include OpenMC, PHITS, Serpent and MCNP.
+
+.. toctree::
+   :maxdepth: 3
+
+   install/index
+   usage/index
+   python_api
+   methodology
+   developer_guide
diff --git a/_sources/install/index.rst.txt b/_sources/install/index.rst.txt
@@ -0,0 +1,21 @@
+.. usage
+
+Install
+=======
+
+There are several options for installing GEOUNED package.
+The installation selected has implications for how you run GEOUNED Python scripts.
+Currently the Mamba / Conda install is the recommended method.
+The main complication when installing GEOUNED is integration between the main dependency (FreeCAD) and the users system Python.
+Mamba / Conda provides a connection between the FreeCAD Python library and your system Python.
+Users have also had success installing FreeCAD and making use of the Python version inbuilt into FreeCAD and the freecad.cmd however the integration ofr FrreCAD with the system Python is more challenging when installing in this manner.
+.. TODO as well so these installation methods are listed for completeness.
+
+
+
+.. toctree::
+   :numbered:
+   :maxdepth: 1
+
+   install_linux
+   install_windows