build based on 7243fb7

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-31T02:26:54","documenter_version":"1.4.1"}}
+{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-31T09:26:03","documenter_version":"1.4.1"}}

dev/getting-started/index.html

@@ -63,4 +63,4 @@
     startOnLoad: true,
     theme: "neutral"
 });
-</script></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../guides/authentication/">Authentication »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 31 May 2024 02:26">Friday 31 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</script></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../guides/authentication/">Authentication »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 31 May 2024 09:26">Friday 31 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/guides/authentication/index.html

@@ -8,4 +8,4 @@
     startOnLoad: true,
     theme: "neutral"
 });
-</script></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../getting-started/">« Getting Started</a><a class="docs-footer-nextpage" href="../datasets/">Datasets »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 31 May 2024 02:26">Friday 31 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</script></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../getting-started/">« Getting Started</a><a class="docs-footer-nextpage" href="../datasets/">Datasets »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 31 May 2024 09:26">Friday 31 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/guides/datasets/index.html

@@ -107,4 +107,4 @@
     startOnLoad: true,
     theme: "neutral"
 });
-</script></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../authentication/">« Authentication</a><a class="docs-footer-nextpage" href="../jobs/">Jobs »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 31 May 2024 02:26">Friday 31 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</script></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../authentication/">« Authentication</a><a class="docs-footer-nextpage" href="../jobs/">Jobs »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 31 May 2024 09:26">Friday 31 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/guides/jobs/index.html

@@ -28,7 +28,7 @@
 &quot;&quot;&quot;noenv</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi"><span class="sgr1">JuliaHub.BatchJob:</span>
 code = &quot;&quot;&quot;
 @warn &quot;Hello World!&quot;
