added ssh instruction to slides, recreated slides and updated exercis…

…es titles
SciCatProject · Mar 22, 2023 · 13b1d76 · 13b1d76
1 parent 80dc59a
commit 13b1d76
Show file tree

Hide file tree

Showing 8 changed files with 184 additions and 43 deletions.
diff --git a/environment/SETUP.md b/environment/SETUP.md
@@ -33,7 +33,7 @@ Omit this step if your SSH is already set up like this.
 For the time being, we have to use SSH to access the fileserver.
 To make this work smoothly,
 
-- set up an SSH-key for `login.esss.dk`
+- set up an SSH-key for `login.esss.dk` (Please check this [guide](https://linuxize.com/post/how-to-setup-passwordless-ssh-login/) if you need to help in this step)
 - add it to your ssh-agent (https://www.ssh.com/academy/ssh/agent)
 - define an alias in `~/.ssh/config`:
 

diff --git a/exercises/exercise_6.ipynb b/exercises/exercise_6.ipynb
@@ -5,7 +5,8 @@
    "id": "99a0bf46-f0b5-4103-a3e5-2529fd21642a",
    "metadata": {},
    "source": [
-    "# SciCat workshop, exercise #6\n",
+    "# Exercise #6 template\n",
+    "## SciCat Workshop \n",
     "\n",
     "This exercise walks you through downloading a dataset and data files from SciCat and uploading processed data to SciCat.\n",
     "It uses a basic, contrived workflow to process the data using [Scipp](https://scipp.github.io/)."

diff --git a/exercises/exercise_7.ipynb b/exercises/exercise_7.ipynb
@@ -8,7 +8,7 @@
    },
    "source": [
     "# Exercise #7 template\n",
-    "## SCiCat Workshop\n",
+    "## SciCat Workshop\n",
     "\n",
     "This notebook is meant as a template to be used to solve Exercise #7 presented at the SciCat Workshop.\n",
     "\n",

diff --git a/scicat_workshop.ipynb b/scicat_workshop.ipynb
@@ -271,7 +271,7 @@
     "tags": []
    },
    "source": [
-    "### Exercise #4\n",
+    "### Exercise #4 (1)\n",
     "Retrieve the dataset derived from raw data acquired on YMIR where __run number__ is 3931, __extra entry instrument flir camera image key maximum value__ is equal to 3\n",
     "\n",
     "Suggestions: \n",
@@ -294,6 +294,7 @@
     "tags": []
    },
    "source": [
+    "### Exercise #4 (2)\n",
     "- Select and copy the dataset pid\n",
     "    - _849c591c-a42e-462b-b5b4-6345e9d2200b_\n",
     "- Go back to the dataset list\n",
@@ -348,22 +349,63 @@
   },
   {
    "cell_type": "markdown",
-   "id": "def50dc2-1879-4e7a-a78a-6ef6e4f55245",
+   "id": "917e950e-264e-43e7-990a-db5fc264bd06",
    "metadata": {
     "slideshow": {
      "slide_type": "slide"
     },
     "tags": []
    },
    "source": [
+    "### Set up: python environment\n",
+    "\n",
     "We suggest to use conda and create an environment from the specification file provided in this repository.  \n",
     "The files needed to create a conda environment or to install the packages in a simple python environment using pip, are available in the folder:\n",
     "```bash\n",
     "environment\n",
     "```\n",
     "\n",
-    "The instructions to create such environments are explained in details in the [setup](./environment/SETUP.md) file.\n",
-    "This file is kept up-date."
+    "Detailed instructions on how to create such environments are explained in details in the [setup](./environment/SETUP.md) file.  \n",
+    "In case you want to get going quickly, here is the summary:  \n",
+    "\n",
+    "#### Conda\n",
+    "```sh\n",
+    "conda env create -f conda-scicat-workshop.yml\n",
+    "conda activate scicat-workshop\n",
+    "```\n",
+    "\n",
+    "### Pip\n",
+    "```sh\n",
+    "python -m pip install -r pip-scicat-workshop.txt\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9940269a-e88b-4a1f-bdcd-389cd142777c",
+   "metadata": {
+    "slideshow": {
+     "slide_type": "slide"
+    },
+    "tags": []
+   },
+   "source": [
+    "### Set up: ssh passwordless login\n",
+    "\n",
+    "To make the process smooth, we suggest to create a passowrdless login with ssh.   \n",
+    "Here are the steps:\n",
+    "- set up an SSH-key for `login.esss.dk` (Please check this [guide](https://linuxize.com/post/how-to-setup-passwordless-ssh-login/) if you need to help in this step)\n",
+    "- add it to your ssh-agent (https://www.ssh.com/academy/ssh/agent)\n",
+    "- define an alias in `~/.ssh/config`:\n",
+    "\n",
+    "```\n",
+    "Host login.esss.dk\n",
+    "    HostName login.esss.dk\n",
+    "    User <your-username>\n",
+    "    IdentityFile <private-key-file>\n",
+    "```\n",
+    "\n",
+    "Please read the detailed instruction provided in the [setup](./environment/SETUP.md) file.  \n"
    ]
   },
   {

diff --git a/scicat_workshop.slides.html b/scicat_workshop.slides.html
diff --git a/solutions/exercise_6_with_solution.ipynb b/solutions/exercise_6_with_solution.ipynb
@@ -5,7 +5,8 @@
    "id": "99a0bf46-f0b5-4103-a3e5-2529fd21642a",
    "metadata": {},
    "source": [
-    "# SciCat workshop exercise\n",
+    "# Exercise #6 with solution\n",
+    "## SciCat Workshop \n",
     "\n",
     "This exercise walks you through downloading a dataset and data files from SciCat and uploading processed data to SciCat.\n",
     "It uses a basic, contrived workflow to process the data using [Scipp](https://scipp.github.io/)."
@@ -514,10 +515,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.0"
+   "version": "3.10.9"
   }
  },
  "nbformat": 4,
  "nbformat_minor": 5
 }
-
diff --git a/solutions/scicat_workshop_with_solutions.ipynb b/solutions/scicat_workshop_with_solutions.ipynb
@@ -310,7 +310,7 @@
     "tags": []
    },
    "source": [
-    "### Exercise #4\n",
+    "### Exercise #4 (1)\n",
     "Retrieve the dataset derived from raw data acquired on YMIR where __run number__ is 3931, __extra entry instrument flir camera image key maximum value__ is equal to 3\n",
     "\n",
     "Suggestions: \n",
@@ -359,6 +359,7 @@
     "tags": []
    },
    "source": [
+    "### Exercise #4 (2)\n",
     "- Select and copy the dataset pid\n",
     "    - _849c591c-a42e-462b-b5b4-6345e9d2200b_\n",
     "- Go back to the dataset list\n",
@@ -426,22 +427,63 @@
   },
   {
    "cell_type": "markdown",
-   "id": "def50dc2-1879-4e7a-a78a-6ef6e4f55245",
+   "id": "a3465ec3-e13b-4a1f-b646-ad3317020a8a",
    "metadata": {
     "slideshow": {
      "slide_type": "slide"
     },
     "tags": []
    },
    "source": [
+    "### Set up: python environment\n",
+    "\n",
     "We suggest to use conda and create an environment from the specification file provided in this repository.  \n",
     "The files needed to create a conda environment or to install the packages in a simple python environment using pip, are available in the folder:\n",
     "```bash\n",
     "environment\n",
     "```\n",
     "\n",
-    "The instructions to create such environments are explained in details in the [setup](./environment/SETUP.md) file.\n",
-    "This file is kept up-date."
+    "Detailed instructions on how to create such environments are explained in details in the [setup](./environment/SETUP.md) file.  \n",
+    "In case you want to get going quickly, here is the summary:  \n",
+    "\n",
+    "#### Conda\n",
+    "```sh\n",
+    "conda env create -f conda-scicat-workshop.yml\n",
+    "conda activate scicat-workshop\n",
+    "```\n",
+    "\n",
+    "### Pip\n",
+    "```sh\n",
+    "python -m pip install -r pip-scicat-workshop.txt\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7ab2637f-8aa0-4257-80cf-2418866cd20d",
+   "metadata": {
+    "slideshow": {
+     "slide_type": "slide"
+    },
+    "tags": []
+   },
+   "source": [
+    "### Set up: ssh passwordless login\n",
+    "\n",
+    "To make the process smooth, we suggest to create a passowrdless login with ssh.   \n",
+    "Here are the steps:\n",
+    "- set up an SSH-key for `login.esss.dk` (Please check this [guide](https://linuxize.com/post/how-to-setup-passwordless-ssh-login/) if you need to help in this step)\n",
+    "- add it to your ssh-agent (https://www.ssh.com/academy/ssh/agent)\n",
+    "- define an alias in `~/.ssh/config`:\n",
+    "\n",
+    "```\n",
+    "Host login.esss.dk\n",
+    "    HostName login.esss.dk\n",
+    "    User <your-username>\n",
+    "    IdentityFile <private-key-file>\n",
+    "```\n",
+    "\n",
+    "Please read the detailed instruction provided in the [setup](./environment/SETUP.md) file.  \n"
    ]
   },
   {

diff --git a/solutions/scicat_workshop_with_solutions.slides.html b/solutions/scicat_workshop_with_solutions.slides.html
@@ -14900,7 +14900,7 @@ <h3 id="Exercise-%233">Exercise #3<a class="anchor-link" href="#Exercise-%233">&
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
 <div class="jp-InputArea jp-Cell-inputArea"><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput " data-mime-type="text/markdown">
-<h3 id="Exercise-%234">Exercise #4<a class="anchor-link" href="#Exercise-%234">&#182;</a></h3><p>Retrieve the dataset derived from raw data acquired on YMIR where <strong>run number</strong> is 3931, <strong>extra entry instrument flir camera image key maximum value</strong> is equal to 3</p>
+<h3 id="Exercise-%234-(1)">Exercise #4 (1)<a class="anchor-link" href="#Exercise-%234-(1)">&#182;</a></h3><p>Retrieve the dataset derived from raw data acquired on YMIR where <strong>run number</strong> is 3931, <strong>extra entry instrument flir camera image key maximum value</strong> is equal to 3</p>
 <p>Suggestions:</p>
 <ul>
 <li>Use <strong>type</strong> field and <strong>add condition</strong> feature in the search form to retrieve the raw dataset</li>
@@ -14945,7 +14945,7 @@ <h3 id="Exercise-%234">Exercise #4<a class="anchor-link" href="#Exercise-%234">&
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
 <div class="jp-InputArea jp-Cell-inputArea"><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput " data-mime-type="text/markdown">
-<ul>
+<h3 id="Exercise-%234-(2)">Exercise #4 (2)<a class="anchor-link" href="#Exercise-%234-(2)">&#182;</a></h3><ul>
 <li>Select and copy the dataset pid<ul>
 <li><em>849c591c-a42e-462b-b5b4-6345e9d2200b</em></li>
 </ul>
@@ -15013,12 +15013,40 @@ <h3 id="Set-up">Set up<a class="anchor-link" href="#Set-up">&#182;</a></h3><p>In
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
 <div class="jp-InputArea jp-Cell-inputArea"><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput " data-mime-type="text/markdown">
-<p>We suggest to use conda and create an environment from the specification file provided in this repository.<br>
+<h3 id="Set-up:-python-environment">Set up: python environment<a class="anchor-link" href="#Set-up:-python-environment">&#182;</a></h3><p>We suggest to use conda and create an environment from the specification file provided in this repository.<br>
 The files needed to create a conda environment or to install the packages in a simple python environment using pip, are available in the folder:</p>
 <div class="highlight"><pre><span></span>environment
 </pre></div>
-<p>The instructions to create such environments are explained in details in the <a href="./environment/SETUP.md">setup</a> file.
-This file is kept up-date.</p>
+<p>Detailed instructions on how to create such environments are explained in details in the <a href="./environment/SETUP.md">setup</a> file.<br>
+In case you want to get going quickly, here is the summary:</p>
+<h4 id="Conda">Conda<a class="anchor-link" href="#Conda">&#182;</a></h4><div class="highlight"><pre><span></span>conda env create -f conda-scicat-workshop.yml
+conda activate scicat-workshop
+</pre></div>
+<h3 id="Pip">Pip<a class="anchor-link" href="#Pip">&#182;</a></h3><div class="highlight"><pre><span></span>python -m pip install -r pip-scicat-workshop.txt
+</pre></div>
+
+</div>
+</div>
+</div>
+</div></section></section><section><section>
+<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
+<div class="jp-Cell-inputWrapper">
+<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
+</div>
+<div class="jp-InputArea jp-Cell-inputArea"><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput " data-mime-type="text/markdown">
+<h3 id="Set-up:-ssh-passwordless-login">Set up: ssh passwordless login<a class="anchor-link" href="#Set-up:-ssh-passwordless-login">&#182;</a></h3><p>To make the process smooth, we suggest to create a passowrdless login with ssh.<br>
+Here are the steps:</p>
+<ul>
+<li>set up an SSH-key for <code>login.esss.dk</code> (Please check this <a href="https://linuxize.com/post/how-to-setup-passwordless-ssh-login/">guide</a> if you need to help in this step)</li>
+<li>add it to your ssh-agent (<a href="https://www.ssh.com/academy/ssh/agent">https://www.ssh.com/academy/ssh/agent</a>)</li>
+<li>define an alias in <code>~/.ssh/config</code>:</li>
+</ul>
+
+<pre><code>Host login.esss.dk
+    HostName login.esss.dk
+    User &lt;your-username&gt;
+    IdentityFile &lt;private-key-file&gt;</code></pre>
+<p>Please read the detailed instruction provided in the <a href="./environment/SETUP.md">setup</a> file.</p>
 
 </div>
 </div>