update the start of each notebook

ProjectPythia · Dec 16, 2024 · 3210d8b · 3210d8b
1 parent ea90465
commit 3210d8b
Show file tree

Hide file tree

Showing 10 changed files with 203 additions and 52 deletions.
diff --git a/notebooks/01-foundations/plotting-libs.ipynb b/notebooks/01-foundations/plotting-libs.ipynb
@@ -1,40 +1,64 @@
 {
  "cells": [
   {
-   "metadata": {},
    "cell_type": "markdown",
+   "id": "a107dfa27c1b5b7b",
+   "metadata": {},
    "source": [
+    "<img src=\"https://raw.githubusercontent.com/UXARRAY/uxarray/main/docs/_static/images/logos/uxarray_logo_h_dark.svg\"\n",
+    "     width=\"30%\"\n",
+    "     alt=\"UXarray logo\"\n",
+    "     align=\"right\"\n",
+    "/>\n",
+    "\n",
     "# Plotting Libraries\n",
-    "---"
-   ],
-   "id": "a107dfa27c1b5b7b"
+    "\n",
+    "### In this tutorial, you'll learn:\n",
+    "\n",
+    "* TODO: \n",
+    "\n",
+    "\n",
+    "### Related Documentation\n",
+    "\n",
+    "* [Links to Relevent Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n",
+    "\n",
+    "### Prerequisites\n",
+    "\n",
+    "| Concepts | Importance | Notes |\n",
+    "| --- | --- | --- |\n",
+    "| [Link to Pre-Req](https://pandas.pydata.org/docs/user_guide/10min.html) | Necessary | |\n",
+    "\n",
+    "* **Time to learn**: x minutes\n",
+    "-----\n",
+    "\n"
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "code",
-   "outputs": [],
    "execution_count": null,
-   "source": "# todo",
-   "id": "e1493ba9d8e00442"
+   "id": "99be9156-a3d5-45e5-903e-00f06d57164a",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 2
+    "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython2",
-   "version": "2.7.6"
+   "pygments_lexer": "ipython3",
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

diff --git a/notebooks/01-foundations/rendering-techniques.ipynb b/notebooks/01-foundations/rendering-techniques.ipynb
@@ -1,40 +1,67 @@
 {
  "cells": [
   {
-   "metadata": {},
    "cell_type": "markdown",
+   "id": "60db6be101e99c83",
+   "metadata": {},
    "source": [
+    "<img src=\"https://raw.githubusercontent.com/UXARRAY/uxarray/main/docs/_static/images/logos/uxarray_logo_h_dark.svg\"\n",
+    "     width=\"30%\"\n",
+    "     alt=\"UXarray logo\"\n",
+    "     align=\"right\"\n",
+    "/>\n",
+    "\n",
     "# Rendering Techniques\n",
-    "---"
-   ],
-   "id": "60db6be101e99c83"
+    "\n",
+    "### In this tutorial, you'll learn:\n",
+    "\n",
+    "* TODO: \n",
+    "\n",
+    "\n",
+    "### Related Documentation\n",
+    "\n",
+    "* [Links to Relevent Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n",
+    "\n",
+    "\n",
+    "### Prerequisites\n",
+    "\n",
+    "| Concepts | Importance | Notes |\n",
+    "| --- | --- | --- |\n",
+    "| [Link to Pre-Req](https://pandas.pydata.org/docs/user_guide/10min.html) | Necessary | |\n",
+    "\n",
+    "* **Time to learn**: x minutes\n",
+    "-----\n",
+    "\n"
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "code",
-   "outputs": [],
    "execution_count": null,
-   "source": "# todo",
-   "id": "8eb8909e71d090bb"
+   "id": "8eb8909e71d090bb",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# todo"
+   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 2
+    "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython2",
-   "version": "2.7.6"
+   "pygments_lexer": "ipython3",
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

diff --git a/notebooks/01-foundations/unstructured-grids.ipynb b/notebooks/01-foundations/unstructured-grids.ipynb
@@ -1,40 +1,66 @@
 {
  "cells": [
   {
-   "metadata": {},
    "cell_type": "markdown",
+   "id": "b0e265cab6491374",
+   "metadata": {},
    "source": [
+    "<img src=\"https://raw.githubusercontent.com/UXARRAY/uxarray/main/docs/_static/images/logos/uxarray_logo_h_dark.svg\"\n",
+    "     width=\"30%\"\n",
+    "     alt=\"UXarray logo\"\n",
+    "     align=\"right\"\n",
+    "/>\n",
+    "\n",
     "# Unstructured Grids\n",
-    "---"
-   ],
-   "id": "b0e265cab6491374"
+    "\n",
+    "### In this tutorial, you'll learn:\n",
+    "\n",
+    "* TODO:\n",
+    "\n",
+    "\n",
+    "### Related Documentation\n",
+    "\n",
+    "* [Links to Relevent Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n",
+    "\n",
+    "### Prerequisites\n",
+    "\n",
+    "| Concepts | Importance | Notes |\n",
+    "| --- | --- | --- |\n",
+    "| [Link to Pre-Req](https://pandas.pydata.org/docs/user_guide/10min.html) | Necessary | |\n",
+    "\n",
+    "* **Time to learn**: x minutes\n",
+    "-----\n",
+    "\n"
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "code",
-   "outputs": [],
    "execution_count": null,
-   "source": "# todo",
-   "id": "32c2dcbc05cdcb84"
+   "id": "32c2dcbc05cdcb84",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# todo"
+   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 2
+    "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython2",
-   "version": "2.7.6"
+   "pygments_lexer": "ipython3",
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

diff --git a/notebooks/02-intro-to-uxarray/grid.ipynb b/notebooks/02-intro-to-uxarray/grid.ipynb
@@ -19,9 +19,19 @@
     "* How to load a `Grid`\n",
     "* How to access `Grid` variables\n",
     "\n",
-    "**Related UXarray Documentation**\n",
+    "### Related Documentation\n",
     "\n",
-    "* [UXarray Data Structures Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n"
+    "* [UXarray Data Structures Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n",
+    "\n",
+    "### Prerequisites\n",
+    "\n",
+    "| Concepts | Importance | Notes |\n",
+    "| --- | --- | --- |\n",
+    "| [Link to Pre-Req](https://pandas.pydata.org/docs/user_guide/10min.html) | Necessary | |\n",
+    "\n",
+    "* **Time to learn**: x minutes\n",
+    "-----\n",
+    "\n"
    ]
   },
   {
@@ -34,9 +44,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 1,
    "id": "90c3f4f3-bf5c-41cc-8122-e410b4cb8559",
-   "metadata": {},
+   "metadata": {
+    "ExecuteTime": {
+     "end_time": "2024-12-16T17:24:00.350145Z",
+     "start_time": "2024-12-16T17:24:00.346851Z"
+    }
+   },
    "outputs": [],
    "source": [
     "grid_path = \"../../meshfiles/outCSne30.grid.ug\""

diff --git a/notebooks/02-intro-to-uxarray/selection.ipynb b/notebooks/02-intro-to-uxarray/selection.ipynb
@@ -18,10 +18,19 @@
     "* How can I obtain a \n",
     "\n",
     "\n",
-    "**Related UXarray Documentation**\n",
+    "### Related Documentation\n",
     "\n",
     "* [UXarray Subsetting Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/subset.html)\n",
-    "* [UXarray Cross-Section Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/cross-sections.html)\n"
+    "* [UXarray Cross-Section Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/cross-sections.html)\n",
+    "\n",
+    "### Prerequisites\n",
+    "\n",
+    "| Concepts | Importance | Notes |\n",
+    "| --- | --- | --- |\n",
+    "| [Link to Pre-Req](https://pandas.pydata.org/docs/user_guide/10min.html) | Necessary | |\n",
+    "\n",
+    "* **Time to learn**: x minutes\n",
+    "-----\n"
    ]
   },
   {

diff --git a/notebooks/02-intro-to-uxarray/uxds-uxda.ipynb b/notebooks/02-intro-to-uxarray/uxds-uxda.ipynb
@@ -19,9 +19,19 @@
     "* How to load a `Grid`\n",
     "* How to access `Grid` variables\n",
     "\n",
-    "**Related UXarray Documentation**\n",
+    "## Related Documentation\n",
     "\n",
-    "* [UXarray Data Structures Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n"
+    "* [UXarray Data Structures Documentation](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n",
+    "\n",
+    "### Prerequisites\n",
+    "\n",
+    "| Concepts | Importance | Notes |\n",
+    "| --- | --- | --- |\n",
+    "| [Link to Pre-Req](https://pandas.pydata.org/docs/user_guide/10min.html) | Necessary | |\n",
+    "\n",
+    "* **Time to learn**: x minutes\n",
+    "-----\n",
+    "\n"
    ]
   },
   {

diff --git a/notebooks/03-plotting-with-uxarray/customization.ipynb b/notebooks/03-plotting-with-uxarray/customization.ipynb
@@ -17,9 +17,19 @@
     "\n",
     "* TODO: \n",
     "\n",
-    "**Related UXarray Documentation**\n",
+    "### Related UXarray Documentation\n",
     "\n",
-    "* [TODO:](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n"
+    "* [TODO:](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n",
+    "\n",
+    "### Prerequisites\n",
+    "\n",
+    "| Concepts | Importance | Notes |\n",
+    "| --- | --- | --- |\n",
+    "| [Link to Pre-Req](https://pandas.pydata.org/docs/user_guide/10min.html) | Necessary | |\n",
+    "\n",
+    "* **Time to learn**: x minutes\n",
+    "-----\n",
+    "\n"
    ]
   },
   {

diff --git a/notebooks/03-plotting-with-uxarray/data-viz.ipynb b/notebooks/03-plotting-with-uxarray/data-viz.ipynb
@@ -17,9 +17,19 @@
     "\n",
     "* TODO: \n",
     "\n",
-    "**Related UXarray Documentation**\n",
+    "### Related Documentation \n",
     "\n",
-    "* [TODO:](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n"
+    "* [TODO:](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n",
+    "\n",
+    "### Prerequisites\n",
+    "\n",
+    "| Concepts | Importance | Notes |\n",
+    "| --- | --- | --- |\n",
+    "| [Link to Pre-Req](https://pandas.pydata.org/docs/user_guide/10min.html) | Necessary | |\n",
+    "\n",
+    "* **Time to learn**: x minutes\n",
+    "-----\n",
+    "\n"
    ]
   },
   {

diff --git a/notebooks/03-plotting-with-uxarray/geo.ipynb b/notebooks/03-plotting-with-uxarray/geo.ipynb
@@ -17,9 +17,19 @@
     "\n",
     "* TODO: \n",
     "\n",
-    "**Related UXarray Documentation**\n",
+    "Related Documentation\n",
     "\n",
-    "* [TODO:](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n"
+    "* [TODO:](https://uxarray.readthedocs.io/en/latest/user-guide/data-structures.html)\n",
+    "\n",
+    "### Prerequisites\n",
+    "\n",
+    "| Concepts | Importance | Notes |\n",
+    "| --- | --- | --- |\n",
+    "| [Link to Pre-Req](https://pandas.pydata.org/docs/user_guide/10min.html) | Necessary | |\n",
+    "\n",
+    "* **Time to learn**: x minutes\n",
+    "-----\n",
+    "\n"
    ]
   },
   {