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 Oct 26, 2023
1 parent 1f8ef98 commit 86d91ca
Show file tree
Hide file tree
Showing 7 changed files with 307 additions and 28 deletions.
38 changes: 13 additions & 25 deletions ProfilingOverview.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Profiling with perf" href="ProfilingWithPerf.html" />
<link rel="next" title="Mantid Timers" href="Timers.html" />
<link rel="prev" title="Work flows algorithm profiling" href="AlgorithmProfiler.html" />

<script>
Expand Down Expand Up @@ -112,13 +112,13 @@ <h3>Navigation</h3>
<li><p><a class="reference internal" href="#profiling-in-c" id="id4">Profiling in C++</a></p>
<ul>
<li><p><a class="reference internal" href="#mantid-s-algorithm-profiler" id="id5">Mantid’s Algorithm Profiler</a></p></li>
<li><p><a class="reference internal" href="#mantid-s-timer-class" id="id6">Mantid’s Timer class</a></p></li>
<li><p><a class="reference internal" href="#other-profiling-tools" id="id7">Other Profiling Tools</a></p>
<li><p><a class="reference internal" href="#other-profiling-tools" id="id6">Other Profiling Tools</a></p>
<ul>
<li><p><a class="reference internal" href="#linux" id="id8">Linux</a></p></li>
<li><p><a class="reference internal" href="#windows" id="id9">Windows</a></p></li>
<li><p><a class="reference internal" href="#linux" id="id7">Linux</a></p></li>
<li><p><a class="reference internal" href="#windows" id="id8">Windows</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#timing-in-c" id="id9">Timing in C++</a></p></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -158,26 +158,10 @@ <h2><a class="toc-backref" href="#id4" role="doc-backlink">Profiling in C++</a><
<h3><a class="toc-backref" href="#id5" role="doc-backlink">Mantid’s Algorithm Profiler</a><a class="headerlink" href="#mantid-s-algorithm-profiler" title="Link to this heading"></a></h3>
<p>On Linux, the build can be configured to generate algorithm profiling information. See <a class="reference internal" href="AlgorithmProfiler.html"><span class="doc">AlgorithmProfiler</span></a> for details.</p>
</section>
<section id="mantid-s-timer-class">
<h3><a class="toc-backref" href="#id6" role="doc-backlink">Mantid’s Timer class</a><a class="headerlink" href="#mantid-s-timer-class" title="Link to this heading"></a></h3>
<p><a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/Framework/Kernel/inc/MantidKernel/Timer.h">MantidKernel/Timer</a> allows for very quick measurements of time of suspect code.
It works on every operating system and does not require special compile flags.</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="n">Mantid</span><span class="o">::</span><span class="n">Kernel</span><span class="o">::</span><span class="n">Timer</span><span class="w"> </span><span class="nf">timer</span><span class="p">();</span>
<span class="c1">// do something expensive</span>
<span class="n">std</span><span class="o">::</span><span class="n">cout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;did step 1 in &quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">timer</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">;</span>
<span class="c1">// do something else expensive - the timer still accumulates</span>
<span class="n">std</span><span class="o">::</span><span class="n">cout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;did step 2 after &quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">timer</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot; from start</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">;</span>

