add doc on templates

jepegit · Mar 5, 2024 · a8edb39 · a8edb39
1 parent aed7c0c
commit a8edb39
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 11 deletions.
diff --git a/docs/examples/templates/tutorial_templates.ipynb b/docs/examples/templates/tutorial_templates.ipynb
@@ -122,7 +122,7 @@
   {
    "attachments": {},
    "cell_type": "markdown",
-   "id": "c0d4f829",
+   "id": "a02637e8",
    "metadata": {},
    "source": [
     "Next `cellpy` will suggest a name for the directory / folder that the template will create, as well as the \"core\" name of the notebook(s) (or script). Once again, confirm the by pressing Enter:\n",
@@ -167,7 +167,7 @@
   {
    "attachments": {},
    "cell_type": "markdown",
-   "id": "0d6349d3",
+   "id": "c67ea275",
    "metadata": {},
    "source": [
     "## Run the notebooks\n",
@@ -344,13 +344,23 @@
     "    \n",
     "```"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "28c3f663-2914-450b-9d91-b604fea46876",
+   "metadata": {},
+   "source": [
+    "## Example template\n",
+    "\n",
+    "You can find an example template in the `cellpy` examples folder on GitHub (https://github.com/jepegit/cellpy/tree/master/examples/cellpy%20project%20template)."
+   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "cellpy",
+   "display_name": "cellpy_dev",
    "language": "python",
-   "name": "cellpy"
+   "name": "cellpy_dev"
   },
   "language_info": {
    "codemirror_mode": {
@@ -362,7 +372,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.6 | packaged by conda-forge | (main, Aug 22 2022, 20:30:19) [MSC v.1929 64 bit (AMD64)]"
+   "version": "3.11.8"
   }
  },
  "nbformat": 4,

diff --git a/examples/06_loading_different_formats.ipynb b/examples/06_loading_different_formats.ipynb
@@ -1453,18 +1453,22 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 29,
+   "execution_count": 30,
    "id": "e35d1950-09bf-403d-831a-56276747b526",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "args=()\n",
-      "kwargs={'instrument_file': None, 'model': None, 'sep': ',', 'config_params': {'hei'}}\n",
-      "parsing loader parameters\n",
-      "(cellpy) - self.sep=',', self.skiprows=0, self.header=0, self.encoding='ISO-8859-1', self.decimal='.'\n",
+      "auto-formatting\n",
+      "(cellpy) - auto-formatting:\n",
+      "  self.sep=','\n",
+      "  self.skiprows=-1\n",
+      "  self.header=0\n",
+      "  self.encoding='UTF-8'\n",
+      "\n",
+      "(cellpy) - self.sep=',', self.skiprows=-1, self.header=0, self.encoding='UTF-8', self.decimal='.'\n",
       "(cellpy) - running post-processor: rename_headers\n",
       "(cellpy) - running post-processor: cumulate_capacity_within_cycle\n",
       "(cellpy) - running post-processor: set_index\n",
@@ -1475,7 +1479,7 @@
     }
    ],
    "source": [
-    "c = cellpy.get(p, instrument=\"neware_txt\", mass=2.09, sep=\",\")"
+    "c = cellpy.get(p, instrument=\"neware_txt\", mass=2.09)"
    ]
   },
   {