Deployed ff2ff3f with MkDocs version: 1.6.1

search/search_index.json

@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the SODAS Documentation","text":"<p>Find relevant documentation and information about SODAS here.</p>"},{"location":"server/","title":"Server","text":"<p>Welcome to the SODAS server.</p> <p>Before you start using the server, please make sure that you read all the pages in this part of the documentation.</p>"},{"location":"server/access/","title":"Access","text":"<p>In order to access the server, you need to have an account. Contact TBD with your basic information and SODAS affiliation, and they will walk you through the process.</p>"},{"location":"server/access/#connecting-to-the-server","title":"Connecting to the server","text":"<p>You can connect to the server using SSH, either through the terminal or vscode.</p>"},{"location":"server/access/#terminal","title":"Terminal","text":""},{"location":"server/access/#ssh","title":"SSH","text":"<pre><code>ssh -L &lt;local-port&gt;:localhost:&lt;remote-port&gt; &lt;username&gt;@sodascomp01fl.unicph.domain\n</code></pre> <p>To connect locally to the server on port 8000 with the user abc123, do:</p> <pre><code>ssh -L 8000:localhost:8000 abc123@sodascomp01fl.unicph.domain\n</code></pre> <p>Once you have a connection established, you can host a jupyter lab server on the server and connect to it from your local machine.</p>"},{"location":"server/access/#transferring-files","title":"Transferring files","text":""},{"location":"server/access/#transfer-from-local-to-server","title":"Transfer from local to server","text":"<pre><code>scp /path/to/file &lt;username&gt;@sodascomp01fl.unicph.domain:/path/to/destination\n</code></pre> <p>To move a text file in documents to your H-drive which is mounted on the server by default, do:</p> <pre><code>scp /documents/test.txt abc123@sodascomp01fl.unicph.doman:/ucph/hdir\n</code></pre>"},{"location":"server/access/#transfer-file-from-server-to-local","title":"Transfer file from server to local","text":"<pre><code>scp &lt;username&gt;@sodascomp01fl.unicph.domain:/path/to/file /path/to/destination\n</code></pre> <p>To move a text file from the H-drive on the server to your local documents folder, do:</p> <pre><code>scp abc123@sodascomp01fl.unicph.doman:/ucph/hdir/test.txt /documents\n</code></pre>"},{"location":"server/access/#vscode","title":"VSCode","text":"<p>TBD</p>"},{"location":"server/setup/","title":"Setup","text":""},{"location":"server/setup/#configuration","title":"Configuration","text":""},{"location":"server/setup/#shell","title":"Shell","text":"<p>The default shell is zsh.</p>"},{"location":"server/setup/#github","title":"Github","text":""},{"location":"server/setup/#generate-ssh-key","title":"Generate SSH key","text":"<p>Follow the guide at GitHub.</p>"},{"location":"server/setup/#ssh-config","title":"SSH Config","text":"<p>Create a config file at <code>~/.ssh/config</code> and add the following lines:</p> <pre><code>Host github.com\n    HostName ssh.github.com\n    PreferredAuthentications publickey\n    IdentityFile ~/.ssh/id_ed25519\n    Port 443\n</code></pre>"},{"location":"server/setup/#tools","title":"Tools","text":"<p>The server comes with a number of tools pre-installed:</p> <ul> <li>uv</li> <li>TBD</li> </ul>"},{"location":"server/usage/","title":"Usage","text":""},{"location":"server/usage/#storage","title":"Storage","text":""},{"location":"server/usage/#cache","title":"Cache","text":""},{"location":"server/usage/#python-dependency-management","title":"Python dependency management","text":""},{"location":"server/usage/#jupyter-lab","title":"Jupyter Lab","text":"<p>TBD: Describe how to install Jupyter Lab as user.</p> <pre><code>jupyter-lab --no-browser --port &lt;port&gt;\n</code></pre> <p>Where  is the localhost port you specified when connecting to the server. <p>Then copy the generated link and paste it in your local computer's browsers.</p> <p>I.e: <code>http://127.0.0.1:&lt;port&gt;/lab?token=abcd1234...</code></p>"},{"location":"server/usage/#docker","title":"Docker","text":""},{"location":"server/usage/#slurm","title":"Slurm","text":""}]}
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the SODAS Documentation","text":"<p>Find relevant documentation and information about SODAS here.</p>"},{"location":"server/","title":"Server","text":"<p>Welcome to the SODAS server.</p> <p>Before you start using the server, please make sure that you read all the pages in this part of the documentation.</p>"},{"location":"server/access/","title":"Access","text":"<p>In order to access the server, you need to have an account. Contact TBD with your basic information and SODAS affiliation, and they will walk you through the process.</p>"},{"location":"server/access/#connecting-to-the-server","title":"Connecting to the server","text":"<p>You can connect to the server using SSH, either through the terminal or vscode.</p>"},{"location":"server/access/#terminal","title":"Terminal","text":""},{"location":"server/access/#ssh","title":"SSH","text":"<pre><code>ssh -L &lt;local-port&gt;:localhost:&lt;remote-port&gt; &lt;username&gt;@sodascomp01fl.unicph.domain\n</code></pre> <p>To connect locally to the server on port 8000 with the user abc123, do:</p> <pre><code>ssh -L 8000:localhost:8000 abc123@sodascomp01fl.unicph.domain\n</code></pre> <p>Once you have a connection established, you can host a jupyter lab server on the server and connect to it from your local machine.</p>"},{"location":"server/access/#transferring-files","title":"Transferring files","text":""},{"location":"server/access/#transfer-from-local-to-server","title":"Transfer from local to server","text":"<pre><code>scp /path/to/file &lt;username&gt;@sodascomp01fl.unicph.domain:/path/to/destination\n</code></pre> <p>To move a text file in documents to your H-drive which is mounted on the server by default, do:</p> <pre><code>scp /documents/test.txt abc123@sodascomp01fl.unicph.doman:/ucph/hdir\n</code></pre>"},{"location":"server/access/#transfer-file-from-server-to-local","title":"Transfer file from server to local","text":"<pre><code>scp &lt;username&gt;@sodascomp01fl.unicph.domain:/path/to/file /path/to/destination\n</code></pre> <p>To move a text file from the H-drive on the server to your local documents folder, do:</p> <pre><code>scp abc123@sodascomp01fl.unicph.doman:/ucph/hdir/test.txt /documents\n</code></pre>"},{"location":"server/access/#vscode","title":"VSCode","text":"<p>TBD</p>"},{"location":"server/setup/","title":"Setup","text":""},{"location":"server/setup/#configuration","title":"Configuration","text":""},{"location":"server/setup/#environment-variables","title":"Environment Variables","text":""},{"location":"server/setup/#shell","title":"Shell","text":"<p>The default shell is zsh.</p>"},{"location":"server/setup/#github","title":"Github","text":""},{"location":"server/setup/#generate-ssh-key","title":"Generate SSH key","text":"<p>Follow the guide at GitHub.</p>"},{"location":"server/setup/#ssh-config","title":"SSH Config","text":"<p>Create a config file at <code>~/.ssh/config</code> and add the following lines:</p> <pre><code>Host github.com\n    HostName ssh.github.com\n    PreferredAuthentications publickey\n    IdentityFile ~/.ssh/id_ed25519\n    Port 443\n</code></pre>"},{"location":"server/setup/#tools","title":"Tools","text":"<p>The server comes with a number of tools pre-installed:</p> <ul> <li>uv</li> <li>fzf</li> <li>TBD</li> </ul>"},{"location":"server/usage/","title":"Usage","text":""},{"location":"server/usage/#general-utilities","title":"General utilities","text":"<pre><code>watch -n 1 nvidia-smi\n</code></pre>"},{"location":"server/usage/#storage","title":"Storage","text":""},{"location":"server/usage/#cache","title":"Cache","text":""},{"location":"server/usage/#python-dependency-management","title":"Python dependency management","text":""},{"location":"server/usage/#jupyter-lab","title":"Jupyter Lab","text":"<p>TBD: Describe how to install Jupyter Lab as user.</p> <pre><code>jupyter-lab --no-browser --port &lt;port&gt;\n</code></pre> <p>Where  is the localhost port you specified when connecting to the server. <p>Then copy the generated link and paste it in your local computer's browsers.</p> <p>I.e: <code>http://127.0.0.1:&lt;port&gt;/lab?token=abcd1234...</code></p>"},{"location":"server/usage/#docker","title":"Docker","text":""},{"location":"server/usage/#slurm","title":"Slurm","text":""}]}

