deploy: c433561

GEOUNED-org · Jun 19, 2024 · 8f31b8e · 8f31b8e
1 parent aa7a76d
commit 8f31b8e
Show file tree

Hide file tree

Showing 28 changed files with 66 additions and 59 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: abaf6f3af9176bc8d2e9919fc2ae6000
+config: 029ba0aa3cce10a554a03a6cc71afe92
 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/.doctrees/install/index.doctree b/dev/.doctrees/install/index.doctree
diff --git a/dev/_modules/geouned/GEOReverse/core.html b/dev/_modules/geouned/GEOReverse/core.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>geouned.GEOReverse.core &#8212; GEOUNED 0.1.dev1+g629ec26 documentation</title>
+    <title>geouned.GEOReverse.core &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="../../../_static/documentation_options.js?v=8d926bcb"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/geouned/GEOReverse/core';</script>

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+g629ec26 documentation</title>
+    <title>geouned.GEOUNED.core &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="../../../_static/documentation_options.js?v=8d926bcb"></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+g629ec26 documentation</title>
+    <title>geouned.GEOUNED.utils.data_classes &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="../../../../_static/documentation_options.js?v=8d926bcb"></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+g629ec26 documentation</title>
+    <title>Overview: module code &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="../_static/documentation_options.js?v=8d926bcb"></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
@@ -105,6 +105,19 @@ Checkout feature branches from dev and make local changes on you own branch
 
 Pull requests are welcome
 
+Keeping your fork tags up to date
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Note that your fork of the repository should have releases tags which conform to PEP440 i.e. semantic versioning.
+When installing, setuptools uses these tags to get the version of GEOUNED.
+Release versions in the central repository conform to this standard.
+You can keep the tags in your fork up to date with the main repository using:
+
+.. code-block:: sh
+
+   git fetch --tags https://github.com/GEOUNED-org/GEOUNED
+
+
 Building the docs locally
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/dev/_sources/install/index.rst.txt b/dev/_sources/install/index.rst.txt
@@ -9,17 +9,7 @@ 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 of FrreCAD with the system Python is more challenging when installing in this manner.
-.. TODO as well so these installation methods are listed for completeness.
 
-Note that your fork of the repostory must have releases which conform to PEP440 i.e. semantic versioning. When installing, setuptools
-uses these tags to get the release number of GEOUNED. Release versions in the central repository now conform to this standard and can be reflected in your
-fork using:
-
-.. code-block:: sh
-
-   git fetch --tags upstream
-
-where upstream is the remote url of the original repository.
 
 .. toctree::
    :numbered:

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+g629ec26',
+    VERSION: '0.1.dev1+gc433561',
     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+g629ec26 documentation</title>
+    <title>Developer guide &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="_static/documentation_options.js?v=8d926bcb"></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>
@@ -499,6 +499,16 @@ <h2>Developer install with Mamba<a class="headerlink" href="#developer-install-w
 </div>
 <p>Pull requests are welcome</p>
 </section>
+<section id="keeping-your-fork-tags-up-to-date">
+<h2>Keeping your fork tags up to date<a class="headerlink" href="#keeping-your-fork-tags-up-to-date" title="Link to this heading">#</a></h2>
+<p>Note that your fork of the repository should have releases tags which conform to PEP440 i.e. semantic versioning.
+When installing, setuptools uses these tags to get the version of GEOUNED.
+Release versions in the central repository conform to this standard.
+You can keep the tags in your fork up to date with the main repository using:</p>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>fetch<span class="w"> </span>--tags<span class="w"> </span>https://github.com/GEOUNED-org/GEOUNED
+</pre></div>
+</div>
+</section>
 <section id="building-the-docs-locally">
 <h2>Building the docs locally<a class="headerlink" href="#building-the-docs-locally" title="Link to this heading">#</a></h2>
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.<span class="o">[</span>docs<span class="o">]</span>
@@ -645,6 +655,7 @@ <h2>Conda Forge Releasing<a class="headerlink" href="#conda-forge-releasing" tit
   <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#developer-install-with-mamba">Developer install with Mamba</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#keeping-your-fork-tags-up-to-date">Keeping your fork tags up to date</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#building-the-docs-locally">Building the docs locally</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#running-the-tests-locally">Running the tests locally</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#merging-a-pull-requests">Merging a pull requests</a></li>

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+g629ec26 documentation</title>
+    <title>Index &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="_static/documentation_options.js?v=8d926bcb"></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+g629ec26 documentation</title>
+    <title>Geouned Documentation &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="_static/documentation_options.js?v=8d926bcb"></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+g629ec26</p>
+<p><strong>Version</strong>: 0.1.dev1+gc433561</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>
@@ -443,6 +443,7 @@ <h1>Geouned Documentation<a class="headerlink" href="#geouned-documentation" tit
 <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><ul>
 <li class="toctree-l2"><a class="reference internal" href="developer_guide.html#developer-install-with-mamba">Developer install with Mamba</a></li>
+<li class="toctree-l2"><a class="reference internal" href="developer_guide.html#keeping-your-fork-tags-up-to-date">Keeping your fork tags up to date</a></li>
 <li class="toctree-l2"><a class="reference internal" href="developer_guide.html#building-the-docs-locally">Building the docs locally</a></li>
 <li class="toctree-l2"><a class="reference internal" href="developer_guide.html#running-the-tests-locally">Running the tests locally</a></li>
 <li class="toctree-l2"><a class="reference internal" href="developer_guide.html#merging-a-pull-requests">Merging a pull requests</a></li>

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+g629ec26 documentation</title>
+    <title>Install &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="../_static/documentation_options.js?v=8d926bcb"></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>
@@ -440,15 +440,7 @@ <h1>Install<a class="headerlink" href="#install" title="Link to this heading">#<
 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 of FrreCAD with the system Python is more challenging when installing in this manner.
-.. TODO as well so these installation methods are listed for completeness.</p>
-<p>Note that your fork of the repostory must have releases which conform to PEP440 i.e. semantic versioning. When installing, setuptools
-uses these tags to get the release number of GEOUNED. Release versions in the central repository now conform to this standard and can be reflected in your
-fork using:</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>fetch<span class="w"> </span>--tags<span class="w"> </span>upstream
-</pre></div>
-</div>
-<p>where upstream is the remote url of the original repository.</p>
+Users have also had success installing FreeCAD and making use of the Python version inbuilt into FreeCAD and the freecad.cmd however the integration of FrreCAD with the system Python is more challenging when installing in this manner.</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="install_linux.html">1. Linux</a></li>

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+g629ec26 documentation</title>
+    <title>1. Linux &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="../_static/documentation_options.js?v=8d926bcb"></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+g629ec26 documentation</title>
+    <title>2. Windows &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="../_static/documentation_options.js?v=8d926bcb"></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+g629ec26 documentation</title>
+    <title>Methodology &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="_static/documentation_options.js?v=8d926bcb"></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+g629ec26 documentation</title>
+    <title>Python API reference &#8212; GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="_static/documentation_options.js?v=8d926bcb"></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+g629ec26 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - GEOUNED 0.1.dev1+gc433561 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=7df58888"></script>
+    <script src="_static/documentation_options.js?v=8d926bcb"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'search';</script>

diff --git a/dev/searchindex.js b/dev/searchindex.js