Added logo and updated version in docs - edit

palaeoware · Feb 18, 2021 · 92c681e · 92c681e
1 parent 2e6c551
commit 92c681e
Show file tree

Hide file tree

Showing 195 changed files with 28,328 additions and 7 deletions.
diff --git a/SPIERSalign/docs/conf.py b/SPIERSalign/docs/conf.py
@@ -22,8 +22,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'SPIERSalign'
-copyright = '2018-2021, Russell Garwood, Mark Sutton, Alan R.T. Spencer'
-author = 'Russell Garwood, Mark Sutton, Alan R.T. Spencer'
+copyright = '2018-2021, Russell J. Garwood, Mark Sutton, Alan R.T. Spencer'
+author = 'Russell J. Garwood, Mark Sutton, Alan R.T. Spencer'
 
 # The short X.Y version
 version = '3.1.1'

diff --git a/SPIERSedit/docs/.vscode/tasks.json b/SPIERSedit/docs/.vscode/tasks.json
@@ -0,0 +1,17 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build docs",
+            "type": "shell",
+            "command": "sphinx-build ./ ../docs_build",
+            "problemMatcher": [],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
+}
diff --git a/SPIERSedit/docs/_static/SPIERS.jpg b/SPIERSedit/docs/_static/SPIERS.jpg
diff --git a/SPIERSedit/docs/build_docs.sh b/SPIERSedit/docs/build_docs.sh
@@ -0,0 +1,8 @@
+#This command will build the documentation on a system that has python3, sphinx, and the correct theme installed. 
+#On Linux that erquires these commands (assuming Python3 is already installed):
+#sudo apt-get install python3-sphinx
+#sudo apt install python3-pip
+#sudo pip3 install sphinx_rtd_theme
+echo "Now building trevosim doc"
+sphinx-build ./ ../docs_build
+
diff --git a/SPIERSedit/docs/conf.py b/SPIERSedit/docs/conf.py
@@ -22,13 +22,13 @@
 # -- Project information -----------------------------------------------------
 
 project = 'SPIERSedit'
-copyright = '2018-2019,  Mark Sutton, Russell Garwood, Alan R.T. Spencer'
-author = 'Mark Sutton, Russell Garwood, Alan R.T. Spencer'
+copyright = '2018-2021,  Mark Sutton, Russell J. Garwood, Alan R.T. Spencer'
+author = 'Mark Sutton, Russell J. Garwood, Alan R.T. Spencer'
 
 # The short X.Y version
-version = '3.0.0'
+version = '3.1.1'
 # The full version, including alpha/beta/rc tags
-release = '3.0.0'
+release = '3.1.1'
 
 
 # -- General configuration ---------------------------------------------------
@@ -125,7 +125,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = '_static/SPIERS.jpg'
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

