deploy: e242565

GEOUNED-org · Jun 18, 2024 · 657d4eb · 657d4eb
1 parent 26153af
commit 657d4eb
Show file tree

Hide file tree

Showing 26 changed files with 64 additions and 61 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: 9e88068194cab21ac08d9626ae99d1eb
+config: c34c7b21d7652bf4b64e9eb542072277
 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/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+gf7f4279 documentation</title>
+    <title>geouned.GEOReverse.core &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="../../../_static/documentation_options.js?v=68151e1d"></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+gf7f4279 documentation</title>
+    <title>geouned.GEOUNED.core &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="../../../_static/documentation_options.js?v=68151e1d"></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+gf7f4279 documentation</title>
+    <title>geouned.GEOUNED.utils.data_classes &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="../../../../_static/documentation_options.js?v=68151e1d"></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+gf7f4279 documentation</title>
+    <title>Overview: module code &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="../_static/documentation_options.js?v=68151e1d"></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
@@ -168,7 +168,14 @@ Tests checking the code will run automatically on the pull request.
 
 If the tests pass and at least one approver approves then the pull request can be merged.
 
-When a pull request is ready to be merged then the pull request should be **squashed** and merged into the dev branch.
+When updating the dev branch from a feature branch then a pull request is should be merged in with the **squashed and merged*** option.
+
+When updating the main branch from the dev branch then the pull request should be merged in with the **create a merge commit** option.
+
+Version numbering
+~~~~~~~~~~~~~~~~~
+
+GEOUNED will use Semantic Versioning to number releases of the tool, in the form "Major.Minor.Patch", e.g., “3.15.9”.
 
 Releasing a new version
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -214,7 +221,7 @@ For example adding version 1.2.3 would look like this
 
 Then create a `pull request from dev branch to main branch <https://github.com/GEOUNED-org/GEOUNED/compare/main...dev>`_
 
-Once the tests for this pass then merge the pull request in. **Do not squash** this pull request as we want to keep the history of the version changes.
+Once the tests for this pass then merge the pull request in. Use the **create a merge commit** option when merging this pull request from dev to main.
 
 Then `create a new release on the main branch <https://github.com/shimwell/GEOUNED/releases/new>`_ with the version number and a description of the changes.
 
@@ -235,17 +242,12 @@ Conda Forge Releasing
 
 The conda-forge package release is done after the PyPI release. This is because the conda-forge package is built from the PyPI package.
 
-Conda Forge has a bot thew generates a pull request to update the conda-forge recipe. This is done automatically when the PyPI package is released.
+Conda Forge has a bot that generates a pull request to update the conda-forge recipe. This is done automatically when the PyPI package is released.
 
-The pull request will be generated in the `conda-forge/GEOUNED-feedstock <https://github.com/conda-forge/geouned-feedstock/pulls>`_ repository.
+The pull request will be generated in the `conda-forge/GEOUNED-feedstock <https://github.com/conda-forge/geouned-feedstock/pulls>`_ repository a short while after the PyPI release.
 
 Check the pull request and if the tests pass then merge the pull request.
 
 A Conda Forge package will be built and released to the conda-forge channel.
 
-Once released the package will be visaible on the `conda-forge channel <https://anaconda.org/conda-forge/geouned>`_. 
-
-Version Numbering
-~~~~~~~~~~~~~~~~~
-
-GEOUNED will use Semantic Versioning to number releases of the tool, in the form "Major.Minor.Patch", e.g., “3.15.9”.
+Once released the package will be visible on the `conda-forge channel <https://anaconda.org/conda-forge/geouned>`_. 
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+gf7f4279',
+    VERSION: '0.1.dev1+ge242565',
     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+gf7f4279 documentation</title>
+    <title>Developer guide &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="_static/documentation_options.js?v=68151e1d"></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>
@@ -541,7 +541,12 @@ <h2>Merging a pull requests<a class="headerlink" href="#merging-a-pull-requests"
 <p>Pull requests should be made from feature branches on a fork of the repository to the dev branch.</p>
 <p>Tests checking the code will run automatically on the pull request.</p>
 <p>If the tests pass and at least one approver approves then the pull request can be merged.</p>
-<p>When a pull request is ready to be merged then the pull request should be <strong>squashed</strong> and merged into the dev branch.</p>
+<p>When updating the dev branch from a feature branch then a pull request is should be merged in with the <strong>squashed and merged*</strong> option.</p>
+<p>When updating the main branch from the dev branch then the pull request should be merged in with the <strong>create a merge commit</strong> option.</p>
+</section>
+<section id="version-numbering">
+<h2>Version numbering<a class="headerlink" href="#version-numbering" title="Link to this heading">#</a></h2>
+<p>GEOUNED will use Semantic Versioning to number releases of the tool, in the form “Major.Minor.Patch”, e.g., “3.15.9”.</p>
 </section>
 <section id="releasing-a-new-version">
 <h2>Releasing a new version<a class="headerlink" href="#releasing-a-new-version" title="Link to this heading">#</a></h2>
