Skip to content

Commit

Permalink
Deployed 8203a89 with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Oct 31, 2024
1 parent 12afff9 commit 3d20be6
Show file tree
Hide file tree
Showing 473 changed files with 14,662 additions and 1,005 deletions.
20 changes: 10 additions & 10 deletions adding_software/building_software/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1998,8 +1998,8 @@

<h1 id="building-software">Building software<a class="headerlink" href="#building-software" title="Permanent link">&para;</a></h1>
<p><em>(for maintainers)</em></p>
<h3 id="bot_build">Instructing the bot to build <img alt="🔨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f528.svg" title=":hammer:" /><a class="headerlink" href="#bot_build" title="Permanent link">&para;</a></h3>
<p>Once the pull request is open, you can instruct the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f916.svg" title=":robot:" /></a> to build the software by posting a comment.</p>
<h3 id="bot_build">Instructing the bot to build <img alt="🔨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f528.svg" title=":hammer:" /><a class="headerlink" href="#bot_build" title="Permanent link">&para;</a></h3>
<p>Once the pull request is open, you can instruct the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f916.svg" title=":robot:" /></a> to build the software by posting a comment.</p>
<p>For more information, see the <a href="../../bot/#building">building section in the bot documentation</a>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
Expand All @@ -2019,22 +2019,22 @@ <h4 id="guidelines">Guidelines<a class="headerlink" href="#guidelines" title="Pe
<p>Make sure that the software has been built correctly for all <a href="../../software_layer/cpu_targets/">CPU targets</a> before you deploy!</p>
</li>
</ul>
<h4 id="checking-the-builds">Checking the builds <img alt="🔍" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f50d.svg" title=":mag:" /><a class="headerlink" href="#checking-the-builds" title="Permanent link">&para;</a></h4>
<p>If all goes well, you should see <code>SUCCESS</code> <img alt="😁" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f601.svg" title=":grin:" /> for each build, along with button <img alt="🔽" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f53d.svg" title=":arrow_down_small:" />
<h4 id="checking-the-builds">Checking the builds <img alt="🔍" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f50d.svg" title=":mag:" /><a class="headerlink" href="#checking-the-builds" title="Permanent link">&para;</a></h4>
<p>If all goes well, you should see <code>SUCCESS</code> <img alt="😁" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f601.svg" title=":grin:" /> for each build, along with button <img alt="🔽" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f53d.svg" title=":arrow_down_small:" />
to get more information about the checks that were performed, and metadata information on the resulting
artefact <img alt="📦" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f4e6.svg" title=":package:" />.</p>
artefact <img alt="📦" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f4e6.svg" title=":package:" />.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>Make sure the result is what you expect it to be for all builds before you deploy!</strong></p>
</div>
<h4 id="failing-builds">Failing builds <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/26d4.svg" title=":no_entry:" /><a class="headerlink" href="#failing-builds" title="Permanent link">&para;</a></h4>
<h4 id="failing-builds">Failing builds <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/26d4.svg" title=":no_entry:" /><a class="headerlink" href="#failing-builds" title="Permanent link">&para;</a></h4>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The bot will currently not give you any information on how or why a build is failing.</p>
<p>Ask for help in the <code>#software-layer</code> channel of the EESSI Slack if needed!</p>
</div>
<h3 id="instructing-the-bot-to-deploy">Instructing the bot to deploy <img alt="🚀" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f680.svg" title=":rocket:" /><a class="headerlink" href="#instructing-the-bot-to-deploy" title="Permanent link">&para;</a></h3>
<p>To make the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f916.svg" title=":robot:" /></a> deploy the successfully built software, you should
<h3 id="instructing-the-bot-to-deploy">Instructing the bot to deploy <img alt="🚀" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f680.svg" title=":rocket:" /><a class="headerlink" href="#instructing-the-bot-to-deploy" title="Permanent link">&para;</a></h3>
<p>To make the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f916.svg" title=":robot:" /></a> deploy the successfully built software, you should
issue the corresponding instruction to the bot.</p>
<p>For more information, see the <a href="../../bot/#deploying">deploying section in the bot documentation</a>.</p>
<div class="admonition warning">
Expand All @@ -2044,10 +2044,10 @@ <h3 id="instructing-the-bot-to-deploy">Instructing the bot to deploy <img alt="
</div>
<h3 id="merging-the-pull-request">Merging the pull request<a class="headerlink" href="#merging-the-pull-request" title="Permanent link">&para;</a></h3>
<p>You should be able to verify in the pull request that the ingestion has been done,
since the CI should fail <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/274c.svg" title=":x:" /> initially to indicate that some software installations listed in
since the CI should fail <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg" title=":x:" /> initially to indicate that some software installations listed in
your modified easystack are missing.</p>
<p>Once the ingestion has been done, simply re-triggering the CI workflow should be sufficient to make it pass
<img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/2705.svg" title=":white_check_mark:" />, and then the pull request can be merged.</p>
<img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg" title=":white_check_mark:" />, and then the pull request can be merged.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This assumes that the easystack file being modified is considered by the CI workflow file
Expand Down
2 changes: 1 addition & 1 deletion adding_software/contribution_policy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2127,7 +2127,7 @@ <h3 id="freely_redistributable_software">i) Freely redistributable software<a cl
</div>
<hr />
<h3 id="built_by_bot">ii) Built by the bot<a class="headerlink" href="#built_by_bot" title="Permanent link">&para;</a></h3>
<p>All software included in the EESSI repository <em>must</em> be <strong>built autonomously</strong> by <a href="../../bot/">our bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f916.svg" title=":robot:" /></a>.</p>
<p>All software included in the EESSI repository <em>must</em> be <strong>built autonomously</strong> by <a href="../../bot/">our bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f916.svg" title=":robot:" /></a>.</p>
<p>For more information, see our <a href="../building_software/">semi-automatic software installation procedure</a>.</p>
<hr />
<h3 id="easybuild">iii) Built and installed with EasyBuild<a class="headerlink" href="#easybuild" title="Permanent link">&para;</a></h3>
Expand Down
8 changes: 4 additions & 4 deletions adding_software/deploying_software/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1914,8 +1914,8 @@