diff --git a/SPIERSedit/docs_build/.buildinfo b/SPIERSedit/docs_build/.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: 2b4e32382e178a3848a6f5ee97116b75
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/SPIERSedit/docs_build/.doctrees/3dbrush.doctree b/SPIERSedit/docs_build/.doctrees/3dbrush.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/advancedprefs.doctree b/SPIERSedit/docs_build/.doctrees/advancedprefs.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/basicconcepts.doctree b/SPIERSedit/docs_build/.doctrees/basicconcepts.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/curves.doctree b/SPIERSedit/docs_build/.doctrees/curves.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/datadownsampling.doctree b/SPIERSedit/docs_build/.doctrees/datadownsampling.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/environment.pickle b/SPIERSedit/docs_build/.doctrees/environment.pickle
diff --git a/SPIERSedit/docs_build/.doctrees/exportingworkingimages.doctree b/SPIERSedit/docs_build/.doctrees/exportingworkingimages.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/histogram.doctree b/SPIERSedit/docs_build/.doctrees/histogram.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/index.doctree b/SPIERSedit/docs_build/.doctrees/index.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/info.doctree b/SPIERSedit/docs_build/.doctrees/info.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/introduction.doctree b/SPIERSedit/docs_build/.doctrees/introduction.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/lockselectionmode.doctree b/SPIERSedit/docs_build/.doctrees/lockselectionmode.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/masks.doctree b/SPIERSedit/docs_build/.doctrees/masks.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/output.doctree b/SPIERSedit/docs_build/.doctrees/output.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/polynomialgeneration.doctree b/SPIERSedit/docs_build/.doctrees/polynomialgeneration.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/rangegeneration.doctree b/SPIERSedit/docs_build/.doctrees/rangegeneration.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/requirements.doctree b/SPIERSedit/docs_build/.doctrees/requirements.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/segments.doctree b/SPIERSedit/docs_build/.doctrees/segments.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/slicespacing.doctree b/SPIERSedit/docs_build/.doctrees/slicespacing.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/updatesystem.doctree b/SPIERSedit/docs_build/.doctrees/updatesystem.doctree
diff --git a/SPIERSedit/docs_build/.doctrees/volumes.doctree b/SPIERSedit/docs_build/.doctrees/volumes.doctree
diff --git a/SPIERSedit/docs_build/3dbrush.html b/SPIERSedit/docs_build/3dbrush.html
@@ -0,0 +1,249 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html4" lang="en" >
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>11. 3D Brush &mdash; SPIERSedit 3.1.1 documentation</title>
+
+
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
+
+
+
+
+
+
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+        <script type="text/javascript" src="_static/jquery.js"></script>
+        <script type="text/javascript" src="_static/underscore.js"></script>
+        <script type="text/javascript" src="_static/doctools.js"></script>
+        <script type="text/javascript" src="_static/language_data.js"></script>
+
+    <script type="text/javascript" src="_static/js/theme.js"></script>
+
+
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="12. Curves" href="curves.html" />
+    <link rel="prev" title="10. Exporting Working Images" href="exportingworkingimages.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" alt="Documentation Home"> SPIERSedit
+
+
+
+
+            <img src="_static/SPIERS.jpg" class="logo" alt="Logo"/>
+
+          </a>
+
+
+
+
+              <div class="version">
+                3.1.1
+              </div>
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="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="main navigation">
+
+
+
+
+
+
+              <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="introduction.html">1. Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="requirements.html">2. Requirements</a></li>
+<li class="toctree-l1"><a class="reference internal" href="basicconcepts.html">3. Basic Concepts</a></li>
+<li class="toctree-l1"><a class="reference internal" href="masks.html">4. Masks</a></li>
+<li class="toctree-l1"><a class="reference internal" href="segments.html">5. Segments</a></li>
+<li class="toctree-l1"><a class="reference internal" href="rangegeneration.html">6. Range Generation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="polynomialgeneration.html">7. Polynomial Generation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="output.html">8. Output</a></li>
+<li class="toctree-l1"><a class="reference internal" href="volumes.html">9. Measuring volumes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="exportingworkingimages.html">10. Exporting Working Images</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">11. 3D Brush</a></li>
+<li class="toctree-l1"><a class="reference internal" href="curves.html">12. Curves</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lockselectionmode.html">13. Lock/Selection Mode</a></li>
+<li class="toctree-l1"><a class="reference internal" href="slicespacing.html">14. Slice Spacing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="histogram.html">15. Histogram</a></li>
+<li class="toctree-l1"><a class="reference internal" href="info.html">16. Info</a></li>
+<li class="toctree-l1"><a class="reference internal" href="datadownsampling.html">17. Dataset Downsampling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="advancedprefs.html">18. Advanced Prefs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="updatesystem.html">19. Update System</a></li>
+</ul>
+
+
+
+        </div>
+
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">SPIERSedit</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
+
+      <li>11. 3D Brush</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+
+            <a href="_sources/3dbrush.rst.txt" rel="nofollow"> View page source</a>
+
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <div class="section" id="d-brush">
+<span id="dbrush"></span><h1>11. 3D Brush<a class="headerlink" href="#d-brush" title="Permalink to this headline">¶</a></h1>
+<p>The SPIERSedit brush normally affects only single slices of the dataset.
+It can however be used in 3D mode, where it should be thought of as a 3D
+sphere extending for a number of slices equal to the Brush Size setting
+on the toolbar. There is no cubic 3D brush implementation. 3D brush mode
+is toggled on using the <em>3D Brush</em> button on the toolbar, or the <em>3D
+Brush</em> command on the <em>Brush</em> menu.</p>
+<p>The 3D brush works in the same way as the normal brush, and can be used
+in any mode. The only difference is that it affects multiple slices, and
+that the Undo system will not work on 3D brush operations.</p>
+<p>The 3D brush provides another quick means of rapidly masking large areas
+over many slices, deleting objects in 3D, and has many other
+applications.</p>
+</div>
+
+
+           </div>
+
+          </div>
+          <footer>
+
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+        <a href="curves.html" class="btn btn-neutral float-right" title="12. Curves" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+        <a href="exportingworkingimages.html" class="btn btn-neutral float-left" title="10. Exporting Working Images" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+    </div>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+
+        &copy; Copyright 2018-2021,  Mark Sutton, Russell J. Garwood, Alan R.T. Spencer
+
+    </p>
+  </div>
+
+
+
+    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
+
+    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
+
+    provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>
diff --git a/SPIERSedit/docs_build/_images/figure_1.png b/SPIERSedit/docs_build/_images/figure_1.png
diff --git a/SPIERSedit/docs_build/_images/figure_10.png b/SPIERSedit/docs_build/_images/figure_10.png
diff --git a/SPIERSedit/docs_build/_images/figure_11.png b/SPIERSedit/docs_build/_images/figure_11.png
diff --git a/SPIERSedit/docs_build/_images/figure_12.png b/SPIERSedit/docs_build/_images/figure_12.png
diff --git a/SPIERSedit/docs_build/_images/figure_13.png b/SPIERSedit/docs_build/_images/figure_13.png
diff --git a/SPIERSedit/docs_build/_images/figure_14.png b/SPIERSedit/docs_build/_images/figure_14.png
diff --git a/SPIERSedit/docs_build/_images/figure_15.png b/SPIERSedit/docs_build/_images/figure_15.png
diff --git a/SPIERSedit/docs_build/_images/figure_16.png b/SPIERSedit/docs_build/_images/figure_16.png
diff --git a/SPIERSedit/docs_build/_images/figure_17.png b/SPIERSedit/docs_build/_images/figure_17.png
diff --git a/SPIERSedit/docs_build/_images/figure_18.png b/SPIERSedit/docs_build/_images/figure_18.png
diff --git a/SPIERSedit/docs_build/_images/figure_19.png b/SPIERSedit/docs_build/_images/figure_19.png
diff --git a/SPIERSedit/docs_build/_images/figure_2.png b/SPIERSedit/docs_build/_images/figure_2.png
diff --git a/SPIERSedit/docs_build/_images/figure_20.png b/SPIERSedit/docs_build/_images/figure_20.png
diff --git a/SPIERSedit/docs_build/_images/figure_3.png b/SPIERSedit/docs_build/_images/figure_3.png
diff --git a/SPIERSedit/docs_build/_images/figure_4.png b/SPIERSedit/docs_build/_images/figure_4.png
diff --git a/SPIERSedit/docs_build/_images/figure_5.png b/SPIERSedit/docs_build/_images/figure_5.png
diff --git a/SPIERSedit/docs_build/_images/figure_6.png b/SPIERSedit/docs_build/_images/figure_6.png
diff --git a/SPIERSedit/docs_build/_images/figure_7.png b/SPIERSedit/docs_build/_images/figure_7.png
diff --git a/SPIERSedit/docs_build/_images/figure_8.png b/SPIERSedit/docs_build/_images/figure_8.png
diff --git a/SPIERSedit/docs_build/_images/figure_9.png b/SPIERSedit/docs_build/_images/figure_9.png
diff --git a/SPIERSedit/docs_build/_images/palaeoware_logo_square.png b/SPIERSedit/docs_build/_images/palaeoware_logo_square.png
diff --git a/SPIERSedit/docs_build/_sources/3dbrush.rst.txt b/SPIERSedit/docs_build/_sources/3dbrush.rst.txt
@@ -0,0 +1,19 @@
+.. _3dbrush:
+
+3D Brush
+========
+
+The SPIERSedit brush normally affects only single slices of the dataset.
+It can however be used in 3D mode, where it should be thought of as a 3D
+sphere extending for a number of slices equal to the Brush Size setting
+on the toolbar. There is no cubic 3D brush implementation. 3D brush mode
+is toggled on using the *3D Brush* button on the toolbar, or the *3D
+Brush* command on the *Brush* menu.
+
+The 3D brush works in the same way as the normal brush, and can be used
+in any mode. The only difference is that it affects multiple slices, and
+that the Undo system will not work on 3D brush operations.
+
+The 3D brush provides another quick means of rapidly masking large areas
+over many slices, deleting objects in 3D, and has many other
+applications.