server/setup/index.html

@@ -464,6 +464,15 @@
     <nav class="md-nav" aria-label="Configuration">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#environment-variables" class="md-nav__link">
+    <span class="md-ellipsis">
+      Environment Variables
+    </span>
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#shell" class="md-nav__link">
     <span class="md-ellipsis">
@@ -593,6 +602,15 @@
     <nav class="md-nav" aria-label="Configuration">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#environment-variables" class="md-nav__link">
+    <span class="md-ellipsis">
+      Environment Variables
+    </span>
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#shell" class="md-nav__link">
     <span class="md-ellipsis">
@@ -666,6 +684,7 @@
 
 <h1 id="setup">Setup</h1>
 <h2 id="configuration">Configuration</h2>
+<h3 id="environment-variables">Environment Variables</h3>
 <h3 id="shell">Shell</h3>
 <p>The default shell is <a href="https://zsh.sourceforge.io/" target="_blank">zsh</a>.</p>
 <h3 id="github">Github</h3>
@@ -683,6 +702,7 @@ <h2 id="tools">Tools</h2>
 <p>The server comes with a number of tools pre-installed:</p>
 <ul>
 <li>uv</li>
+<li>fzf</li>
 <li>TBD</li>
 </ul>
 

server/usage/index.html

@@ -473,6 +473,15 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#general-utilities" class="md-nav__link">
+    <span class="md-ellipsis">
+      General utilities
+    </span>
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#storage" class="md-nav__link">
     <span class="md-ellipsis">
@@ -575,6 +584,15 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#general-utilities" class="md-nav__link">
+    <span class="md-ellipsis">
+      General utilities
+    </span>
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#storage" class="md-nav__link">
     <span class="md-ellipsis">
@@ -651,12 +669,15 @@
 
 
 <h1 id="usage">Usage</h1>
+<h2 id="general-utilities">General utilities</h2>
+<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>watch<span class="w"> </span>-n<span class="w"> </span><span class="m">1</span><span class="w"> </span>nvidia-smi
+</span></code></pre></div>
 <h2 id="storage">Storage</h2>
 <h3 id="cache">Cache</h3>
 <h2 id="python-dependency-management">Python dependency management</h2>
 <h2 id="jupyter-lab">Jupyter Lab</h2>
 <p>TBD: Describe how to install Jupyter Lab as user.</p>
-<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>jupyter-lab<span class="w"> </span>--no-browser<span class="w"> </span>--port<span class="w"> </span>&lt;port&gt;
+<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>jupyter-lab<span class="w"> </span>--no-browser<span class="w"> </span>--port<span class="w"> </span>&lt;port&gt;
 </span></code></pre></div>
 <p>Where <port> is the localhost port you specified when connecting to the server.</p>
 <p>Then copy the generated link and paste it in your local computer's browsers.</p>