Re #1 Added v4 documentation as stable

pace-neutrons · Aug 15, 2024 · 78b46c7 · 78b46c7
1 parent 5a9989e
commit 78b46c7
Show file tree

Hide file tree

Showing 689 changed files with 84,365 additions and 1 deletion.
diff --git a/documentation/user_docs/build/doctrees/API_Reference.doctree b/documentation/user_docs/build/doctrees/API_Reference.doctree
diff --git a/documentation/user_docs/build/doctrees/Citing.doctree b/documentation/user_docs/build/doctrees/Citing.doctree
diff --git a/documentation/user_docs/build/doctrees/Contributing.doctree b/documentation/user_docs/build/doctrees/Contributing.doctree
diff --git a/documentation/user_docs/build/doctrees/Developers.doctree b/documentation/user_docs/build/doctrees/Developers.doctree
diff --git a/documentation/user_docs/build/doctrees/Example_scripts.doctree b/documentation/user_docs/build/doctrees/Example_scripts.doctree
diff --git a/documentation/user_docs/build/doctrees/General_disclaimer.doctree b/documentation/user_docs/build/doctrees/General_disclaimer.doctree
diff --git a/documentation/user_docs/build/doctrees/Horace_manual.doctree b/documentation/user_docs/build/doctrees/Horace_manual.doctree
diff --git a/documentation/user_docs/build/doctrees/How_to_cite_Horace.doctree b/documentation/user_docs/build/doctrees/How_to_cite_Horace.doctree
diff --git a/documentation/user_docs/build/doctrees/Introduction.doctree b/documentation/user_docs/build/doctrees/Introduction.doctree
diff --git a/documentation/user_docs/build/doctrees/Papers_citing_Horace.doctree b/documentation/user_docs/build/doctrees/Papers_citing_Horace.doctree
diff --git a/documentation/user_docs/build/doctrees/Previous_versions.doctree b/documentation/user_docs/build/doctrees/Previous_versions.doctree
diff --git a/documentation/user_docs/build/doctrees/Unsorted.doctree b/documentation/user_docs/build/doctrees/Unsorted.doctree
diff --git a/documentation/user_docs/build/doctrees/User_guide.doctree b/documentation/user_docs/build/doctrees/User_guide.doctree
diff --git a/documentation/user_docs/build/doctrees/developers/Become_a_developer.doctree b/documentation/user_docs/build/doctrees/developers/Become_a_developer.doctree
diff --git a/documentation/user_docs/build/doctrees/developers/Developer_info.doctree b/documentation/user_docs/build/doctrees/developers/Developer_info.doctree
diff --git a/documentation/user_docs/build/doctrees/developers/For_Developers.doctree b/documentation/user_docs/build/doctrees/developers/For_Developers.doctree
diff --git a/documentation/user_docs/build/doctrees/developers/Known_bugs.doctree b/documentation/user_docs/build/doctrees/developers/Known_bugs.doctree
diff --git a/documentation/user_docs/build/doctrees/environment.pickle b/documentation/user_docs/build/doctrees/environment.pickle
diff --git a/documentation/user_docs/build/doctrees/example_scripts/advanced_plotting.doctree b/documentation/user_docs/build/doctrees/example_scripts/advanced_plotting.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/align_and_symmetrise.doctree b/documentation/user_docs/build/doctrees/example_scripts/align_and_symmetrise.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/basic_usage.doctree b/documentation/user_docs/build/doctrees/example_scripts/basic_usage.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/corrections.doctree b/documentation/user_docs/build/doctrees/example_scripts/corrections.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/data_corrections.doctree b/documentation/user_docs/build/doctrees/example_scripts/data_corrections.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/dnd_vs_sqw.doctree b/documentation/user_docs/build/doctrees/example_scripts/dnd_vs_sqw.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/gpo_fitting_spinw.doctree b/documentation/user_docs/build/doctrees/example_scripts/gpo_fitting_spinw.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/horace_diagnostics.doctree b/documentation/user_docs/build/doctrees/example_scripts/horace_diagnostics.doctree
diff --git a/...entation/user_docs/build/doctrees/example_scripts/horace_whole_course_full_script.doctree b/...entation/user_docs/build/doctrees/example_scripts/horace_whole_course_full_script.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/sample_misalignment.doctree b/documentation/user_docs/build/doctrees/example_scripts/sample_misalignment.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/simulation_fitting.doctree b/documentation/user_docs/build/doctrees/example_scripts/simulation_fitting.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/spinw_gpo_1dfit.doctree b/documentation/user_docs/build/doctrees/example_scripts/spinw_gpo_1dfit.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/spurions.doctree b/documentation/user_docs/build/doctrees/example_scripts/spurions.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/sqwgeneration_tips.doctree b/documentation/user_docs/build/doctrees/example_scripts/sqwgeneration_tips.doctree
diff --git a/documentation/user_docs/build/doctrees/example_scripts/symmetrisation.doctree b/documentation/user_docs/build/doctrees/example_scripts/symmetrisation.doctree
diff --git a/documentation/user_docs/build/doctrees/index.doctree b/documentation/user_docs/build/doctrees/index.doctree
diff --git a/documentation/user_docs/build/doctrees/introduction/Download_and_setup.doctree b/documentation/user_docs/build/doctrees/introduction/Download_and_setup.doctree
diff --git a/documentation/user_docs/build/doctrees/introduction/Support_and_updates.doctree b/documentation/user_docs/build/doctrees/introduction/Support_and_updates.doctree
diff --git a/documentation/user_docs/build/doctrees/introduction/The_Horace_Rationale.doctree b/documentation/user_docs/build/doctrees/introduction/The_Horace_Rationale.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Advanced_Multifit.doctree b/documentation/user_docs/build/doctrees/manual/Advanced_Multifit.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Binary_operations.doctree b/documentation/user_docs/build/doctrees/manual/Binary_operations.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Changing_Horace_settings.doctree b/documentation/user_docs/build/doctrees/manual/Changing_Horace_settings.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Changing_object_type.doctree b/documentation/user_docs/build/doctrees/manual/Changing_object_type.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Correcting_for_sample_misalignment.doctree b/documentation/user_docs/build/doctrees/manual/Correcting_for_sample_misalignment.doctree
diff --git a/...er_docs/build/doctrees/manual/Cutting_data_of_interest_from_SQW_files_and_objects.doctree b/...er_docs/build/doctrees/manual/Cutting_data_of_interest_from_SQW_files_and_objects.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Data_diagnostics.doctree b/documentation/user_docs/build/doctrees/manual/Data_diagnostics.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/FAQ.doctree b/documentation/user_docs/build/doctrees/manual/FAQ.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Generating_SQW_files.doctree b/documentation/user_docs/build/doctrees/manual/Generating_SQW_files.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Input_file_formats.doctree b/documentation/user_docs/build/doctrees/manual/Input_file_formats.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/List_of_functions.doctree b/documentation/user_docs/build/doctrees/manual/List_of_functions.doctree
diff --git a/...build/doctrees/manual/Manipulating_and_extracting_data_from_SQW_files_and_objects.doctree b/...build/doctrees/manual/Manipulating_and_extracting_data_from_SQW_files_and_objects.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Multifit.doctree b/documentation/user_docs/build/doctrees/manual/Multifit.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Parallel.doctree b/documentation/user_docs/build/doctrees/manual/Parallel.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Planning_a_Horace_scan.doctree b/documentation/user_docs/build/doctrees/manual/Planning_a_Horace_scan.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Plotting.doctree b/documentation/user_docs/build/doctrees/manual/Plotting.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Reshaping_etc.doctree b/documentation/user_docs/build/doctrees/manual/Reshaping_etc.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Save_and_load.doctree b/documentation/user_docs/build/doctrees/manual/Save_and_load.doctree
diff --git a/...ntation/user_docs/build/doctrees/manual/Script_for_correcting_sample_misalignment.doctree b/...ntation/user_docs/build/doctrees/manual/Script_for_correcting_sample_misalignment.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Script_for_data_treatment.doctree b/documentation/user_docs/build/doctrees/manual/Script_for_data_treatment.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Script_for_fitting.doctree b/documentation/user_docs/build/doctrees/manual/Script_for_fitting.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Script_for_generating_sqw_files.doctree b/documentation/user_docs/build/doctrees/manual/Script_for_generating_sqw_files.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Script_for_making_cuts_and_plotting.doctree b/documentation/user_docs/build/doctrees/manual/Script_for_making_cuts_and_plotting.doctree
diff --git a/...ion/user_docs/build/doctrees/manual/Script_for_making_publication_quality_figures.doctree b/...ion/user_docs/build/doctrees/manual/Script_for_making_publication_quality_figures.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Script_for_making_simulations.doctree b/documentation/user_docs/build/doctrees/manual/Script_for_making_simulations.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Script_for_planning_an_experiment.doctree b/documentation/user_docs/build/doctrees/manual/Script_for_planning_an_experiment.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Simulation.doctree b/documentation/user_docs/build/doctrees/manual/Simulation.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Special_sqw_information.doctree b/documentation/user_docs/build/doctrees/manual/Special_sqw_information.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Symmetrising_etc.doctree b/documentation/user_docs/build/doctrees/manual/Symmetrising_etc.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Tobyfit.doctree b/documentation/user_docs/build/doctrees/manual/Tobyfit.doctree
diff --git a/documentation/user_docs/build/doctrees/manual/Unary_operations.doctree b/documentation/user_docs/build/doctrees/manual/Unary_operations.doctree
diff --git a/documentation/user_docs/build/doctrees/new_page.doctree b/documentation/user_docs/build/doctrees/new_page.doctree
diff --git a/documentation/user_docs/build/doctrees/user_guide/Advanced_use.doctree b/documentation/user_docs/build/doctrees/user_guide/Advanced_use.doctree
diff --git a/documentation/user_docs/build/doctrees/user_guide/Example_scripts.doctree b/documentation/user_docs/build/doctrees/user_guide/Example_scripts.doctree
diff --git a/documentation/user_docs/build/doctrees/user_guide/Getting_started.doctree b/documentation/user_docs/build/doctrees/user_guide/Getting_started.doctree
diff --git a/documentation/user_docs/build/doctrees/user_guide/Horace3_to_4.doctree b/documentation/user_docs/build/doctrees/user_guide/Horace3_to_4.doctree
diff --git a/documentation/user_docs/build/doctrees/user_guide/Horace_GUI.doctree b/documentation/user_docs/build/doctrees/user_guide/Horace_GUI.doctree
diff --git a/documentation/user_docs/build/doctrees/user_guide/Interfacing_with_other_programs.doctree b/documentation/user_docs/build/doctrees/user_guide/Interfacing_with_other_programs.doctree
diff --git a/documentation/user_docs/build/doctrees/user_guide/Resolution_convolution.doctree b/documentation/user_docs/build/doctrees/user_guide/Resolution_convolution.doctree
diff --git a/documentation/user_docs/build/html/.buildinfo b/documentation/user_docs/build/html/.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: 93fded799b5e20c09c9f5be322477e51
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/documentation/user_docs/build/html/API_Reference.html b/documentation/user_docs/build/html/API_Reference.html
diff --git a/documentation/user_docs/build/html/Citing.html b/documentation/user_docs/build/html/Citing.html
@@ -0,0 +1,146 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Citing Horace &mdash; Horace  documentation</title>
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!--[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=5929fcd5"></script>
+        <script src="_static/doctools.js?v=888ff710"></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" />
+    <link rel="next" title="How to cite Horace" href="How_to_cite_Horace.html" />
+    <link rel="prev" title="Symmetrisation" href="example_scripts/symmetrisation.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">
+            Horace
+              <img src="_static/150px-Quintus_Horatius_Flaccus.jpg" class="logo" alt="Logo"/>
+          </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 class="current">
+<li class="toctree-l1"><a class="reference internal" href="Introduction.html">Introduction and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="User_guide.html">User’s Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Horace_manual.html">Horace Manual</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Example_scripts.html">Example Scripts</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Citing Horace</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="How_to_cite_Horace.html">How to cite Horace</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html">Papers citing Horace</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="Developers.html">For Developers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Contributing.html">Contributing to Horace</a></li>
+<li class="toctree-l1"><a class="reference internal" href="API_Reference.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="General_disclaimer.html">General disclaimer</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Previous_versions.html">Previous Versions</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">Horace</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">Citing Horace</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/Citing.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">
+
+  <section id="citing-horace">
+<h1>Citing Horace<a class="headerlink" href="#citing-horace" title="Link to this heading"></a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="How_to_cite_Horace.html">How to cite Horace</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Papers_citing_Horace.html">Papers citing Horace</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html#id1">2010</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html#id2">2011</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html#id3">2012</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html#id4">2013</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html#id5">2014</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html#id6">2015</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html#id7">2016</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html#id8">2017</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Papers_citing_Horace.html#id9">2018</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="example_scripts/symmetrisation.html" class="btn btn-neutral float-left" title="Symmetrisation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="How_to_cite_Horace.html" class="btn btn-neutral float-right" title="How to cite Horace" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2006-2024, STFC RAL.
+      <span class="lastupdated">Last updated on Aug 15, 2024, 4:46:35 PM.
+      </span></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>.
+
+<br><br>
+<a href="https://github.com/pace-neutrons/Horace/edit/master/documentation/user_docs/docs/Citing.rst">Click here to edit</a> or <a href="https://github.com/pace-neutrons/Horace/edit/master/documentation/user_docs/docs/new_page.rst">Click here to add new page</a> (requires <a href="https://github.com/login">GitHub account</a>).
+<br>
+For more info on editing <a href="Contributing.html">click here</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/documentation/user_docs/build/html/Contributing.html b/documentation/user_docs/build/html/Contributing.html
@@ -0,0 +1,168 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Contributing to Horace &mdash; Horace  documentation</title>
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!--[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=5929fcd5"></script>
+        <script src="_static/doctools.js?v=888ff710"></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" />
+    <link rel="next" title="API Reference" href="API_Reference.html" />
+    <link rel="prev" title="Developer info" href="developers/Developer_info.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">
+            Horace
+              <img src="_static/150px-Quintus_Horatius_Flaccus.jpg" class="logo" alt="Logo"/>
+          </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 class="current">
+<li class="toctree-l1"><a class="reference internal" href="Introduction.html">Introduction and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="User_guide.html">User’s Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Horace_manual.html">Horace Manual</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Example_scripts.html">Example Scripts</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Citing.html">Citing Horace</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Developers.html">For Developers</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to Horace</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#contributing-documentation">Contributing documentation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#contributing-reports">Contributing reports</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#contributing-code">Contributing code</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="API_Reference.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="General_disclaimer.html">General disclaimer</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Previous_versions.html">Previous Versions</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">Horace</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">Contributing to Horace</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/Contributing.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">
+
+  <section id="contributing-to-horace">
+<h1>Contributing to Horace<a class="headerlink" href="#contributing-to-horace" title="Link to this heading"></a></h1>
+<section id="contributing-documentation">
+<h2>Contributing documentation<a class="headerlink" href="#contributing-documentation" title="Link to this heading"></a></h2>
+<p>If you wish to contribute directly to the documentation, please follow the 6 step process below:</p>
+<ol class="arabic simple">
+<li><p>If you notice a mistake or a place which could be improved, click the <code class="docutils literal notranslate"><span class="pre">Click</span> <span class="pre">here</span> <span class="pre">to</span> <span class="pre">edit</span></code> or the <code class="docutils literal notranslate"><span class="pre">Click</span> <span class="pre">here</span> <span class="pre">to</span>
+<span class="pre">add</span> <span class="pre">new</span> <span class="pre">page</span></code> button at the bottom of the page. This will take you to the GitHub edit page (requires <a class="reference external" href="https://github.com/login">GitHub account</a>).</p></li>
+<li><p>Correct the mistake or add new content in the GitHub editor (see <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html">reST documentation</a>). <strong>N.B.</strong> It is possible to click the
+<code class="docutils literal notranslate"><span class="pre">Preview</span></code> tab at the top to see an approximate render of your changes.</p></li>
+<li><p>Select the <code class="docutils literal notranslate"><span class="pre">Create</span> <span class="pre">a</span> <span class="pre">new</span> <span class="pre">branch</span> <span class="pre">for</span> <span class="pre">this</span> <span class="pre">commit</span></code> option at the bottom of the page, with comments describing your
+changes as appropriate in the “Add an optional extended description” box above. <strong>N.B.</strong> For new pages, please note
+in the description a suggestion for the appropriate place the new page should be added, e.g. “Add to User Manual”.</p></li>
+<li><p>Click the <code class="docutils literal notranslate"><span class="pre">Propose</span> <span class="pre">changes</span></code> button, which will take you to the “Open Pull Request” page.</p></li>
+<li><p>In the <code class="docutils literal notranslate"><span class="pre">labels</span></code> tab on the right-hand panel select <code class="docutils literal notranslate"><span class="pre">documentation</span></code> and <code class="docutils literal notranslate"><span class="pre">DO_NOT_CI</span></code> labels. This makes it
+possible for the development team to track the changes more easily.</p></li>
+<li><p>Click <code class="docutils literal notranslate"><span class="pre">Create</span> <span class="pre">pull</span> <span class="pre">request</span></code>. This will submit the changes to the development team for review.</p></li>
+</ol>
+<p>Following your submission, the corrections will be reviewed by the development team. After the review, if your changes
+are accepted, you should receive an email from GitHub upon their merging. It is possible to see the latest (subject to
+change) version of the documentation in the <a class="reference external" href="https://pace-neutrons.github.io/Horace/unstable/">unstable documentation</a>. The full documentation will be updated on the next Horace
+release.</p>
+</section>
+<section id="contributing-reports">
+<h2>Contributing reports<a class="headerlink" href="#contributing-reports" title="Link to this heading"></a></h2>
+<p>If you find an error in the code or documentation it is possible to report the issue to the development team to be
+handled. This can be done through either the <a class="reference external" href="mailto:HoraceHelp&#37;&#52;&#48;stfc&#46;ac&#46;uk">Horace Help</a> email address, or more
+directly through <a class="reference external" href="https://github.com/pace-neutrons/Horace/issues">opening a GitHub issue</a> (requires <a class="reference external" href="https://github.com/login">GitHub account</a>):</p>
+<ol class="arabic simple">
+<li><p>Click the green button on the top right which reads <code class="docutils literal notranslate"><span class="pre">New</span> <span class="pre">issue</span></code>.</p></li>
+<li><p>Enter the details of your issue in the “Title” and “Comment” sections, please describe the full extent of your issue
+including, if possible, description of the error, along with any (reasonably sized) inputs or scripts used which raised
+the issue.</p></li>
+<li><p>Click <code class="docutils literal notranslate"><span class="pre">Submit</span> <span class="pre">new</span> <span class="pre">issue</span></code>, which will be sent to the development team.</p></li>
+</ol>
+</section>
+<section id="contributing-code">
+<h2>Contributing code<a class="headerlink" href="#contributing-code" title="Link to this heading"></a></h2>
+<p>If you wish to develop new code for Horace please get in touch with us: <a class="reference external" href="mailto:HoraceHelp&#37;&#52;&#48;stfc&#46;ac&#46;uk">Horace Help</a></p>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="developers/Developer_info.html" class="btn btn-neutral float-left" title="Developer info" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="API_Reference.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2006-2024, STFC RAL.
+      <span class="lastupdated">Last updated on Aug 15, 2024, 4:46:35 PM.
+      </span></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>.
+
+<br><br>
+<a href="https://github.com/pace-neutrons/Horace/edit/master/documentation/user_docs/docs/Contributing.rst">Click here to edit</a> or <a href="https://github.com/pace-neutrons/Horace/edit/master/documentation/user_docs/docs/new_page.rst">Click here to add new page</a> (requires <a href="https://github.com/login">GitHub account</a>).
+<br>
+For more info on editing <a href="#">click here</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>