Skip to content

Commit

Permalink
fixes to release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
KrisThielemans committed Jul 23, 2024
1 parent c0b10eb commit bbcdf58
Showing 1 changed file with 22 additions and 27 deletions.
49 changes: 22 additions & 27 deletions documentation/release_6.2.htm
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@
<h1>Summary of changes in STIR release 6.2</h1>

<p>
This version is 100% backwards compatible with STIR 6.1, aside from the default of the
tail-fitting of the scatter estimator (see below). However, C++-17 is now required.
This version is 100% backwards compatible with STIR 6.1, aside from a bug fix for
the blocks-on-cylindrical set-up which caused the wrong geometry, and a changed
default of the tail-fitting of the scatter estimator (see below). However,
C++-17 is now required.
</p>

<h2>Overall summary</h2>
<p>

Main new features are the capability to mash TOF bins (via <tt>SSRB</tt> utility/code)
and a CUDA version of the Relative Difference Prior. There are also some
import bug fixes, as well as some speed-up (hopefully) in the use of arrays.
</p>

<p>
Expand All @@ -29,15 +33,9 @@ <h2>Overall summary</h2>
<h2>Patch release info</h2>
<ul>
<li>
6.2.0 released ??/2024<br>
6.2.0 released 24/07/2024<br>
<a href="https://github.com/UCL/STIR/milestone/11">GitHub Milestone 6.2</a>
</li>
<!--
<li> 4.0.1 released 28/04/2020
<ul>
<li><a href=https://github.com/UCL/STIR/pull/513>PR 513</a> (suppress warnings with clang)</li>
</ul>
-->
</ul>

<h2> Summary for end users (also to be read by developers)</h2>
Expand All @@ -56,7 +54,7 @@ <h3>New functionality</h3>
New prior <code>CudaRelativeDifferencePrior</code> (use <tt>Cuda Relative Difference Prior</tt> in <tt>.par</tt> files), only
available if the CUDA toolkit is found during building. Results are identical to <code>RelativeDifferencePrior</code>
up to numerical rounding issues. However, the code is currently limited to 3x3x3 weights.<br>
Added timings for the RDP (both non-CUDA and CUDA) tothe <tt>stir_timings</tt> utility.<br>
Added timings for the RDP (both non-CUDA and CUDA) to the <tt>stir_timings</tt> utility.<br>
<a href=https://github.com/UCL/STIR/pull/1408>PR #1408</a>
</li>
</ul>
Expand All @@ -70,7 +68,7 @@ <h3>Changed functionality</h3>
(see <a href=https://github.com/UCL/STIR/issues/1280>issue #1280</a>.<br>
<strong>WARNING:</strong><i>This potentially changes your scatter estimates</i>. (You can check log files
of the scatter estimation to see what the scaling factors are.) However,
the Siemens mMR example files already lowered the default scale factor to .1, so if you used
the Siemens mMR example files already lowered the default scale factor to .1, so if you use(d)
those, you will get identical results.
</li>
<li>
Expand Down Expand Up @@ -135,6 +133,15 @@ <h3>Build system</h3>
<li>
C++-17 is now required.
</li>
<li>
Force C++ version according to CERN ROOT versions: ROOT 6.28.10 needs C++17 and 6.30.2 needs C++20.
Also some fixes when relying on <code>root-config</code>.
</li>
<li>
Optionally enable CUDA as a CMake language (for the CUDA RDP). <strong>You should use CMake 3.23 or later</strong>
if you use CUDA. If you have the CUDA Toolkit but an old version of CMake that you cannot update,
you will have to set <tt>DISABLE_STIR_CUDA</tt> to <tt>ON</tt>.
</li>
</ul>

<h3>Known problems</h3>
Expand Down Expand Up @@ -175,7 +182,7 @@ <h3>Other code changes</h3>
Fixed an incompatibility with C++20.
</li>
<li>
Enabled OpenMP for <code>Array</code> members <code>find_max(), find_min(), sum(), sum_positivie()</code>.
Enabled OpenMP for <code>Array</code> members <code>find_max(), find_min(), sum(), sum_positive()</code>.
<br>
<a href=https://github.com/UCL/STIR/pull/1449>PR #1449</a>.
</li>
Expand All @@ -184,18 +191,6 @@ <h3>Other code changes</h3>
</li>
</ul>

<h3>Build system</h3>
<ul>
<li>
Force C++ version according to CERN ROOT versions: ROOT 6.28.10 needs C++17 and 6.30.2 needs C++20.
Also some fixes when relying on <code>root-config</code>.
</li>
<li>
Optionally enable CUDA as a CMake language (for the CUDA RDP). <strong>You should use CMake 3.23 or later</strong>
if you use CUDA.
</li>
</ul>

<h3>Test changes</h3>

<h4>C++ tests</h4>
Expand All @@ -210,8 +205,8 @@ <h4>C++ tests</h4>
<h4>recon_test_pack</h4>
<ul>
<li>
The output of <tt>simulate_PET_data_for_tests.sh</tt> can now varied by setting environment variables, e.g.
<code>max_rd</code>.
The output of <tt>simulate_PET_data_for_tests.sh</tt> can now be varied by setting environment variables, e.g.
<code>max_rd</code>. (Do not forget to unset those variables afterwards!)
</li>
<li>
New test <tt>run_test_SSRB.sh</tt>
Expand Down

0 comments on commit bbcdf58

Please sign in to comment.