Skip to content

Commit

Permalink
Automatic update of developer site
Browse files Browse the repository at this point in the history
  • Loading branch information
mantid-builder committed Jun 6, 2024
1 parent aed3f2e commit de933e6
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 24 deletions.
2 changes: 1 addition & 1 deletion BuildingWithCMake.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ <h3>Navigation</h3>
</ul>
</nav>
<p>CMake is the build system for the entirety of Mantid (Framework, MantidQt and MantidWorkbench). It is used to generate native build files for your platform, which can be Makefiles (for use with make, nmake or jom) for command line builds or project/solution files for an IDE (e.g. Visual Studio, Eclipse, Qt Creator, XCode).
For a “how is it used version” of this guide, look at the scripts used on the builservers for <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/buildconfig/Jenkins/buildscript.bat">windows</a> or <a class="reference external" href="https://github.com/mantidproject/mantid/blob/master/buildconfig/Jenkins/buildscript">linux/osx</a>.</p>
For a “how is it used version” of this guide, see the <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/buildconfig/Jenkins/Conda/build">build script</a> used on the build servers.</p>
<section id="environment">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Environment</a><a class="headerlink" href="#environment" title="Link to this heading"></a></h2>
<p>The <a class="reference internal" href="GettingStarted/GettingStarted.html#gettingstarted"><span class="std std-ref">getting started</span></a> page describes how to set up your environment to build Mantid. Follow those instructions and install the Mantid dependencies first.</p>
Expand Down
6 changes: 3 additions & 3 deletions DevelopmentAndReleaseCycle.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,11 @@ <h3>Navigation</h3>
</ul>
</li>
</ul>
<p>Feature development occurs on the <a class="reference external" href="https://github.com/mantidproject/mantid/tree/master">master</a> branch. At the code
<p>Feature development occurs on the <a class="reference external" href="https://github.com/mantidproject/mantid/tree/main">main</a> branch. At the code
freeze, once all pull requests marked for the release have been merged, a new branch is created for the next release. Fixes
found during testing are merged to the release branch and the master remains open to changes not destined for this release.</p>
found during testing are merged to the release branch and the main branch remains open to changes not destined for this release.</p>
<p>The maintenance period generally overlaps with the tail end of the code freeze. All maintenance tasks occur on the
master branch and should not disturb the release branch.</p>
main branch and should not disturb the release branch.</p>
</section>


