Skip to content

Commit

Permalink
docs(master): Update docs of development line
Browse files Browse the repository at this point in the history
  • Loading branch information
nipreps-bot committed Jul 5, 2024
1 parent 1da5edd commit 29768ba
Show file tree
Hide file tree
Showing 14 changed files with 32 additions and 3 deletions.
Binary file modified master/api/sdcflows-workflows-apply-correction-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-apply-registration-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-fieldmap-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-fieldmap-2.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-fieldmap-3.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-pepolar-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-pepolar-2.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-syn-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-syn-2.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions master/api/sdcflows.config.html
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@ <h2>Other responsibilities<a class="headerlink" href="#other-responsibilities" t

<dl class="py attribute">
<dt class="sig sig-object py" id="sdcflows.config.environment.free_mem">
<span class="sig-name descname"><span class="pre">free_mem</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">11.2</span></em><a class="headerlink" href="#sdcflows.config.environment.free_mem" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">free_mem</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">11.1</span></em><a class="headerlink" href="#sdcflows.config.environment.free_mem" title="Link to this definition"></a></dt>
<dd><p>Free memory at start.</p>
</dd></dl>

Expand Down Expand Up @@ -659,7 +659,7 @@ <h2>Other responsibilities<a class="headerlink" href="#other-responsibilities" t

<dl class="py attribute">
<dt class="sig sig-object py" id="sdcflows.config.execution.run_uuid">
<span class="sig-name descname"><span class="pre">run_uuid</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'20240704-112639_22b7f099-188e-4b8f-b542-9daa4f09a6a6'</span></em><a class="headerlink" href="#sdcflows.config.execution.run_uuid" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">run_uuid</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'20240705-065830_5bb196f2-b3b4-40d7-b364-d63667af9d6f'</span></em><a class="headerlink" href="#sdcflows.config.execution.run_uuid" title="Link to this definition"></a></dt>
<dd><p>Unique identifier of this particular run.</p>
</dd></dl>

Expand Down
25 changes: 25 additions & 0 deletions master/changes.html
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,27 @@
<article role="main" id="furo-main-content">
<section id="what-s-new">
<h1>What’s new?<a class="headerlink" href="#what-s-new" title="Link to this heading"></a></h1>
<section id="july-04-2024">
<h2>2.10.0 (July 04, 2024)<a class="headerlink" href="#july-04-2024" title="Link to this heading"></a></h2>
<p>Feature release in the 2.10.x series.</p>
<p>The main change is a bugfix when fitting multi-level B-Splines to some
noisy fieldmaps.
The multi-level fitting, while being theoretically nice, does not really
bring anything immediately as we are not generally inverting the distortion.
In this release, the default fitting has been change to single-level B-Splines,
with a spacing similar to TOPUP’s defaults.</p>
<p>With thanks to Sunjae Shim (&#64;sjshim) for sharing Spiral-echo fieldmaps that
were failing prior the patch in #453.</p>
<section id="changes">
<h3>CHANGES<a class="headerlink" href="#changes" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>FIX: Revision of the B-Spline fitting code (#453)</p></li>
<li><p>FIX: Building Docker image on ARM64 devices (#449)</p></li>
<li><p>ENH: Improve plots in jupyter notebook (#452)</p></li>
<li><p>DOC: Fix <code class="docutils literal notranslate"><span class="pre">ValueError</span></code> in notebook’s output. (#450)</p></li>
</ul>
</section>
</section>
<section id="june-13-2024">
<h2>2.9.0 (June 13, 2024)<a class="headerlink" href="#june-13-2024" title="Link to this heading"></a></h2>
<p>Feature release in the 2.9.x series.</p>
Expand Down Expand Up @@ -1054,6 +1075,10 @@ <h3>0.1.0 (July 22, 2019)<a class="headerlink" href="#july-22-2019" title="Link
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">What’s new?</a><ul>
<li><a class="reference internal" href="#july-04-2024">2.10.0 (July 04, 2024)</a><ul>
<li><a class="reference internal" href="#changes">CHANGES</a></li>
</ul>
</li>
<li><a class="reference internal" href="#june-13-2024">2.9.0 (June 13, 2024)</a></li>
<li><a class="reference internal" href="#january-22-2024">2.8.1 (January 22, 2024)</a></li>
<li><a class="reference internal" href="#january-10-2024">2.8.0 (January 10, 2024)</a></li>
Expand Down
4 changes: 4 additions & 0 deletions master/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,10 @@ <h1>Contents<a class="headerlink" href="#contents" title="Link to this heading">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">What’s new?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changes.html#july-04-2024">2.10.0 (July 04, 2024)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changes.html#changes">CHANGES</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#june-13-2024">2.9.0 (June 13, 2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#january-22-2024">2.8.1 (January 22, 2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#january-10-2024">2.8.0 (January 10, 2024)</a></li>
Expand Down
Binary file modified master/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion master/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 29768ba

Please sign in to comment.