update notebook figures

README.md

@@ -141,7 +141,7 @@ methods of ``xarray``.
 ```
 
 Results can be visualized using your favorite plotting library.
-![Screenshot](example/fig5.png)
+![Screenshot](example/figures/fig5.png)
 
 ## Contributing
 

example/example.ipynb

@@ -5,28 +5,67 @@
    "id": "4d530e2b-8524-48b2-8259-38c8ce984a5b",
    "metadata": {},
    "source": [
-    "### Example\n",
+    "# Example\n",
     "Author: [Romain Sacchi]([email protected])\n",
     "\n",
-    "``pathways``allows calculating LCA impacts of a product or system along a time axis, combining time series of demand with scenario-based LCA databases.\n",
+    "``pathways``allows calculating LCA impacts of a product or system along a time axis, combining time series of demand with scenario-based LCA databases.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f86c7c83-b59e-4043-b0f5-01463a1b75ca",
+   "metadata": {},
+   "source": [
+    "## Introduction"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3589debc-dfa2-48f7-96ef-4b8ab1724f92",
+   "metadata": {},
+   "source": [
+    "This notebook presents a mock case to illustrate the use of `pathways`. The diagram below introduces the production system proposed.\n",
     "\n",
-    "We start by instantiating the `Pathways` class, and give it a file path pointing to a datapackage.json of a datapackage or directly the datapackage itself (.zip file)."
+    "The goal of this exercise is be to calculate the environmental impact (both direct and indirect) associated to satisfying the demand over time (2020-2050) for **product A** under two different future scenarios.\n",
+    "\n",
+    "For each timestep, we present the technosphere and biosphere matrices. As to the LCA conventions, the technosphere matrix displays the different activities in columns, and the different products in rows. Meanwhile, positive values represent an output from a certain activity and negative values inputs. Hence, as an example, in 2020: *activity A*, to produce 1 unit of *product A*, demands 0.8 units of *product B* and directly emits 1.5 units of CO2. At the same time, *activity B* consumes 0.2 units of *product E* and emits 0.2 units of CO2 to produce 1 unit of *product B*. [...]\n",
+    "\n",
+    "Per each timestep, we can identify different changes in the technosphere exchanges and emissions intensities caused by changes in the system"
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "431d9e51-7002-43ad-aa55-ef5a36e12b78",
+   "cell_type": "markdown",
+   "id": "c32238d6-56c7-403e-adcc-51cd8b07a2ca",
    "metadata": {},
-   "outputs": [],
-   "source": []
+   "source": [
+    "-------------------"
+   ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "663fb68b-d328-48bc-985a-391ee82cb964",
    "metadata": {},
    "source": [
-    "![title](example_illustration.png)"
+    "![system](figures/example_illustration.png)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0b225594-e91f-44f4-9bfa-db02b893636a",
+   "metadata": {},
+   "source": [
+    "-------------------"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "d2d439e4-254e-4d84-aa56-dccfb2de3f2f",
+   "metadata": {},
+   "source": [
+    "## Application\n",
+    "\n",
+    "We start by instantiating the `Pathways` class, and give it a file path pointing to a datapackage.json of a datapackage or directly the datapackage itself (.zip file)."
    ]
   },
   {
@@ -445,7 +484,7 @@
    "source": [
     "Impacts with process contributions\n",
     "\n",
-    "![impacts with process contribution](fig2.png)"
+    "![impacts with process contribution](figures/fig2.png)"
    ]
   },
   {
@@ -455,7 +494,7 @@
    "source": [
     "Impacts with breakdown by geographical location of impacts\n",
     "\n",
-    "![impacts with impacts origins](fig3.png)"
+    "![impacts with impacts origins](figures/fig3.png)"
    ]
   },
   {
@@ -465,7 +504,7 @@
    "source": [
     "Sum of impacts for the 5th, 50th and 95th quantiles\n",
     "\n",
-    "![impacts with uncertainty](fig1.png)"
+    "![impacts with uncertainty](figures/fig1.png)"
    ]
   },
   {
@@ -475,7 +514,7 @@
    "source": [
     "Comparison between two scenarios\n",
     "\n",
-    "![scenarios comparison](fig4.png)"
+    "![scenarios comparison](figures/fig4.png)"
    ]
   },
   {
@@ -534,7 +573,7 @@
    "source": [
     "Life cycle-based annual demand for cobalt, global electricity supply\n",
     "\n",
-    "![cobalt projection](fig5.png)"
+    "![cobalt projection](figures/fig5.png)"
    ]
   },
   {