-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathToolsOverview.html
More file actions
749 lines (601 loc) · 44.2 KB
/
Copy pathToolsOverview.html
File metadata and controls
749 lines (601 loc) · 44.2 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
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
<!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>Tools Overview — 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=a95f357e85573c9b56d5" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=a95f357e85573c9b56d5" 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=a95f357e85573c9b56d5"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=a95f357e85573c9b56d5" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=a95f357e85573c9b56d5" />
<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 = 'ToolsOverview';</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="Work flows algorithm profiling" href="AlgorithmProfiler.html" />
<link rel="prev" title="Generating code coverage" href="CodeCoverage.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 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="index.html">
<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 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 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 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 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 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 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 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">
<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 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 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 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 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__start sidebar-primary__section">
<div class="sidebar-primary-item pst-sidebar-collapse"><button id="pst-collapse-sidebar-button" aria-expanded="true" aria-controls="pst-primary-sidebar"><svg class="pst-icon svg-inline--fa" role="img" aria-hidden="true" focusable="false" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg">
<path fill="currentColor" d="M3 15.5C2.36232 15.5 1.74874 15.2564 1.28478 14.8189C0.820828 14.3815 0.541576 13.7832 0.504167 13.1467L0.5 13L0.5 3C0.499965 2.36232 0.743605 1.74874 1.18107 1.28478C1.61854 0.820828 2.21676 0.541576 2.85333 0.504167L3 0.5L13 0.5C13.6377 0.499965 14.2513 0.743605 14.7152 1.18107C15.1792 1.61854 15.4584 2.21676 15.4958 2.85333L15.5 3L15.5 13C15.5 13.6377 15.2564 14.2513 14.8189 14.7152C14.3815 15.1792 13.7832 15.4584 13.1467 15.4958L13 15.5L3 15.5ZM3 13.8333L10.5 13.8333L10.5 2.16667L3 2.16667C2.79589 2.16669 2.59889 2.24163 2.44636 2.37726C2.29383 2.5129 2.19638 2.69979 2.1725 2.9025L2.16667 3L2.16667 13C2.16669 13.2041 2.24163 13.4011 2.37726 13.5536C2.5129 13.7062 2.69979 13.8036 2.9025 13.8275L3 13.8333ZM6.65583 10.325L6.5775 10.2558L4.91083 8.58917C4.76735 8.44567 4.68116 8.25476 4.66843 8.05223C4.65569 7.84971 4.71729 7.6495 4.84167 7.48917L4.91083 7.41083L6.5775 5.74417C6.72747 5.59471 6.9287 5.50794 7.14032 5.50148C7.35194 5.49502 7.55809 5.56935 7.7169 5.70937C7.8757 5.8494 7.97525 6.04463 7.99533 6.25539C8.01541 6.46616 7.95451 6.67667 7.825 6.84417L7.75583 6.9225L6.67917 8L7.75583 9.0775C7.89931 9.22099 7.98551 9.41191 7.99824 9.61443C8.01097 9.81695 7.94938 10.0172 7.825 10.1775L7.75583 10.2558C7.61234 10.3993 7.42142 10.4855 7.2189 10.4982C7.01638 10.511 6.81617 10.4494 6.65583 10.325Z"/>
</svg>
<span class="pst-collapse-sidebar-label">Collapse Sidebar</span>
<span class="pst-expand-sidebar-label">Expand Sidebar</span>
</button></div>
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="AlgorithmProfiler.html">Work flows algorithm profiling</a></li>
</ul>
</div>
</nav></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 class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Tools Overview</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="tools-overview">
<span id="toolsoverview"></span><h1>Tools Overview<a class="headerlink" href="#tools-overview" title="Link to this heading">#</a></h1>
<div class="toctree-wrapper compound">
</div>
<section id="creating-classes-class-maker-py">
<span id="class-maker-py"></span><h2>Creating classes: class_maker.py<a class="headerlink" href="#creating-classes-class-maker-py" title="Link to this heading">#</a></h2>
<p>To make it faster to create a new cpp class.
This is a small python script located in <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/buildconfig/class_maker.py">buildconfig/class_maker.py</a>.
It generates the <code class="docutils literal notranslate"><span class="pre">.cpp</span></code>, <code class="docutils literal notranslate"><span class="pre">.h</span></code>, and test files for a class along with some code stubs.
It can also flesh out more methods for new Algorithms, using the <code class="docutils literal notranslate"><span class="pre">--alg</span></code> option which also creates a stub user documentation page <code class="docutils literal notranslate"><span class="pre">.rst</span></code>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>usage: class_maker.py [-h] [--force] [--no-header] [--no-test] [--no-cpp]
[--no-rst] [--no-cmake] [--alg] [--subfolder SUBFOLDER]
[--project PROJECT]
SUBPROJECT CLASSNAME
Utility to create Mantid class files: header, source and test. version 1.0
positional arguments:
SUBPROJECT The subproject under Framework/; e.g. Kernel
CLASSNAME Name of the class to create
optional arguments:
-h, --help show this help message and exit
--force Force overwriting existing files. Use with caution!
--no-header Don't create the header file
--no-test Don't create the test file
--no-cpp Don't create the cpp file
--no-rst Don't create the rst file
--no-cmake Don't modify cmake files
--alg Create an Algorithm stub. This adds some methods
common to algorithms.
--subfolder SUBFOLDER
Put the source under a subfolder below the main part
of the project, e.g. Geometry/Instrument.
--project PROJECT The project in which this goes. Default: Framework.
Can be MantidQt
</pre></div>
</div>
</section>
<section id="moving-renaming-classes-move-class-py">
<h2>Moving/Renaming classes: move_class.py<a class="headerlink" href="#moving-renaming-classes-move-class-py" title="Link to this heading">#</a></h2>
<p>This python script is located in in /buidconfig/. It will move a class
from one subproject to another and/or rename the class. Namespaces and
cmakelists are adjusted. For details, run:</p>
<p><code class="docutils literal notranslate"><span class="pre">buildconfig/move_class.py</span> <span class="pre">--help</span></code></p>
</section>
<section id="deleting-a-class-delete-class-py">
<h2>Deleting a class: delete_class.py<a class="headerlink" href="#deleting-a-class-delete-class-py" title="Link to this heading">#</a></h2>
<p>This python script is located in in /buildconfig/. It will delete a
class from one subproject. CMakeList.txt is adjusted. For details, run:</p>
<p><code class="docutils literal notranslate"><span class="pre">buildconfig/delete_class.py</span> <span class="pre">--help</span></code></p>
</section>
<section id="profiling">
<h2>Profiling<a class="headerlink" href="#profiling" title="Link to this heading">#</a></h2>
<p>Profiling could mean tracking start-up, the progress of an algoirthm or performance. See <a class="reference internal" href="ProfilingOverview.html"><span class="doc">Profiling Overview</span></a> for more details.</p>
</section>
<section id="leak-checking-etc">
<h2>Leak checking etc<a class="headerlink" href="#leak-checking-etc" title="Link to this heading">#</a></h2>
<section id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Link to this heading">#</a></h3>
<p><a class="reference external" href="http://valgrind.org/docs/manual/mc-manual.html">Memcheck</a></p>
<ul class="simple">
<li><p>Keeps track of allocs/deallocs and reports anything missing at exit.</p></li>
<li><p>Slow but thorough</p></li>
<li><p>Useful options to run with</p></li>
<li><p>See <a class="reference internal" href="ProfilingWithValgrind.html"><span class="doc">valgrind</span></a> for details on how to install</p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">valgrind</span> <span class="pre">--tool=memcheck</span> <span class="pre">--leak-check=full</span> <span class="pre">--show-reachable=yes</span> <span class="pre">--num-callers=20</span> <span class="pre">--track-fds=yes</span> <span class="pre">--track-origins=yes</span> <span class="pre">--freelist-vol=500000000</span> <span class="pre">``\</span> <span class="pre">\</span> <span class="pre">``</span> <span class="pre">[args...]</span></code></p>
</section>
<section id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Link to this heading">#</a></h3>
<p><a class="reference external" href="https://vld.codeplex.com/releases">Visual Leak Detector</a></p>
<ol class="arabic simple">
<li><p>Setup the additional paths as defined in the readme file</p></li>
<li><p>Adjust the configuration file, “C:Program FilesVisual Leak
Detectorvld.ini” to output to both File and debugger by changing the
<code class="docutils literal notranslate"><span class="pre">ReportTo</span></code> to</p></li>
</ol>
<p><code class="docutils literal notranslate"><span class="pre">ReportTo</span> <span class="pre">=</span> <span class="pre">both</span></code></p>
<ol class="arabic simple">
<li><p>Add #include <vld.h> to the system.h file in Kernel</p></li>
<li><p>Compile everything in debug</p></li>
<li><p>Running unit tests should now create a file memory_leak_report.txt in
the test directory.</p></li>
<li><p>IMPORTANT remove the #include <vld.ini> before checking in.</p></li>
</ol>
</section>
</section>
<section id="thread-checking">
<h2>Thread checking<a class="headerlink" href="#thread-checking" title="Link to this heading">#</a></h2>
<section id="helgrind-or-drd">
<h3><a class="reference external" href="http://valgrind.org/docs/manual/hg-manual.html">Helgrind</a> or <a class="reference external" href="http://valgrind.org/docs/manual/drd-manual.html">drd</a><a class="headerlink" href="#helgrind-or-drd" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Identifies race conditions & dead-locks</p></li>
<li><p>Slow but accurate</p></li>
<li><p>A pain to get working with OpenMP. GCC must be recompiled to use a different call to create OMP threads or helgrind/drd cannot “see” the thread calls. Use this <a class="reference external" href="https://github.com/UCSCSlang/Adversarial-Helgrind/raw/master/drd/scripts/download-and-build-gcc">script</a> to recompile the same version off gcc that is onyour system. The script will need editing to change the appropriate variables.</p></li>
</ul>
</section>
</section>
<section id="iwyu">
<h2>IWYU<a class="headerlink" href="#iwyu" title="Link to this heading">#</a></h2>
<p><a class="reference external" href="https://code.google.com/p/include-what-you-use/">include what you
use</a> (iwyu) is a
clang-based tool for determining what include statements are needed in
C/C++ files. Below are instructions for getting it to run with mantid on
linux which is a filled in version of <a class="reference external" href="https://code.google.com/p/include-what-you-use/issues/detail?id=164">this
bug</a>.</p>
<ol class="arabic simple">
<li><p>Install the software. The version available from system installs
should be fine (e.g. yum or apt-get).</p></li>
<li><p>Get a copy of
<a class="reference external" href="https://code.google.com/p/include-what-you-use/source/browse/trunk/iwyu_tool.py">iwyu_tool.py</a>
which is in the project’s repository, but may not be installed if you
got it from your operating system locations (e.g. yum).</p></li>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">-DCMAKE_EXPORT_COMPILE_COMMANDS=TRUE</span></code>. This will
generate an extra file, <code class="docutils literal notranslate"><span class="pre">compile_commands.json</span></code>, in your build area
which has instructions on compiling every file in mantid.</p></li>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">iwyu_tool.py</span> <span class="pre">-p</span> <span class="pre">`pwd</span></code> 2> iwyu.log` to generate the
report of changes redirecting into the file <code class="docutils literal notranslate"><span class="pre">iwyu.log</span></code>. This will
take a long time since it is going through the whole repository. If
you want it for a single file, then supply that as an additional
argument with full path. Only one file can be supplied at a time.</p></li>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">fix_includes</span> <span class="pre"><</span> <span class="pre">iwyu.log</span></code> and compile the results. Depending on
how you installed iwyu, the program may be called
<code class="docutils literal notranslate"><span class="pre">fix_includes.py</span></code>. If it doesn’t compile, the most likely suspect
is that iwyu included a private header. See <a class="reference external" href="https://code.google.com/p/include-what-you-use/wiki/InstructionsForUsers#How_to_Run">iwyu instructions for
users</a>
for ways to handle this. Generally, they suggest deleting the
offending lines.</p></li>
<li><p>Check that your build path didn’t make it into source files. Since
<code class="docutils literal notranslate"><span class="pre">compile_commands.json</span></code> has full paths, iwyu will put full paths in
the include statements. This will not produce an error on your
system, but it will on the build servers. The easiest way to check is
to use <a class="reference external" href="https://github.com/ggreer/the_silver_searcher">the silver
searcher</a> to check
for your username in your source tree.</p></li>
<li><p>Enjoy your success.</p></li>
</ol>
<p><strong>Note:</strong> <code class="docutils literal notranslate"><span class="pre">iwyu</span></code> outputs to <code class="docutils literal notranslate"><span class="pre">stderr</span></code> and always returns a failure
status code since it generates no output. The output stream also affects
<code class="docutils literal notranslate"><span class="pre">iwyu_tool.py</span></code></p>
</section>
<section id="network-related-tools">
<h2>Network Related Tools<a class="headerlink" href="#network-related-tools" title="Link to this heading">#</a></h2>
<section id="wireshark">
<h3>Wireshark<a class="headerlink" href="#wireshark" title="Link to this heading">#</a></h3>
<p>Linux distros should have this in their repositories. For other platforms download it from <a class="reference external" href="https://www.wireshark.org">https://www.wireshark.org</a>.</p>
<p>Cross-platform tool for inspecting network packets. This is useful to troubleshoot many different types of
network-related problems.</p>
</section>
<section id="wonder-shaper">
<h3>Wonder Shaper<a class="headerlink" href="#wonder-shaper" title="Link to this heading">#</a></h3>
<p>Linux only. Install it from your distro’s repository.</p>
<p>Wonder Shaper allows the user to limit the bandwidth of one or more network adapters. This is useful for debugging
issues when a network interface is still active but very slow. More details can be found at <a class="reference external" href="http://xmodulo.com/limit-network-bandwidth-linux.html">http://xmodulo.com/limit-network-bandwidth-linux.html</a>.</p>
</section>
</section>
<section id="clang-tidy">
<h2>Clang-tidy<a class="headerlink" href="#clang-tidy" title="Link to this heading">#</a></h2>
<p>Clang-tidy is a set of tools which allows a developer to detect and fix code which does not follow current best practices,
such as unused parameters or not using range-based for loops. Primarily this is used for modernising C++ code.</p>
<p>The full list of clang-tidy checks can be seen <a class="reference external" href="https://clang.llvm.org/extra/clang-tidy/checks/list.html">here</a>.</p>
<section id="installing">
<h3>Installing<a class="headerlink" href="#installing" title="Link to this heading">#</a></h3>
<p>Mantid does not come packaged with clang-tidy; each developer must download it themselves.</p>
<ul class="simple">
<li><p><strong>Ubuntu</strong>: Run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt-get</span> <span class="pre">install</span> <span class="pre">clang</span> <span class="pre">clang-tidy</span></code> in the command line. The <code class="docutils literal notranslate"><span class="pre">clang</span></code> package is needed to get the system headers.</p></li>
<li><p><strong>Windows</strong>: Download the <a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=caphyon.ClangPowerTools">Visual Studio extension</a>. Windows can operate clang-tidy from Visual Studio alone and so do not need to touch cmake.</p></li>
<li><p><strong>Conda</strong> install <code class="docutils literal notranslate"><span class="pre">clang-tools</span></code> (for <code class="docutils literal notranslate"><span class="pre">clang-tidy</span></code>) and <code class="docutils literal notranslate"><span class="pre">clangxx</span></code> (for system headers and compiler to reduce clang-tidy diagnostic errors)</p></li>
<li><p>Alternatively, download the latest clang-tidy <a class="reference external" href="http://releases.llvm.org/download.html">pre-compiled binary</a>. Windows users should add to path when prompted.</p></li>
</ul>
<p>To make use of the sanitizers on the command line, on needs the re-run</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cmake<span class="w"> </span>-DCMAKE_EXPORT_COMPILE_COMMANDS<span class="o">=</span>on<span class="w"> </span>.
</pre></div>
</div>
<p>in the build tree.
Then symbolically link the <code class="docutils literal notranslate"><span class="pre">compile_commands.json</span></code> from the build tree into the source tree.</p>
<p>Many IDEs support which is described in the <a class="reference external" href="https://clang.llvm.org/extra/clang-tidy/Integrations.html">clang-tidy documentation</a>.</p>
</section>
<section id="visual-studio">
<h3>Visual Studio<a class="headerlink" href="#visual-studio" title="Link to this heading">#</a></h3>
<p>Once you have installed the clang-tidy extension, Visual Studio will have additional options under <code class="docutils literal notranslate"><span class="pre">Tools</span> <span class="pre">-></span> <span class="pre">Options</span> <span class="pre">-></span> <span class="pre">Clang</span> <span class="pre">Power</span> <span class="pre">Tools</span></code>.
Here you can select which checks to run via a checkbox or by supplying a custom check string. For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-*</span><span class="p">,</span><span class="n">cppcoreguidelines</span><span class="o">-*</span><span class="p">,</span><span class="n">modernize</span><span class="o">-*</span>
</pre></div>
</div>
<p>will disable basic default checks (<code class="docutils literal notranslate"><span class="pre">-*</span></code>) and run all conversions to modern C++ (<code class="docutils literal notranslate"><span class="pre">modernize-*</span></code>), such as converting to range-based for loops or using the auto keyword.
Other settings <em>should</em> not require alteration for clang-tidy to work.</p>
<p>To run clang-tidy, right click on a target and highlight <code class="docutils literal notranslate"><span class="pre">Clang</span> <span class="pre">Power</span> <span class="pre">Tools</span></code>. You will have a number of options. <code class="docutils literal notranslate"><span class="pre">Tidy</span></code> will highlight code which fails one of the checks, whereas
<code class="docutils literal notranslate"><span class="pre">Tidy</span> <span class="pre">fix</span></code> will automatically change your code.</p>
<p><em>Note: clang-tidy does not work on</em> <strong>ALL BUILD</strong> <em>so it is necessary to select a subtarget.</em></p>
</section>
<section id="cmake">
<h3>Cmake<a class="headerlink" href="#cmake" title="Link to this heading">#</a></h3>
<p><strong>Not advised:</strong> Mantid provides clang-tidy functionality through cmake.
The guide <a class="reference external" href="https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html">How To Setup Clang Tooling For LLVM</a> gives valuable information for configuration.</p>
<p>In the cmake gui, find the <code class="docutils literal notranslate"><span class="pre">CLANG_TIDY_EXE</span></code> parameter. If you are a non-Linux developer, you may have to manually point to your clang-tidy install.
Configure, and check the cmake log for the message <cite>clang-tidy found</cite>. If the <cite>clang-tidy not found</cite> warning was posted instead then it has not worked.</p>
<p>Once you have clang-tidy, there are several relevant parameters you will want to change:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">ENABLE_CLANG_TIDY</span></code> will turn on clang-tidy support. This will run clang-tidy as part of the compile step and greatly slow-down compilation. It can be disabled again with this variable.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">CLANG_TIDY_CHECKS</span></code> is a semi-colon separated list of checks for clang-tidy to carry out. This defaults to all <code class="docutils literal notranslate"><span class="pre">modernize-</span></code> checks.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">APPLY_CLANG_TIDY_FIX</span></code> will automatically change the code whenever a check has returned a result. The behaviour of <code class="docutils literal notranslate"><span class="pre">ENABLE_CLANG_TIDY</span></code> without this checked is to highlight issues only.</p></li>
</ul>
<p>Configure the build to check that your selected options are reflected in <code class="docutils literal notranslate"><span class="pre">CMAKE_CXX_CLANG_TIDY</span></code>, and then generate.
When you next build, clang-tidy will perform the selected checks on the code included in the target.</p>
<p><em>Note: There is a known issue that clang-tidy is only being applied to certain directories within</em> <code class="docutils literal notranslate"><span class="pre">Framework</span></code> <em>and</em> <code class="docutils literal notranslate"><span class="pre">Mantidplot</span></code>.</p>
</section>
<section id="command-line">
<h3>Command line<a class="headerlink" href="#command-line" title="Link to this heading">#</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">run-clang-tidy</span></code> wrapper will run multiple instances of <code class="docutils literal notranslate"><span class="pre">clang-tidy</span></code> in parallel.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>run-clang-tidy<span class="w"> </span>-config-file<span class="o">=</span>/full/path/to/src/code/.clang-tidy<span class="w"> </span>Framework/Nexus/src/Nexus
</pre></div>
</div>
<p>will run <code class="docutils literal notranslate"><span class="pre">clang-tidy</span></code> in parallel on all files that contain the path <code class="docutils literal notranslate"><span class="pre">Framework/Nexus/src/Nexus</span></code>.
One can also supply a single file (e.g. <code class="docutils literal notranslate"><span class="pre">Framework/Nexus/src/NexusFile.cpp</span></code>) or a single target (e.g. <code class="docutils literal notranslate"><span class="pre">NexusTest</span></code>) which will analyze all files that contribute to that target.
A notable limitation of the wrapper is that it needs a full path to the configuration file, but not to the source files.</p>
<p>To run a specific check and apply it</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>run-clang-tidy<span class="w"> </span>-config<span class="w"> </span><span class="s2">"{Checks: '-*,modernize-use-nullptr'}"</span><span class="w"> </span>-p<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="w"> </span>Framework/Nexus/src/NexusFile.cpp<span class="w"> </span>-fix
</pre></div>
</div>
<p>will automatically change the file in the source tree.</p>
</section>
<section id="options">
<h3>Options<a class="headerlink" href="#options" title="Link to this heading">#</a></h3>
<p>The full list of <a class="reference external" href="https://clang.llvm.org/extra/clang-tidy/checks/list.html">current clang-tidy checks</a>.</p>
<p>Some clang-tidy checks have optional arguments. For example, <code class="docutils literal notranslate"><span class="pre">modernize-loop-convert</span></code>, which changes loops to range-based,
assigns a riskiness to each loop and can accept a <code class="docutils literal notranslate"><span class="pre">MinConfidence</span></code> argument to determine which risk levels to address.</p>
<p>Adding the optional arguments is clunky and will rarely be required, so it has not been directly added to Mantid’s cmake setup.
To add optional arguments, add the following onto the end of <code class="docutils literal notranslate"><span class="pre">CLANG_TIDY_CHECKS</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span><span class="n">config</span><span class="o">=</span><span class="p">{</span><span class="n">CheckOptions</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">check</span><span class="o">-</span><span class="n">to</span><span class="o">-</span><span class="n">choose</span><span class="o">-</span><span class="n">option</span><span class="o">.</span><span class="n">option</span><span class="o">-</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">option</span><span class="o">-</span><span class="n">value</span><span class="p">}</span> <span class="p">]}</span>
</pre></div>
</div>
<p>For example, to convert all loops classified as <em>risky</em> or above, we would append:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span><span class="n">config</span><span class="o">=</span><span class="p">{</span><span class="n">CheckOptions</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">modernize</span><span class="o">-</span><span class="n">loop</span><span class="o">-</span><span class="n">convert</span><span class="o">.</span><span class="n">MinConfidence</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">risky</span><span class="p">}</span> <span class="p">]}</span>
</pre></div>
</div>
<p>clang-tidy does not have a concept of c++ standards it should use and leaves it to the developer to know which to turn on and off.</p>
</section>
</section>
<section id="cmake-chart-of-target-dependencies">
<h2>Cmake chart of target dependencies<a class="headerlink" href="#cmake-chart-of-target-dependencies" title="Link to this heading">#</a></h2>
<p>Cmake has the ability to make graphviz dot files of the dependencies for targets in mantid.
This is useful for understanding why compilation will wait for individual libraries to link before compiling more files.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cmake<span class="w"> </span>--graphviz<span class="o">=</span>dependencies.dot<span class="w"> </span>.
dot<span class="w"> </span>-O<span class="w"> </span>-Tsvg<span class="w"> </span>dependencies.dot.WorkflowAlgorithms
</pre></div>
</div>
<p><a class="reference external" href="https://cmake.org/cmake/help/latest/module/CMakeGraphVizOptions.html">Cmake reference</a> for configuring the tool options.</p>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="CodeCoverage.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Generating code coverage</p>
</div>
</a>
<a class="right-next"
href="AlgorithmProfiler.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Work flows algorithm profiling</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-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#creating-classes-class-maker-py">Creating classes: class_maker.py</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#moving-renaming-classes-move-class-py">Moving/Renaming classes: move_class.py</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#deleting-a-class-delete-class-py">Deleting a class: delete_class.py</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#profiling">Profiling</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#leak-checking-etc">Leak checking etc</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#linux">Linux</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#windows">Windows</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#thread-checking">Thread checking</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#helgrind-or-drd">Helgrind or drd</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#iwyu">IWYU</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#network-related-tools">Network Related Tools</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#wireshark">Wireshark</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#wonder-shaper">Wonder Shaper</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#clang-tidy">Clang-tidy</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#installing">Installing</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#visual-studio">Visual Studio</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#cmake">Cmake</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#command-line">Command line</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#options">Options</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#cmake-chart-of-target-dependencies">Cmake chart of target dependencies</a></li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div class="tocsection sourcelink">
<a href="_sources/ToolsOverview.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=a95f357e85573c9b56d5"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=a95f357e85573c9b56d5"></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.1.0.
<br/>
</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.19.0.
</p></div>
</div>
</div>
</footer>
</body>
</html>