@@ -581,7 +586,7 @@ <h2>Releasing a new version<a class="headerlink" href="#releasing-a-new-version"
 </pre></div>
 </div>
 <p>Then create a <a class="reference external" href="https://github.com/GEOUNED-org/GEOUNED/compare/main...dev">pull request from dev branch to main branch</a></p>
-<p>Once the tests for this pass then merge the pull request in. <strong>Do not squash</strong> this pull request as we want to keep the history of the version changes.</p>
+<p>Once the tests for this pass then merge the pull request in. Use the <strong>create a merge commit</strong> option when merging this pull request from dev to main.</p>
 <p>Then <a class="reference external" href="https://github.com/shimwell/GEOUNED/releases/new">create a new release on the main branch</a> with the version number and a description of the changes.</p>
 <p>Create a new tag with the version number (e.g. 1.2.3) and the release name (e.g. v1.2.3) and the release description.</p>
 <p>Press the Generate release notes button to get the release notes from the pull request descriptions.</p>
@@ -594,15 +599,11 @@ <h2>Releasing a new version<a class="headerlink" href="#releasing-a-new-version"
 <section id="conda-forge-releasing">
 <h2>Conda Forge Releasing<a class="headerlink" href="#conda-forge-releasing" title="Link to this heading">#</a></h2>
 <p>The conda-forge package release is done after the PyPI release. This is because the conda-forge package is built from the PyPI package.</p>
-<p>Conda Forge has a bot thew generates a pull request to update the conda-forge recipe. This is done automatically when the PyPI package is released.</p>
-<p>The pull request will be generated in the <a class="reference external" href="https://github.com/conda-forge/geouned-feedstock/pulls">conda-forge/GEOUNED-feedstock</a> repository.</p>
+<p>Conda Forge has a bot that generates a pull request to update the conda-forge recipe. This is done automatically when the PyPI package is released.</p>
+<p>The pull request will be generated in the <a class="reference external" href="https://github.com/conda-forge/geouned-feedstock/pulls">conda-forge/GEOUNED-feedstock</a> repository a short while after the PyPI release.</p>
 <p>Check the pull request and if the tests pass then merge the pull request.</p>
 <p>A Conda Forge package will be built and released to the conda-forge channel.</p>
-<p>Once released the package will be visaible on the <a class="reference external" href="https://anaconda.org/conda-forge/geouned">conda-forge channel</a>.</p>
-</section>
-<section id="version-numbering">
-<h2>Version Numbering<a class="headerlink" href="#version-numbering" title="Link to this heading">#</a></h2>
-<p>GEOUNED will use Semantic Versioning to number releases of the tool, in the form “Major.Minor.Patch”, e.g., “3.15.9”.</p>
+<p>Once released the package will be visible on the <a class="reference external" href="https://anaconda.org/conda-forge/geouned">conda-forge channel</a>.</p>
 </section>
 </section>
 
@@ -647,9 +648,9 @@ <h2>Version Numbering<a class="headerlink" href="#version-numbering" title="Link
 <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>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-numbering">Version numbering</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#releasing-a-new-version">Releasing a new version</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#conda-forge-releasing">Conda Forge Releasing</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-numbering">Version Numbering</a></li>
 </ul>
   </nav></div>
 

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+gf7f4279 documentation</title>
+    <title>Index &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="_static/documentation_options.js?v=68151e1d"></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+gf7f4279 documentation</title>
+    <title>Geouned Documentation &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="_static/documentation_options.js?v=68151e1d"></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+gf7f4279</p>
+<p><strong>Version</strong>: 0.1.dev1+ge242565</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>
@@ -446,9 +446,9 @@ <h1>Geouned Documentation<a class="headerlink" href="#geouned-documentation" tit
 <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>
+<li class="toctree-l2"><a class="reference internal" href="developer_guide.html#version-numbering">Version numbering</a></li>
 <li class="toctree-l2"><a class="reference internal" href="developer_guide.html#releasing-a-new-version">Releasing a new version</a></li>
 <li class="toctree-l2"><a class="reference internal" href="developer_guide.html#conda-forge-releasing">Conda Forge Releasing</a></li>
-<li class="toctree-l2"><a class="reference internal" href="developer_guide.html#version-numbering">Version Numbering</a></li>
 </ul>
 </li>
 </ul>

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+gf7f4279 documentation</title>
+    <title>Install &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="../_static/documentation_options.js?v=68151e1d"></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+gf7f4279 documentation</title>
+    <title>1. Linux &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="../_static/documentation_options.js?v=68151e1d"></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+gf7f4279 documentation</title>
+    <title>2. Windows &#8212; GEOUNED 0.1.dev1+ge242565 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=9381afc2"></script>
+    <script src="../_static/documentation_options.js?v=68151e1d"></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>