Deployed 11e8925 with MkDocs version: 1.6.1

Author: klust

2025-LUST/2_Using/2_02_creating_easyconfig_files/index.html

@@ -755,6 +755,15 @@
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#toolchain-options" class="md-nav__link">
+    <span class="md-ellipsis">
+      Toolchain options
+    </span>
+  </a>
+  
 </li>
 
           <li class="md-nav__item">
@@ -4928,6 +4937,15 @@
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#toolchain-options" class="md-nav__link">
+    <span class="md-ellipsis">
+      Toolchain options
+    </span>
+  </a>
+  
 </li>
 
           <li class="md-nav__item">
@@ -5312,6 +5330,53 @@ <h4 id="easyblock">Easyblock<a class="headerlink" href="#easyblock" title="Perma
 tar_config_opts*<span class="w">                </span>Override<span class="w"> </span>tar<span class="w"> </span>settings<span class="w"> </span>as<span class="w"> </span>determined<span class="w"> </span>by<span class="w"> </span>configure.<span class="w"> </span><span class="o">[</span>default:<span class="w"> </span>False<span class="o">]</span>
 test_cmd*<span class="w">                       </span>Test<span class="w"> </span><span class="nb">command</span><span class="w"> </span>to<span class="w"> </span>use<span class="w"> </span><span class="o">(</span><span class="s1">&#39;runtest&#39;</span><span class="w"> </span>value<span class="w"> </span>is<span class="w"> </span>appended,<span class="w"> </span>default:<span class="w"> </span><span class="s1">&#39;make&#39;</span><span class="o">)</span><span class="w"> </span><span class="o">[</span>default:<span class="w"> </span>None<span class="o">]</span>
 </code></pre></div>
+<h4 id="toolchain-options">Toolchain options<a class="headerlink" href="#toolchain-options" title="Permanent link">&para;</a></h4>
+<p>Many toolchain options can be set through <code>toolchainopts</code>, e.g.,</p>
+<div class="highlight"><pre><span></span><code>toolchainopts = {&#39;usempi&#39;: False, &#39;openmp&#39;: False, &#39;extra_cxxflags&#39;: &#39;-std=c++11&#39;}
+</code></pre></div>
+<p>The range of options depends on the toolchain. For the toolchains on LUMI, more information
+can be found in the subsections of "Toolchain documentation" of the 
+<a href="https://lumi-supercomputer.github.io/LUMI-SoftwareStack/">"Docs for the LUMI software stack</a>.
+For regular EasyBuild toolchains, they can be found in the
+<a href="https://docs.easybuild.io/version-specific/toolchain-opts/">"Available toolchain options" page in the EasyBuild docs</a>.</p>
+<p>Some common options are:</p>
+<ul>
+<li>
+<p><code>usempi</code>: When set to <code>True</code>, environment variables for regular compilers such as CC etc. will 
+    point to the MPI wrappers. This setting has currently no effect on LUMI as there are no separate
+    wrappers when using the Cray wrappers.</p>
+<p>We could consider unloading the <code>cray-mpich</code> module though if the value is set explicitly to <code>False</code>.</p>
+</li>
+<li>
+<p><code>openmp</code>: Enable OpenMP. When set to <code>True</code>, this option will make sure that the option to enable OpenMP
+    is added to <code>CFLAGS</code> and other environment variables that set compiler flags.</p>
+<p>EasyBuild currently cannot add this to <code>LDFLAGS</code> which may be an issue when linking as whether or not 
+<code>-fopenmp</code> is used at link time, determines if the single-threaded or multithreaded version of some
+libraries will be used (and in particular LibSci). (TODO: This may have changed in some very recent
+versions of EasyBuild.)</p>
+</li>
+<li>
+<p><code>pic</code>: When set to <code>True</code>, position-independent code will be enabled. Rarely really needed as configure
+    scripts usually set this automatically when creating shared libraries.</p>
+</li>
+<li>
+<p><code>cstd</code>: Set the C/C++ standard version. One of the least useful options as it does not distinguish between
+    C and C++, causing issues when packages are installed that use both C and C++.</p>
+</li>
+<li>
+<p><code>verbose</code>: Sets a compiler flag that may generate more verbose output.</p>
+</li>
+<li>
+<p><code>extra_cflags</code>, <code>extra_cxxflags</code>, <code>extra_f90flags</code>, <code>extra_fcflags</code>, <code>extra_fflags</code>: Add extra compiler
+    flags to the corresponding environment variables.</p>
+</li>
+</ul>
+<p>There are also flags that influence the level of compiler optimisation and the floating point behaviour of 
+the compiler. They are confusing as there are separate settings of which only one of each type should be used,
+and floating point computing flags are not supported by all LUMI toolchains at the moment.</p>
+<p>It is possible to request an overview of all options for a particular toolchain using</p>
+<div class="highlight"><pre><span></span><code>eb --avail-toolchain-opts &lt;tcname&gt;
+</code></pre></div>
 <h4 id="sources-patches-and-checksums">Sources, patches, and checksums<a class="headerlink" href="#sources-patches-and-checksums" title="Permanent link">&para;</a></h4>
 <p>In most easyconfig files you will see that a list of source files is specified via the <code>sources</code>
 easyconfig parameter, usually combined
@@ -5998,7 +6063,7 @@ <h2 id="exercises">Exercises<a class="headerlink" href="#exercises" title="Perma
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="May 6, 2025 15:20:25">May 6, 2025</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="May 26, 2025 11:32:05">May 26, 2025</span>
   </span>
 
 

2025-LUST/4_EasyBuild_on_LUMI/4_02_tips_and_tricks/index.html

@@ -1027,6 +1027,15 @@
     </span>
   </a>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#adding-license-information" class="md-nav__link">
+    <span class="md-ellipsis">
+      Adding license information
+    </span>
+  </a>
+  
 </li>
 
         <li class="md-nav__item">
@@ -4626,6 +4635,15 @@
     </span>
   </a>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#adding-license-information" class="md-nav__link">
+    <span class="md-ellipsis">
+      Adding license information
+    </span>
+  </a>
+  
 </li>
 
         <li class="md-nav__item">
@@ -4677,13 +4695,60 @@ <h2 id="long-lists-of-elements-for-preconfigopts-or-options-for-configopts">Long
 elegant, makes it very easy to add additional flags or commands, and is less error-prone.
 There is also plenty of space left on each line to explain why an option is used or what it
 means, to make the job easier for others who may want to update or customise this EasyConfig.</p>
+<h2 id="adding-license-information">Adding license information<a class="headerlink" href="#adding-license-information" title="Permanent link">&para;</a></h2>
+<p>EasyBuild has an EasyConfig parameter for that but it is rarely used in the regular EasyBuild repositories:</p>
+<div class="highlight"><pre><span></span><code>software_license_urls = [
+    f&#39;https://bitbucket.org/multicoreware/x265_git/src/{version}/COPYING&#39;,
+]
+</code></pre></div>
+<p>One issue is that currently in our module scheme, it does nothing as the information is not being added to
+the module.</p>
+<p>We recently also started copying license information, etc., found in the sources of a package into 
+<code>%(installdir)s/share/licenses/&lt;name_of_package&gt;</code> where for a bundle we use the name of each of the 
+packages in the bundle for <code>&lt;name_of_package&gt;</code>. This is often easily done in <code>postinstallcmds</code> though 
+for Bundle components it is easier to do so via <code>installopts</code> (adding the commands with the <code>&amp;&amp;</code> trick)
+as there are no separate <code>postinstallcmds</code> for each Bundle component (at least, last time I tested those
+did not work properly).</p>
+<p>Some code fragments:</p>
+<ul>
+<li>
+<p>For software built with the <code>ConfigureMake</code> EasyBlock: As the build commands run in the sources directly,
+    this will often work (but you may need to adapt the name of the files to copy):</p>
+<div class="highlight"><pre><span></span><code>postinstallcmds = [
+    &#39;mkdir -p %(installdir)s/share/licenses/%(name)s&#39;,
+    &#39;cp COPYING %(installdir)s/share/licenses/%(name)s&#39;,   
+]
+</code></pre></div>
+</li>
+<li>
+<p>With the <code>CMakeMake</code> EasyBlock, the build process runs in a separate directory, so you'll have to move
+    to sources directory to copy:</p>
+<div class="highlight"><pre><span></span><code>postinstallcmds = [
+    &#39;mkdir -p %(installdir)s/share/licenses/%(name)s&#39;,
+    &#39;cd ../%(namelower)s-%(version)s &amp;&amp; cp AUTHORS CHANGELOG.md LICENSE.txt README.md README.SZIP THANKS %(installdir)s/share/licenses/%(name)s&#39;,   
+]
+</code></pre></div>
+<p>The <code>%(namelower)s-%(version)s</code> does not work for all software, you may have to check! E.g., you can just start EasyBuild but
+stop after the Prepare step with <code>--stop prepare</code> to inspect the sources.</p>
+</li>
+<li>
+<p>The next one has worked for some <code>MesonNinja</code> software:</p>
+<div class="highlight"><pre><span></span><code>postinstallcmds = [
+    &#39;mkdir -p %(installdir)s/share/licenses/%(name)s&#39;,
+    &#39;cd %(start_dir)s &amp;&amp; cp AUTHORS CHANGELOG.md LICENSE.txt README.md README.SZIP THANKS %(installdir)s/share/licenses/%(name)s&#39;,   
+]
+</code></pre></div>
+</li>
+</ul>
 <h2 id="more-to-follow">More to follow....<a class="headerlink" href="#more-to-follow" title="Permanent link">&para;</a></h2>
 <ul>
 <li>
 <p>Static and shared libraries in CMakeMake packages (and using lib instead of lib64)</p>
 </li>
 <li>
-<p>Copying the license information</p>
+<p>Fix Python shebang lines: EasyConfig parameter <code>fix_python_shebang_for</code>.  See the EasyConfigs for GLib.</p>
+<p>NOTE: There is currently only python3 on LUMI so this does not work as it should... So the GLib EasyConfigs for 24.03
+are wrong and will need a different trick.</p>
 </li>
 </ul>
 <p><em><a href="../../5_00_additional_reading/">[Next: Additional reading]</a></em></p>
@@ -4707,7 +4772,7 @@ <h2 id="more-to-follow">More to follow....<a class="headerlink" href="#more-to-f
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="May 23, 2025 15:04:36">May 23, 2025</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="May 26, 2025 12:10:59">May 26, 2025</span>
   </span>