More info in generic template

SciCatProject · Jan 29, 2024 · fba6fa5 · fba6fa5
1 parent 632d2b8
commit fba6fa5
Showing 1 changed file with 35 additions and 2 deletions.
diff --git a/templates/notebook/b32f6992-0355-4759-b780-ececd4957c23.ipynb b/templates/notebook/b32f6992-0355-4759-b780-ececd4957c23.ipynb
@@ -5,15 +5,16 @@
    "id": "803f7b636cfa4b4c",
    "metadata": {},
    "source": [
-    "# {{ TEMPLATE_DISPLAY_NAME | capitalize }}"
+    "# {{ TEMPLATE_DISPLAY_NAME | capitalize }}\n",
+    "<span style=\"font-size: smaller\">Notebook generated from template '<em>{{ TEMPLATE_DISPLAY_NAME }}</em>' version {{ TEMPLATE_VERSION }} (id: `{{ TEMPLATE_ID }}`, time: <time>{{ TEMPLATE_RENDERED_AT }}</time>).</span>"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "9e7442fc9ec68975",
    "metadata": {},
    "source": [
-    "Notebook generated from template '{{ TEMPLATE_DISPLAY_NAME }}' version {{ TEMPLATE_VERSION }} (id: {{ TEMPLATE_ID }})."
+    "This notebook downloads selected datasets from SciCat and all files for those datasets."
    ]
   },
   {
@@ -27,6 +28,14 @@
     "from scitacean.transfer.sftp import SFTPFileTransfer"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "d0336f3a7a2d37eb",
+   "metadata": {},
+   "source": [
+    "Scicat configuration:"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -39,6 +48,14 @@
     "file_server_port = {{ FILE_SERVER_PORT | int }}"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "9bdf7ecbf3cd7df",
+   "metadata": {},
+   "source": [
+    "Login token for SciCat. If it expires, replace it with a new one obtained from the SciCat web interface."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -49,6 +66,14 @@
     "scicat_token = {{ SCICAT_TOKEN | quote | je | safe }}"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "590b037151d5a71d",
+   "metadata": {},
+   "source": [
+    "Select datasets to downloads:"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -61,6 +86,14 @@
     "]"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "a3358b891c9c476d",
+   "metadata": {},
+   "source": [
+    "Download files to this folder. You may change it freely."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,