<h1 id="deploying-software">Deploying software<a class="headerlink" href="#deploying-software" title="Permanent link">&para;</a></h1>
<p><em>(for maintainers)</em></p>
<h3 id="instructing-the-bot-to-deploy">Instructing the bot to deploy <img alt="🚀" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f680.svg" title=":rocket:" /><a class="headerlink" href="#instructing-the-bot-to-deploy" title="Permanent link">&para;</a></h3>
<p>To make the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f916.svg" title=":robot:" /></a> deploy the successfully built software, you should
<h3 id="instructing-the-bot-to-deploy">Instructing the bot to deploy <img alt="🚀" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f680.svg" title=":rocket:" /><a class="headerlink" href="#instructing-the-bot-to-deploy" title="Permanent link">&para;</a></h3>
<p>To make the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f916.svg" title=":robot:" /></a> deploy the successfully built software, you should
issue the corresponding instruction to the bot.</p>
<p>For more information, see the <a href="../../bot/#deploying">deploying section in the bot documentation</a>.</p>
<div class="admonition warning">
Expand All @@ -1925,10 +1925,10 @@ <h3 id="instructing-the-bot-to-deploy">Instructing the bot to deploy <img alt="
</div>
<h3 id="merging-the-pull-request">Merging the pull request<a class="headerlink" href="#merging-the-pull-request" title="Permanent link">&para;</a></h3>
<p>You should be able to verify in the pull request that the ingestion has been done,
since the CI should fail <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/274c.svg" title=":x:" /> initially to indicate that some software installations listed in
since the CI should fail <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg" title=":x:" /> initially to indicate that some software installations listed in
your modified easystack are missing.</p>
<p>Once the ingestion has been done, simply re-triggering the CI workflow should be sufficient to make it pass
<img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/2705.svg" title=":white_check_mark:" />, and then the pull request can be merged.</p>
<img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg" title=":white_check_mark:" />, and then the pull request can be merged.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This assumes that the easystack file being modified is considered by the CI workflow file
Expand Down
18 changes: 9 additions & 9 deletions adding_software/opening_pr/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1917,11 +1917,11 @@ <h1 id="opening-a-pull-request">Opening a pull request<a class="headerlink" href
<p>To add software to EESSI, you should go through the semi-automatic software installation procedure by:</p>
<ul>
<li>1) Making a pull request to the <a href="https://github.com/EESSI/software-layer">software-layer</a> repository
to (add or) update an <a href="https://docs.easybuild.io/easystack-files">easystack file</a> <img alt="📚" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f4da.svg" title=":books:" /> that is used by
to (add or) update an <a href="https://docs.easybuild.io/easystack-files">easystack file</a> <img alt="📚" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f4da.svg" title=":books:" /> that is used by
<a href="https://docs.easybuild.io/">EasyBuild</a> to install software;</li>
<li>2) Instructing the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f916.svg" title=":robot:" /></a> to build the software on all <a href="../../software_layer/cpu_targets/">supported CPU microarchitectures</a>;</li>
<li>3) Instructing the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f916.svg" title=":robot:" /></a> to deploy the built software for ingestion into the EESSI repository;</li>
<li>4) Merging the pull request once CI indicates that the software has been ingested. <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/2705.svg" title=":white_check_mark:" /></li>
<li>2) Instructing the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f916.svg" title=":robot:" /></a> to build the software on all <a href="../../software_layer/cpu_targets/">supported CPU microarchitectures</a>;</li>
<li>3) Instructing the <a href="../../bot/">bot <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f916.svg" title=":robot:" /></a> to deploy the built software for ingestion into the EESSI repository;</li>
<li>4) Merging the pull request once CI indicates that the software has been ingested. <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg" title=":white_check_mark:" /></li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
Expand All @@ -1930,18 +1930,18 @@ <h1 id="opening-a-pull-request">Opening a pull request<a class="headerlink" href
<h3 id="preparation">Preparation<a class="headerlink" href="#preparation" title="Permanent link">&para;</a></h3>
<p>Before you can make a pull request to the <a href="https://github.com/EESSI/software-layer">software-layer</a>,
you should <a href="https://docs.github.com/en/get-started/quickstart/fork-a-repo">fork</a> the repository in your GitHub account.</p>
<p>For the remainder of these instructions, we assume that your GitHub account is <code>@koala</code> <img alt="🐨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f428.svg" title=":koala:" />.</p>
<p>For the remainder of these instructions, we assume that your GitHub account is <code>@koala</code> <img alt="🐨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f428.svg" title=":koala:" />.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Don't forget to replace <code>koala</code> <img alt="🐨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f428.svg" title=":koala:" /> with the name of your GitHub account in the commands below!</p>
<p>Don't forget to replace <code>koala</code> <img alt="🐨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f428.svg" title=":koala:" /> with the name of your GitHub account in the commands below!</p>
</div>
<p>1) Clone the <a href="https://github.com/EESSI/software-layer">EESSI/software-layer</a> repository:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>mkdir EESSI
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>cd EESSI
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>git clone https://github.com/EESSI/software-layer
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>cd software-layer
</code></pre></div>
<p>2) Add your fork <img alt="🐨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f428.svg" title=":koala:" /> as a <a href="https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories">remote</a></p>
<p>2) Add your fork <img alt="🐨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f428.svg" title=":koala:" /> as a <a href="https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories">remote</a></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>git remote add koala [email protected]:koala/software-layer.git
</code></pre></div>
<p>3) Check out the branch that corresponds to the version of EESSI repository you want to add software to,
Expand Down Expand Up @@ -1971,14 +1971,14 @@ <h3 id="software_layer_pull_request">Creating a pull request<a class="headerlink
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>git<span class="w"> </span>add<span class="w"> </span>easystacks/software.eessi.io/2023.06/eessi-2023.06-eb-4.8.2-2023a.yml
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;{2023.06}[GCC/12.3.0] example 1.2.3&quot;</span>
</code></pre></div>
<p>5) Push your branch to your fork <img alt="🐨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f428.svg" title=":koala:" /> of the <a href="https://github.com/EESSI/software-layer">software-layer</a> repository</p>
<p>5) Push your branch to your fork <img alt="🐨" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f428.svg" title=":koala:" /> of the <a href="https://github.com/EESSI/software-layer">software-layer</a> repository</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>git<span class="w"> </span>push<span class="w"> </span>koala<span class="w"> </span>example_branch
</code></pre></div>
<p>6) Go to the <a href="https://github.com/EESSI/software-layer">GitHub web interface</a> to open your pull request,
or use the helpful link that should show up in the output of the <code>git push</code> command.</p>
<p><strong>Make sure you target the correct branch</strong>: the one that corresponds to the version of EESSI you want to add
software to (like <code>2023.06-software.eessi.io</code>).</p>
<p>If all goes well, one or more bots <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f916.svg" title=":robot:" /> should almost instantly create a comment in your pull request
<p>If all goes well, one or more bots <img alt="🤖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f916.svg" title=":robot:" /> should almost instantly create a comment in your pull request
with an overview of how it is configured - you will need this information when providing build instructions.</p>
<h3 id="rebuilding_software">Rebuilding software<a class="headerlink" href="#rebuilding_software" title="Permanent link">&para;</a></h3>
<p>We typically do not rebuild software, since (strictly speaking) this breaks reproducibility for anyone using the software. However, there are certain situations in which it is difficult or impossible to avoid.</p>
Expand Down
2 changes: 1 addition & 1 deletion available_software/data/json_data.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion available_software/data/json_data_detail.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion available_software/detail/ALL/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1814,7 +1814,7 @@ <h1 id="available-modules">Available modules<a class="headerlink" href="#availab
<p>To start using ALL, load one of these modules using a <code>module load</code> command like:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>module<span class="w"> </span>load<span class="w"> </span>ALL/0.9.2-foss-2023a
</code></pre></div>
<p><em>(This data was automatically generated on Fri, 18 Oct 2024 at 01:38:43 UTC)</em> </p>
<p><em>(This data was automatically generated on Wed, 30 Oct 2024 at 01:41:16 UTC)</em> </p>
<table>
<thead>
<tr>
Expand Down
Loading

0 comments on commit 3d20be6

Please sign in to comment.