<span class="n">timer</span><span class="p">.</span><span class="n">reset</span><span class="p">();</span><span class="w"> </span><span class="c1">// reset the timer to zero</span>
<span class="c1">// do something else</span>
<span class="n">std</span><span class="o">::</span><span class="n">cout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;step 3 took &quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">timer</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">;</span>
</pre></div>
</div>
</section>
<section id="other-profiling-tools">
<h3><a class="toc-backref" href="#id7" role="doc-backlink">Other Profiling Tools</a><a class="headerlink" href="#other-profiling-tools" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id6" role="doc-backlink">Other Profiling Tools</a><a class="headerlink" href="#other-profiling-tools" title="Link to this heading"></a></h3>
<section id="linux">
<span id="linux-1"></span><h4><a class="toc-backref" href="#id8" role="doc-backlink">Linux</a><a class="headerlink" href="#linux" title="Link to this heading"></a></h4>
<span id="linux-1"></span><h4><a class="toc-backref" href="#id7" role="doc-backlink">Linux</a><a class="headerlink" href="#linux" title="Link to this heading"></a></h4>
<p><a class="reference internal" href="ProfilingWithPerf.html"><span class="doc">Profiling with perf</span></a> for details on perf and intel’s vtune</p>
<p><a class="reference internal" href="ProfilingWithValgrind.html"><span class="doc">Profiling with Valgrind</span></a> for details on using this tool</p>
<p><a class="reference external" href="http://kcachegrind.sourceforge.net/cgi-bin/show.cgi/KcacheGrindIndex">Callgrind/KCachegrind</a></p>
Expand All @@ -194,14 +178,18 @@ <h3><a class="toc-backref" href="#id7" role="doc-backlink">Other Profiling Tools
<a class="reference external" href="http://www.pixelbeat.org/programming/profiling/">http://www.pixelbeat.org/programming/profiling/</a></p>
</section>
<section id="windows">
<span id="windows-1"></span><h4><a class="toc-backref" href="#id9" role="doc-backlink">Windows</a><a class="headerlink" href="#windows" title="Link to this heading"></a></h4>
<span id="windows-1"></span><h4><a class="toc-backref" href="#id8" role="doc-backlink">Windows</a><a class="headerlink" href="#windows" title="Link to this heading"></a></h4>
<p><a class="reference external" href="http://www.codersnotes.com/sleepy/">Very Sleepy</a>:</p>
<ul class="simple">
<li><p>Start/stop recording of program using a button</p></li>
<li><p>Not as detailed or flexible as callgrind</p></li>
</ul>
</section>
</section>
<section id="timing-in-c">
<h3><a class="toc-backref" href="#id9" role="doc-backlink">Timing in C++</a><a class="headerlink" href="#timing-in-c" title="Link to this heading"></a></h3>
<p>Please refer to <a class="reference internal" href="Timers.html"><span class="doc">Mantid Timers</span></a> for an introduction to measuring execution time of the Mantid C++ code.</p>
</section>
</section>
</section>

Expand All @@ -222,7 +210,7 @@ <h3><a class="toc-backref" href="#id7" role="doc-backlink">Other Profiling Tools
</a>
</li>
<li>
<a href="ProfilingWithPerf.html" title="Next Chapter: Profiling with perf"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Profiling with perf &raquo;</span>
<a href="Timers.html" title="Next Chapter: Mantid Timers"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Mantid Timers &raquo;</span>
</a>
</li>

Expand Down
4 changes: 2 additions & 2 deletions ProfilingWithPerf.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Profiling with Valgrind" href="ProfilingWithValgrind.html" />
<link rel="prev" title="Profiling Overview" href="ProfilingOverview.html" />
<link rel="prev" title="Mantid Timers" href="Timers.html" />

<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
Expand Down Expand Up @@ -191,7 +191,7 @@ <h1>Profiling with Intel’s VTune<a class="headerlink" href="#profiling-with-in


<li>
<a href="ProfilingOverview.html" title="Previous Chapter: Profiling Overview"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Profiling Overview</span>
<a href="Timers.html" title="Previous Chapter: Mantid Timers"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Mantid Timers</span>
</a>
</li>
<li>
Expand Down
14 changes: 14 additions & 0 deletions Standards/ReleaseNotesGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,20 @@ <h2><a class="toc-backref" href="#id11" role="doc-backlink">During release</a><a
</li>
</ul>
</li>
<li><p>Inelastic (Main Heading)</p>
<ul>
<li><p>New features</p></li>
<li><p>Bugfixes</p></li>
<li><p>Algorithms (Sub-heading)</p>
<blockquote>
<div><ul class="simple">
<li><p>New features</p></li>
<li><p>Bugfixes</p></li>
</ul>
</div></blockquote>
</li>
</ul>
</li>
<li><p>Mantid Workbench (Main Heading)</p>
<ul>
<li><p>New features</p></li>
Expand Down
Loading

0 comments on commit 86d91ca

Please sign in to comment.