You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -981,6 +976,11 @@ <h1>Git-Annex and DataLad within containers</h1>
981
976
<em>BIDS-Apps</em> on <em>DataLad</em>/<em>Git-annex</em>-managed datasets.</p>
982
977
</div>
983
978
<h2id="datalad-and-docker"><em>DataLad</em> and <em>Docker</em><aclass="headerlink" href="#datalad-and-docker" title="Permanent link">¶</a></h2>
979
+
<p>Apps may be able to identify if the input dataset is handled with
980
+
<ahref="https://www.datalad.org/"><em>DataLad</em></a> or <ahref="https://git-annex.branchable.com"><em>git-annex</em></a>, and pull down linked data that has not
981
+
been fetched yet.
982
+
One example of one such application is <em>MRIQC</em>, and all the examples
983
+
on this documentation page will refer to it.</p>
984
984
<p>When executing <em>MRIQC</em> within <em>Docker</em> on a <em>DataLad</em> dataset
985
985
(for instance, installed from <ahref="https://openneuro.org"><em>OpenNeuro</em></a>),
986
986
we will need to ensure the following settings are observed:</p>
@@ -990,25 +990,43 @@ <h2 id="datalad-and-docker"><em>DataLad</em> and <em>Docker</em><a class="header
990
990
<li>the uid who is <em>executing MRIQC</em> within the container must
991
991
have sufficient permissions to write in the tree.</li>
<p>If the uid is not correct, we will likely encounter the following error:</p>
993
+
<divclass="admonition tip">
994
+
<pclass="admonition-title">Check <em>ReproNim</em> if the suggestions here did not work</p>
995
+
<p>The actions suggested here are expected to work in most circumstances,
996
+
but your system may have specific circumstances that require additional
997
+
or alternative approaches.
998
+
For instance, <ahref="https://www.repronim.org/">the <em>ReproNim</em> project</a> maintains
999
+
<ahref="https://github.com/ReproNim/containers">ReproNim/containers</a>, a
1000
+
<em>DataLad</em> dataset with ready-to-use Singularity images for released <em>BIDS Apps</em>, <em>NeuroDesktop</em> applications,
1001
+
and other containers.
1002
+
Its <ahref="https://github.com/ReproNim/containers?tab=readme-ov-file#runnable-script"><code>README.md</code></a> guides through an approach via that dataset with <em>built-in</em> execution helper taking care about bind-mounts,
1003
+
proxying critical <em>Git</em> configuration and potentially executing <em>Singularity</em> images via <em>Docker</em> (e.g., under OSX).</p>
1004
+
<p>In the particular case of <em>MRIQC</em>, please consider updating (if necessary)
1005
+
and fetching the required data before execution and then
1006
+
add the <code>--no-datalad-get</code> argument to workaround issues with
1007
+
<em>DataLad</em>.</p>
1008
+
</div>
1009
+
<h3id="setting-a-regular-users-execution-uid">Setting a regular user's execution uid<aclass="headerlink" href="#setting-a-regular-users-execution-uid" title="Permanent link">¶</a></h3>
1010
+
<p>If the execution uid does not match the uid of the user who installed
1011
+
the <em>DataLad</em> dataset, we will likely encounter the following error
0 commit comments