Expand Down
4 changes: 2 additions & 2 deletions FlowchartCreation.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ <h3>Navigation</h3>
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">diagram</span><span class="p">::</span> AlgorithmName-v1_wkflw.dot
</pre></div>
</div>
<p>Examples of this can be found in <a class="reference external" href="https://raw.githubusercontent.com/mantidproject/mantid/master/docs/source/algorithms/ReflectometryReductionOne-v1.rst">ReflectometryReductionOne1.rst</a> and <a class="reference external" href="https://raw.githubusercontent.com/mantidproject/mantid/master/docs/source/algorithms/ReflectometryReductionOneAuto-v1.rst">ReflectometryReductionOneAuto-v1.rst</a>.</p>
<p>Examples of this can be found in <a class="reference external" href="https://raw.githubusercontent.com/mantidproject/mantid/main/docs/source/algorithms/ReflectometryReductionOne-v2.rst">ReflectometryReductionOne-v2.rst</a> and <a class="reference external" href="https://raw.githubusercontent.com/mantidproject/mantid/main/docs/source/algorithms/ReflectometryReductionOneAuto-v2.rst">ReflectometryReductionOneAuto-v2.rst</a>.</p>
<p>The .dot format is quite simple¸ but very powerful for describing graphs. The approach we use is to describe all the nodes (shapes) we want first, grouping them into their types, and then defining how they’re connected.</p>
<p>To provide a uniform look to all the workflow diagrams, templated keywords are provided which are swapped out with the correct styling options when the documentation is built. They are of the form <code class="docutils literal notranslate"><span class="pre">${context}_style</span></code>. They’re defined by the <a class="reference external" href="https://raw.githubusercontent.com/mantidproject/mantid/master/docs/sphinxext/mantiddoc/directives/diagram.py">diagram directive</a>.</p>
<p>To provide a uniform look to all the workflow diagrams, templated keywords are provided which are swapped out with the correct styling options when the documentation is built. They are of the form <code class="docutils literal notranslate"><span class="pre">${context}_style</span></code>. They’re defined by the <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/docs/sphinxext/mantiddoc/directives/diagram.py">diagram directive</a>.</p>
<p>An algorithm that takes one input workspace and scales it by a given parameter/property if it was given, may look like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>digraph DiagramName {
//Comments are inserted in the same way as C++
Expand Down
2 changes: 1 addition & 1 deletion GettingStarted/GettingStartedNoneConda.html
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ <h3>OSX<a class="headerlink" href="#osx" title="Link to this heading">¶</a></h3
</section>
<section id="docker">
<h3>Docker<a class="headerlink" href="#docker" title="Link to this heading"></a></h3>
<p>On Docker supported systems you may use the <a class="reference external" href="https://github.com/mantidproject/dockerfiles/tree/master/development">mantid-development</a>
<p>On Docker supported systems you may use the <a class="reference external" href="https://github.com/mantidproject/dockerfiles/tree/main/development">mantid-development</a>
images to develop Mantid without having to configure your system as a suitable
build environment. This will give you an out of the box working build
environment, Python 3 (where available) and ccache.</p>
Expand Down
2 changes: 1 addition & 1 deletion MVPDesign.html
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ <h3><a class="toc-backref" href="#id7" role="doc-backlink">Testing MVP Component
<p>It’s useful to mock out the view because we don’t want to have to
manually input data every time the unit tests are run - instead we can
mock the <strong>get</strong> methods to simulate the user entering data.</p>
<p>Using <a class="reference external" href="https://github.com/google/googletest/blob/master/googlemock/docs/Documentation.md">GMock</a>
<p>Using <a class="reference external" href="https://github.com/google/googletest/tree/main/googlemock">GMock</a>
in C++, or <a class="reference external" href="https://docs.python.org/3/library/unittest.mock.html">unittest.mock</a> in Python, we
can set expectations in the unit tests for certain methods to be
called, and with certain arguments.</p>
Expand Down
2 changes: 1 addition & 1 deletion QtDesignerForPython.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ <h2>Using the Generated Class<a class="headerlink" href="#using-the-generated-cl
<section id="integrating-into-workbench">
<h2>Integrating into Workbench<a class="headerlink" href="#integrating-into-workbench" title="Link to this heading"></a></h2>
<p>In order to implement a new interface into Mantid Workbench it is best to
start with a up to date build from master. For this demo our interface does
start with a up to date build from <code class="docutils literal notranslate"><span class="pre">main</span></code>. For this demo our interface does
not need any presenter or model, those can be added later, all that is needed
is a <code class="docutils literal notranslate"><span class="pre">.ui</span></code> file and a script that will open it as an application. Take view
from above and use the following as your main:</p>
Expand Down
2 changes: 1 addition & 1 deletion ReleaseChecklist.html
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,7 @@ <h3><a class="toc-backref" href="#id37" role="doc-backlink">Smoke Testing</a><a
<a class="reference external" href="https://github.com/mantidproject/www">mantidproject/www repository</a>.</p></li>
<li><p>Ask someone with access to the <a class="reference external" href="https://github.com/ral-facilities/daaas-ansible-workspace">daaas-ansible-workspace repository</a> (a member of the ISIS core team or IDAaaS support)
to add the new release to IDAaaS. They can do this by creating a PR targeting the <code class="docutils literal notranslate"><span class="pre">preprod</span></code> branch, adding
the new release version to the list of versions installed on IDAaaS <a class="reference external" href="https://github.com/ral-facilities/daaas-ansible-workspace/blob/master/roles/software/analysis/mantid/defaults/main.yml">here</a>.
the new release version to the list of versions installed on IDAaaS <a class="reference external" href="https://github.com/ral-facilities/daaas-ansible-workspace/blob/main/roles/software/analysis/mantid/defaults/main.yml">here</a>.
Make sure that there are only three <code class="docutils literal notranslate"><span class="pre">mantid_versions</span></code> in the list (delete the oldest one if applicable).
The changes need to be verified on an IDAaaS test instance before the PR can be accepted.</p></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion ReviewingAPullRequest.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h2>Functional Testing<a class="headerlink" href="#functional-testing" title="Li
</section>
<section id="gatekeeper">
<h2>Gatekeeper<a class="headerlink" href="#gatekeeper" title="Link to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">&#64;mantidproject/gatekeepers</span></code> group is who is meant to merge pull requests into master. This is done by social contract. A gatekeeper can <code class="docutils literal notranslate"><span class="pre">merge</span></code> code if:</p>
<p>The <code class="docutils literal notranslate"><span class="pre">&#64;mantidproject/gatekeepers</span></code> group is who is meant to merge pull requests into <code class="docutils literal notranslate"><span class="pre">main</span></code>. This is done by social contract. A gatekeeper can <code class="docutils literal notranslate"><span class="pre">merge</span></code> code if:</p>
<ul class="simple">
<li><p>Green tick on the last build indicating all automated testing has succeeded</p></li>
<li><p>Adequate tests, both success and failure cases have been performed</p></li>
Expand Down
4 changes: 2 additions & 2 deletions TSC.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,11 @@ <h3>Navigation</h3>

<section id="technical-steering-committee">
<span id="tsc"></span><h1>Technical Steering Committee<a class="headerlink" href="#technical-steering-committee" title="Link to this heading"></a></h1>
<p>Please see the <a class="reference external" href="https://github.com/mantidproject/documents/blob/master/Project-Management/TechnicalSteeringCommittee/TSC-Terms.md">TSC terms</a>
<p>Please see the <a class="reference external" href="https://github.com/mantidproject/documents/blob/main/Project-Management/TechnicalSteeringCommittee/TSC-Terms.md">TSC terms</a>
for a description of the aims of this committee including a list of current members.</p>
<p>Contact email: <a class="reference external" href="mailto:mantid-tech&#37;&#52;&#48;mantidproject&#46;org">mantid-tech<span>&#64;</span>mantidproject<span>&#46;</span>org</a></p>
<p>Minutes and reports from Technical Steering Committee meetings can be found
<a class="reference external" href="http://github.com/mantidproject/documents/tree/master/Project-Management/TechnicalSteeringCommittee">here</a>.</p>
<a class="reference external" href="https://github.com/mantidproject/documents/tree/main/Project-Management/TechnicalSteeringCommittee">here</a>.</p>
</section>


Expand Down
16 changes: 6 additions & 10 deletions WritingPerformanceTests.html
Original file line number Diff line number Diff line change
Expand Up @@ -251,16 +251,12 @@ <h2><a class="toc-backref" href="#id6" role="doc-backlink">Avoiding Compiler Opt
</section>
<section id="jobs-that-monitor-performance">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Jobs that monitor performance</a><a class="headerlink" href="#jobs-that-monitor-performance" title="Link to this heading"></a></h2>
<p>There is a job in Jenkins (our continuous integration system) that runs
the performance test suite and generates output that enables us to
easily monitor timings. The job runs a set of <a class="reference external" href="http://builds.mantidproject.org/job/main_performancetests2/">performance tests on the
main branch of
Mantid</a>.
This job runs on a machine at the ESS, everytime that changes are merged
into the Mantid master branch, and stores the timing information in a
database, also generating HTML output via a <a class="reference external" href="https://github.com/mantidproject/mantid/tree/main/Testing/PerformanceTests">set of python
scripts</a>.</p>
<p>The timing output of these jobs are typically monitored manually on a
<p>There are currently no jobs that run the performance tests. See <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/buildconfig/Jenkins/performancetests">here</a>
for the build script that was used to run the tests on Jenkins.
Anyone attempting to resurrect the job will have to modify it
to work with the new Conda build system. There is a <a class="reference external" href="https://github.com/mantidproject/mantid/tree/main/Testing/PerformanceTests">set of python scripts</a>
for controlling and monitoring the performance tests.</p>
<p>The timing output of these jobs were typically monitored manually on a
weekly basis to pick up any notable performance degradation. Although
automatic checking is available within the python scripts, the level of
instability in the timings meant that it always produced way too many
Expand Down
Binary file modified _images/DevelopmentAndReleaseCycle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit de933e6

Please sign in to comment.