Repository navigation
Expand file tree
/
Copy pathindex.html
More file actions
623 lines (485 loc) · 32 KB
/
Copy pathindex.html
File metadata and controls
623 lines (485 loc) · 32 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<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 Documentation — MantidProject main documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=18bd87630a240e9c25be" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=18bd87630a240e9c25be" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/css/style.css?v=562d7d41" />
<!-- So that users can add custom icons -->
<script defer src="_static/scripts/fontawesome.js?digest=18bd87630a240e9c25be"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=18bd87630a240e9c25be" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=18bd87630a240e9c25be" />
<script src="_static/documentation_options.js?v=a8da1a53"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
<script>DOCUMENTATION_OPTIONS.search_as_you_type = false;</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Developer Accounts" href="DeveloperAccounts.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
<link rel="icon" sizes="32x32" href="_static/images/favicon.ico">
</head>
<body data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header id="pst-header" class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button type="button" class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="#">
<img src="_static/images/mantid_logo_light.png" class="logo__image only-light" alt="Logo image">
<img src="_static/images/mantid_logo_dark.png" class="logo__image only-dark" alt="Logo image">
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button type="button" class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button type="button" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button type="button" class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button type="button" class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button type="button" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none"></div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="developer-documentation">
<span id="contents"></span><h1>Developer Documentation<a class="headerlink" href="#developer-documentation" title="Link to this heading">#</a></h1>
<p>These pages contain the developer documentation for mantid. They are aimed at those who are modifying the
source code of the project. For user documentation please see <a class="reference external" href="https://docs.mantidproject.org/nightly/index.html#contents" title="(in MantidProject v6.16)"><span class="xref std std-ref">here</span></a>.</p>
</section>
<section id="guides">
<h1>Guides<a class="headerlink" href="#guides" title="Link to this heading">#</a></h1>
<div class="toctree-wrapper compound">
</div>
<dl class="simple">
<dt><a class="reference internal" href="DeveloperAccounts.html"><span class="doc">Developer Accounts</span></a></dt><dd><p>Details of the accounts required for developers.</p>
</dd>
<dt><a class="reference internal" href="GettingStarted/GettingStarted.html"><span class="doc">Getting Started</span></a></dt><dd><p>Describes the process of obtaining and building the mantid code base.</p>
</dd>
<dt><a class="reference internal" href="Packaging.html"><span class="doc">Packaging</span></a></dt><dd><p>Describes the process building the user packages.</p>
</dd>
<dt><a class="reference internal" href="Architecture.html"><span class="doc">Architecture</span></a></dt><dd><p>Describes the architecture of the mantid libraries and applications.</p>
</dd>
<dt><a class="reference internal" href="LocalMantidBuildWithPixi.html"><span class="doc">Using Local Mantid Build in Other Projects with Pixi</span></a></dt><dd><p>How to set up a pixi environment to use a local Mantid build instead of conda packages in other projects.</p>
</dd>
<dt><a class="reference internal" href="Standards/index.html"><span class="doc">Standards</span></a></dt><dd><p>Details of coding and documentation standards for the project. Includes specifics regarding algorithms.</p>
</dd>
<dt><a class="reference internal" href="Testing/index.html"><span class="doc">Manual Testing</span></a></dt><dd><p>Details of manual and acceptance/smoke testing.</p>
</dd>
<dt><a class="reference internal" href="DoxygenSetup.html"><span class="doc">Doxygen Setup</span></a></dt><dd><p>Configure a doxygen build locally.</p>
</dd>
<dt><a class="reference internal" href="NewStarterC%2B%2B.html"><span class="doc">New Starter C++</span></a></dt><dd><p>Exercises for learning C++.</p>
</dd>
<dt><a class="reference internal" href="NewStarterPython.html"><span class="doc">New Starter Python</span></a></dt><dd><p>Exercises for learning Python.</p>
</dd>
</dl>
</section>
<section id="development-process">
<h1>Development Process<a class="headerlink" href="#development-process" title="Link to this heading">#</a></h1>
<div class="toctree-wrapper compound">
</div>
<dl class="simple">
<dt><a class="reference internal" href="DevelopmentAndReleaseCycle.html"><span class="doc">Development and Release Cycle</span></a></dt><dd><p>An overview of the development cycle.</p>
</dd>
<dt><a class="reference internal" href="Communication.html"><span class="doc">Communication</span></a></dt><dd><p>Details various methods of communication used within the team.</p>
</dd>
<dt><a class="reference internal" href="IssueTracking.html"><span class="doc">Mantid Issue Tracking</span></a></dt><dd><p>Describes how issues are tracked over the project.</p>
</dd>
<dt><a class="reference internal" href="UserSupport.html"><span class="doc">User Support</span></a></dt><dd><p>Procedures for User Problems to be tested and passed to the Development Team.</p>
</dd>
<dt><a class="reference internal" href="GitWorkflow.html"><span class="doc">Mantid Git Workflow</span></a></dt><dd><p>Details the workflow used development with git and GitHub.</p>
</dd>
<dt><a class="reference internal" href="AutomatedBuildProcess.html"><span class="doc">The Automated Build Process</span></a></dt><dd><p>Details the interaction of pull requests with the Jenkins CI builds.</p>
</dd>
<dt><a class="reference internal" href="JenkinsConfiguration.html"><span class="doc">Jenkins Configuration</span></a></dt><dd><p>Describes the setup of Jenkins system and how to add a new node.</p>
</dd>
<dt><a class="reference internal" href="ReleaseChecklist.html"><span class="doc">Release Checklist</span></a></dt><dd><p>How to perform a full release of Mantid.</p>
</dd>
<dt><a class="reference internal" href="PatchReleaseChecklist.html"><span class="doc">Patch Release Checklist</span></a></dt><dd><p>How to perform a patch release of Mantid.</p>
</dd>
<dt><a class="reference internal" href="TSC.html"><span class="doc">Technical Steering Committee</span></a></dt><dd><p>Overview of the role of the technical steering committee.</p>
</dd>
<dt><a class="reference internal" href="DesignDocumentGuides.html"><span class="doc">Design Document Guidelines</span></a></dt><dd><p>When and how to write a good design document.</p>
</dd>
</dl>
</section>
<section id="tools">
<h1>Tools<a class="headerlink" href="#tools" title="Link to this heading">#</a></h1>
<div class="toctree-wrapper compound">
</div>
<dl class="simple">
<dt><a class="reference internal" href="ToolsOverview.html"><span class="doc">Tools Overview</span></a></dt><dd><p>Describes <code class="docutils literal notranslate"><span class="pre">class_maker</span></code>, <code class="docutils literal notranslate"><span class="pre">valgrind</span></code> and related tools.</p>
</dd>
<dt><a class="reference internal" href="ProfilingOverview.html"><span class="doc">Profiling Overview</span></a></dt><dd><p>There are a few different ways to profile Mantid code.</p>
</dd>
<dt><a class="reference internal" href="Timers.html"><span class="doc">Mantid Timers</span></a></dt><dd><p>Describes different ways of timing Mantid C++ code.</p>
</dd>
<dt><a class="reference internal" href="FlowchartCreation.html"><span class="doc">Flowchart Creation</span></a></dt><dd><p>Describes how to create a flow chart with dot.</p>
</dd>
<dt><a class="reference internal" href="VisualStudioBuildImpact.html"><span class="doc">Visual Studio Build Impact</span></a></dt><dd><p>Provides a script to reduce the impact of Visual Studio on machine performance.</p>
</dd>
<dt><a class="reference internal" href="PyCharm.html"><span class="doc">PyCharm</span></a></dt><dd><p>Describes how to set up the PyCharm interpreter, and debug python code (Windows/Linux only).</p>
</dd>
<dt><a class="reference internal" href="CLion.html"><span class="doc">CLion</span></a></dt><dd><p>Describes how to set up CLion to build and debug using a Ninja generator (Windows/Linux only).</p>
</dd>
<dt><a class="reference internal" href="VSCode.html"><span class="doc">VSCode</span></a></dt><dd><p>Guide to using VSCode for C++ with Mantid.</p>
</dd>
<dt><a class="reference internal" href="Eclipse.html"><span class="doc">Eclipse on Ubuntu</span></a></dt><dd><p>Guide to setting up Eclipse on Ubuntu</p>
</dd>
<dt><a class="reference internal" href="WindowsSubsystemForLinux.html"><span class="doc">Windows Subsystem for Linux (WSL2)</span></a></dt><dd><p>Guide for setting up Ubuntu 18.04 and Centos7 as subsystems on Windows (WSL2).</p>
</dd>
<dt><a class="reference internal" href="ObtainingABenchmarkForMantidFitting.html"><span class="doc">Obtaining a Benchmark for Mantid Fitting</span></a></dt><dd><p>Guide for setting up an environment to perform a benchmark of Mantid fitting minimizers.</p>
</dd>
<dt><a class="reference internal" href="CondaPackageManager.html"><span class="doc">Conda Package Manager</span></a></dt><dd><p>Guide on how to use the conda package manager in Mantid, including tips and a <code class="docutils literal notranslate"><span class="pre">pip</span></code> policy.</p>
</dd>
</dl>
</section>
<section id="testing">
<h1>Testing<a class="headerlink" href="#testing" title="Link to this heading">#</a></h1>
<div class="toctree-wrapper compound">
</div>
<dl class="simple">
<dt><a class="reference internal" href="RunningTheUnitTests.html"><span class="doc">Running the Unit Tests</span></a></dt><dd><p>Details on how to run the suite of unit tests.</p>
</dd>
<dt><a class="reference internal" href="DebuggingUnitTests.html"><span class="doc">Debugging Unit Tests</span></a></dt><dd><p>Details on how to debug the suite of unit tests.</p>
</dd>
<dt><a class="reference internal" href="UnitTestGoodPractice.html"><span class="doc">Unit Test Good Practice</span></a></dt><dd><p>Guidance on writing good unit tests.</p>
</dd>
<dt><a class="reference internal" href="ReviewingAPullRequest.html"><span class="doc">Reviewing a Pull Request</span></a></dt><dd><p>What to do when reviewing an individual contribution to mantid.</p>
</dd>
<dt><a class="reference internal" href="Gatekeeping.html"><span class="doc">Gatekeeping a Pull Request</span></a></dt><dd><p>Things to consider when merging a pull request to the main production branch.</p>
</dd>
<dt><a class="reference internal" href="WritingPerformanceTests.html"><span class="doc">Writing Performance Tests</span></a></dt><dd><p>A walk through of how to write a performance test.</p>
</dd>
<dt><a class="reference internal" href="SystemTests.html"><span class="doc">System Tests</span></a></dt><dd><p>Guidance on working with the system tests.</p>
</dd>
<dt><a class="reference internal" href="AutomatedUITests.html"><span class="doc">Automated UI Tests</span></a></dt><dd><p>Guidance on working with the automated UI tests, which drive a real Qt interface.</p>
</dd>
<dt><a class="reference internal" href="DataFilesForTesting.html"><span class="doc">Data Files for Testing</span></a></dt><dd><p>How to work with test data files in the mantid repository.</p>
</dd>
<dt><a class="reference internal" href="TestingUtilities.html"><span class="doc">Testing Utilities</span></a></dt><dd><p>Helper utlities used for testing.</p>
</dd>
<dt><a class="reference internal" href="RunningSanitizers.html"><span class="doc">Running Sanitizers</span></a></dt><dd><p>How to run the various sanitizers locally.</p>
</dd>
<dt><a class="reference internal" href="UnittestMonitor.html"><span class="doc">Unittest Monitor</span></a></dt><dd><p>Monitor failing and flakey unittests from the Jenkins nightly pipelines.</p>
</dd>
</dl>
</section>
<section id="gui-development">
<h1>GUI Development<a class="headerlink" href="#gui-development" title="Link to this heading">#</a></h1>
<div class="toctree-wrapper compound">
</div>
<dl class="simple">
<dt><a class="reference internal" href="MVPDesign.html"><span class="doc">MVP Design</span></a></dt><dd><p>Gives some guidelines to consider when developing a new graphical user interface.</p>
</dd>
<dt><a class="reference internal" href="MVPTutorial/index.html"><span class="doc">MVP Tutorial</span></a></dt><dd><p>A hands-on tutorial on how to implement a user GUI using the Model-View-Presenter (MVP) pattern.</p>
</dd>
<dt><a class="reference internal" href="QtDesignerForPython.html"><span class="doc">Qt Designer for Python</span></a></dt><dd><p>Describes how to use the Qt designer to produce GUI views.</p>
</dd>
<dt><a class="reference internal" href="GuiTutorialFramework.html"><span class="doc">GUI Tutorial Framework</span></a></dt><dd><p>How to add a guided, automated tutorial that walks a user through a Qt interface.</p>
</dd>
<dt><a class="reference internal" href="BalsamiqWireframes.html"><span class="doc">Mockups with Balsamiq Wireframes</span></a></dt><dd><p>An introduction to mockups with Balsamiq Wireframes.</p>
</dd>
<dt><a class="reference internal" href="MantidUsedIconsTable.html"><span class="doc">Mantid Icon Table</span></a></dt><dd><p>The currently used Icons in Mantid and what they are used for.</p>
</dd>
<dt><a class="reference internal" href="ISISReflectometryInterface.html"><span class="doc">ISIS Reflectometry Interface</span></a></dt><dd><p>An example of a complex C++ interface that uses MVP.</p>
</dd>
<dt><a class="reference internal" href="ISISReflectometryPlottingTab.html"><span class="doc">ISIS Reflectometry Plotting Tab Internals</span></a></dt><dd><p>Describes the architecture and execution flow of the ISIS Reflectometry Plotting tab.</p>
</dd>
</dl>
</section>
<section id="workbench">
<h1>Workbench<a class="headerlink" href="#workbench" title="Link to this heading">#</a></h1>
<p>The workbench is the new PyQt-based GUI that will be the primary interface for
interacting with the mantid framework. The plotting is provided by
<a class="reference external" href="https://matplotlib.org/">matplotlib</a>. It has replaced MantidPlot.</p>
<div class="toctree-wrapper compound">
</div>
<dl class="simple">
<dt><a class="reference internal" href="Workbench/index.html"><span class="doc">Workbench Documentation</span></a></dt><dd><p>The Index of the workbench specific files.</p>
</dd>
</dl>
</section>
<section id="component-overviews">
<h1>Component Overviews<a class="headerlink" href="#component-overviews" title="Link to this heading">#</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="BatchWidget/index.html">Batch Widget Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="EnumeratedString.html">EnumeratedString</a></li>
<li class="toctree-l1"><a class="reference internal" href="EnumeratedStringProperty.html">What is EnumeratedStringProperty?</a></li>
<li class="toctree-l1"><a class="reference internal" href="EnumeratedStringProperty.html#how-to-use-the-enumeratedstringproperty">How to use the EnumeratedStringProperty</a></li>
<li class="toctree-l1"><a class="reference internal" href="EnumeratedStringProperty.html#example-use-of-enumeratedstring">Example Use of EnumeratedString</a></li>
<li class="toctree-l1"><a class="reference internal" href="EventWorkspaceDev.html">Event Workspace Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="HandlingXML.html">Handling XML</a></li>
<li class="toctree-l1"><a class="reference internal" href="IndexProperty.html">Index Property</a></li>
<li class="toctree-l1"><a class="reference internal" href="IndirectDataAnalysisAddingFitType.html">Adding a new fitting function to IDA</a></li>
<li class="toctree-l1"><a class="reference internal" href="IndirectDataAnalysisFileStructure.html">IndirectDataAnalysis File Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="IndirectDataAnalysisFileStructure.html#fit-tab-structure">Fit Tab structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="IndirectDataAnalysisFileStructure.html#qens-fit-class-structure">QENS Fit class structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="InelasticDataProcessorFileStructure.html">Inelastic Data Processor Class Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="InstrumentViewer.html">Instrument View</a></li>
<li class="toctree-l1"><a class="reference internal" href="LegacyInstrumentViewer.html">Legacy Instrument Viewer Widget</a></li>
<li class="toctree-l1"><a class="reference internal" href="ISISReflectometryInterface.html">ISIS Reflectometry Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="ISISSANSReductionBackend.html">ISIS SANS Reduction Back-end</a></li>
<li class="toctree-l1"><a class="reference internal" href="LoadAlgorithmHook.html">Load Algorithm Hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="LiveListenerMigration.html">Live-Listener API Migration Guide (v3 refactoring)</a></li>
<li class="toctree-l1"><a class="reference internal" href="Logging.html">Logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="MatplotlibInCpp.html">Matplotlib in C++</a></li>
<li class="toctree-l1"><a class="reference internal" href="MultiThreadingInMantid.html">Multithreading in Mantid</a></li>
<li class="toctree-l1"><a class="reference internal" href="PythonVSCppAlgorithms.html">Python vs C++ Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="SampleLogsDev.html">Sample Logs</a></li>
<li class="toctree-l1"><a class="reference internal" href="ScriptRepository.html">Script Repository</a></li>
<li class="toctree-l1"><a class="reference internal" href="SNSLiveEventDataListenerRefactoring.html"><code class="docutils literal notranslate"><span class="pre">SNSLiveEventDataListener</span></code> refactoring</a></li>
<li class="toctree-l1"><a class="reference internal" href="TaskBasedAlgorithms.html">Task Based Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="Widgets/Plotting.html">Plotting <em>(Elemental Analysis)</em></a></li>
<li class="toctree-l1"><a class="reference internal" href="WritingAnAlgorithm.html">Writing An Algorithm</a></li>
<li class="toctree-l1"><a class="reference internal" href="DynamicProperties.html">Dynamic dialog properties</a></li>
<li class="toctree-l1"><a class="reference internal" href="WritingCustomConvertToMDTransformation.html">Writing a Custom ConvertToMD Transformation</a></li>
<li class="toctree-l1"><a class="reference internal" href="ISISEnergyTransferTab.html">ISIS Energy Transfer Tab</a></li>
</ul>
</div>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="right-next"
href="DeveloperAccounts.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Developer Accounts</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav id="pst-page-toc-nav" class="page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="pst-show_toc_level nav section-nav flex-column">
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">Developer Documentation</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#guides">Guides</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#development-process">Development Process</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#tools">Tools</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#testing">Testing</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#gui-development">GUI Development</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#workbench">Workbench</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#component-overviews">Component Overviews</a></li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div class="tocsection sourcelink">
<a href="_sources/index.rst.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=18bd87630a240e9c25be"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=18bd87630a240e9c25be"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2007-2026, Mantid.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.2.0.
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.23.0.
</p></div>
</div>
</div>
</footer>
</body>
</html>