-&quot;&quot;&quot;</code></pre><p>With the <a href="../../reference/job-submission/#JuliaHub.script"><code>script</code></a> function, you can also specify a path to directory containing the Julia package environment, if necessary.</p><p>If an environment is passed with the job, it gets instantiated on the JuliaHub node, and the script is run in that environment. As such, any packages that are not available in the package registries or added via public Git URLs will not work. If that is the case, <a href="#jobs-batch-appbundles">appbundles</a> can be used instead to submit jobs that include private or local dependencies.</p><h3 id="jobs-batch-appbundles"><a class="docs-heading-anchor" href="#jobs-batch-appbundles">Appbundles</a><a id="jobs-batch-appbundles-1"></a><a class="docs-heading-anchor-permalink" href="#jobs-batch-appbundles" title="Permalink"></a></h3><p>A more advanced way of submitting a batch job is as an <em>appbundle</em>, which &quot;bundles up&quot; a whole directory and submits it together with the script. The Julia environment in the directory is also immediately added into the bundle.</p><p>An appbundle can be constructed with the <a href="../../reference/job-submission/#JuliaHub.appbundle"><code>appbundle</code></a> function, which takes as arguments the path to the directory to be bundled up, and a script <em>within that directory</em>. This is meant to be used for project directories where you have your Julia environment in the top level of the directory or repository. For example, you can submit an bundle from a submit script on the top level of your project directory as follows:</p><pre><code class="language-julia hljs">JuliaHub.submit_job(
+&quot;&quot;&quot;</code></pre><p>With the <a href="../../reference/job-submission/#JuliaHub.script"><code>script</code></a> function, you can also specify a path to directory containing the Julia package environment, if necessary.</p><p>If an environment is passed with the job, it gets instantiated on the JuliaHub node, and the script is run in that environment. As such, any packages that are not available in the package registries or added via public Git URLs will not work. If that is the case, <a href="#jobs-batch-appbundles">appbundles</a> can be used instead to submit jobs that include private or local dependencies.</p><h3 id="jobs-batch-appbundles"><a class="docs-heading-anchor" href="#jobs-batch-appbundles">Appbundles</a><a id="jobs-batch-appbundles-1"></a><a class="docs-heading-anchor-permalink" href="#jobs-batch-appbundles" title="Permalink"></a></h3><p>A more advanced way of submitting a batch job is as an <em>appbundle</em>, which &quot;bundles up&quot; a whole directory and submits it together with the script. The Julia environment in the directory is also immediately added into the bundle.</p><p>An appbundle can be constructed with the <a href="../../reference/job-submission/#JuliaHub.appbundle"><code>appbundle</code></a> function, which takes as arguments the path to the directory to be bundled up, and a script <em>within that directory</em>. This is meant to be used for project directories where you have your Julia environment in the top level of the directory or repository.</p><p>For example, suppose you have a script at the top level of your project directory, then you can submit a bundle as follows:</p><pre><code class="language-julia hljs">JuliaHub.submit_job(
     JuliaHub.appbundle(@__DIR__, &quot;script.jl&quot;),
     ncpu = 4, memory = 16,
 )</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi"><span class="sgr1">JuliaHub.Job</span>: jr-xf4tslavut (Completed)
@@ -40,7 +40,7 @@
   - code.jl (source; 3 bytes)
   - Project.toml (project; 244 bytes)
   - Manifest.toml (project; 9056 bytes)
- outputs: &quot;{}&quot;</code></pre><p>The bundler looks for a Julia environment (i.e. <code>Project.toml</code>, <code>Manifest.toml</code>, and/or <code>Artifacts.toml</code> files) at the root of the directory. If the environment does not exist (i.e. the files are missing), one is created. When the job starts on JuliaHub, this environment is instantiated.</p><p>A key feature of the appbundle is that development dependencies of the environment (i.e. packages added with <code>pkg&gt; develop</code> or <code>Pkg.develop()</code>) are also bundled up into the archive that gets submitted to JuliaHub (including any current, uncommitted changes). Registered packages are installed via the package manager via the standard environment instantiation, and their source code is not included in the bundle directly.</p><p>When the JuliaHub job starts, the bundle is unpacked into the <code>appbundle/</code> directory (relative to the starting working directory). E.g. if you have a <code>mydata.dat</code> file in the bundled directory, you can access it in the script at <code>joinpath(&quot;appbundle&quot;, &quot;mydata.dat&quot;)</code>.</p><p>Finally, a <code>.juliabundleignore</code> file can be used to exclude certain directories, by adding the relevant <a href="https://en.wikipedia.org/wiki/Glob_(programming)">globs</a>, similar to how <code>.gitignore</code> files work. In addition, <code>.git</code> directories are also automatically excluded from the bundle.</p><h3 id="Examining-job-configuration"><a class="docs-heading-anchor" href="#Examining-job-configuration">Examining job configuration</a><a id="Examining-job-configuration-1"></a><a class="docs-heading-anchor-permalink" href="#Examining-job-configuration" title="Permalink"></a></h3><p>The <code>dryrun</code> option to <a href="../../reference/job-submission/#JuliaHub.submit_job"><code>submit_job</code></a> can be used to inspect the full job workload configuration that would be submitted to JuliaHub.</p><pre><code class="language-julia hljs">JuliaHub.submit_job(
+ outputs: &quot;{}&quot;</code></pre><p>The bundler looks for a Julia environment (i.e. <code>Project.toml</code>, <code>Manifest.toml</code>, and/or <code>Artifacts.toml</code> files) at the root of the directory. If the environment does not exist (i.e. the files are missing), one is created. When the job starts on JuliaHub, this environment is instantiated.</p><p>A key feature of the appbundle is that development dependencies of the environment (i.e. packages added with <code>pkg&gt; develop</code> or <code>Pkg.develop()</code>) are also bundled up into the archive that gets submitted to JuliaHub (including any current, uncommitted changes). Registered packages are installed via the package manager via the standard environment instantiation, and their source code is not included in the bundle directly.</p><p>When the JuliaHub job starts, the working directory is set to the root of the unpacked appbundle directory. This should be kept in mind especially when launching a script that is not at the root itself, and trying to open other files from the appbundle in that script (e.g. with <code>open</code>). You can still use <code>@__DIR__</code> to load files relative to the script, and <code>include</code>s also work as expected (i.e. relative to the script file).</p><p>Finally, a <code>.juliabundleignore</code> file can be used to exclude certain directories, by adding the relevant <a href="https://en.wikipedia.org/wiki/Glob_(programming)">globs</a>, similar to how <code>.gitignore</code> files work. In addition, <code>.git</code> directories are also automatically excluded from the bundle.</p><h3 id="Examining-job-configuration"><a class="docs-heading-anchor" href="#Examining-job-configuration">Examining job configuration</a><a id="Examining-job-configuration-1"></a><a class="docs-heading-anchor-permalink" href="#Examining-job-configuration" title="Permalink"></a></h3><p>The <code>dryrun</code> option to <a href="../../reference/job-submission/#JuliaHub.submit_job"><code>submit_job</code></a> can be used to inspect the full job workload configuration that would be submitted to JuliaHub.</p><pre><code class="language-julia hljs">JuliaHub.submit_job(
     JuliaHub.script&quot;&quot;&quot;
     println(&quot;hello world&quot;)
     &quot;&quot;&quot;,
@@ -117,4 +117,4 @@
     startOnLoad: true,
     theme: "neutral"
 });
-</script><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-1"><a class="tag is-link" href="#citeref-1">1</a>You can also e.g. <a href="../../reference/datasets/#datasets">upload datasets</a> etc. But in that case the resulting data is not, strictly speaking, related to a specific job.</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../datasets/">« Datasets</a><a class="docs-footer-nextpage" href="../../reference/authentication/">Authentication »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 31 May 2024 02:26">Friday 31 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</script><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-1"><a class="tag is-link" href="#citeref-1">1</a>You can also e.g. <a href="../../reference/datasets/#datasets">upload datasets</a> etc. But in that case the resulting data is not, strictly speaking, related to a specific job.</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../datasets/">« Datasets</a><a class="docs-footer-nextpage" href="../../reference/authentication/">Authentication »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 31 May 2024 09:26">Friday 31 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>