Merge pull request #96 from brightway-lca/matrix_drawing_carousel

Matrix drawing carousel
brightway-lca · Sep 19, 2024 · 0eedbc5 · 0eedbc5
2 parents c8f9506 + 1d16c07
commit 0eedbc5
Show file tree

Hide file tree

Showing 13 changed files with 24,662 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,6 +45,8 @@
     "sphinx_favicon",
     # copy button on code blocks
     "sphinx_copybutton",
+    # carousels
+    "sphinx_carousel.carousel",
 ]
 
 autoapi_dirs = ["../bw_timex"]

diff --git a/docs/content/data/matrix0_dark.svg b/docs/content/data/matrix0_dark.svg
diff --git a/docs/content/data/matrix0_light.svg b/docs/content/data/matrix0_light.svg
diff --git a/docs/content/data/matrix1_dark.svg b/docs/content/data/matrix1_dark.svg
diff --git a/docs/content/data/matrix1_light.svg b/docs/content/data/matrix1_light.svg
diff --git a/docs/content/data/matrix2_dark.svg b/docs/content/data/matrix2_dark.svg
diff --git a/docs/content/data/matrix2_light.svg b/docs/content/data/matrix2_light.svg
diff --git a/docs/content/data/matrix3_dark.svg b/docs/content/data/matrix3_dark.svg
diff --git a/docs/content/data/matrix3_light.svg b/docs/content/data/matrix3_light.svg
diff --git a/docs/content/data/matrix4_dark.svg b/docs/content/data/matrix4_dark.svg
diff --git a/docs/content/data/matrix4_light.svg b/docs/content/data/matrix4_light.svg
diff --git a/docs/content/theory.md b/docs/content/theory.md
@@ -209,21 +209,64 @@ created:
     `TimexLCA.dynamic_inventory_df` contain the emissions of the system
     per biosphere flow including its timestamp and its emitting process.
 
-```{admonition} Example: Matrix modifications
+````{admonition} Example: Matrix modifications
 :class: admonition-example
-For the simple system above, a schematic representation of the matrix
-modifications looks like this:
-~~~{image} data/matrix_stuff_light.svg
-:class: only-light
+:name: example-matrix-modifications
+For the simple system above, these are the modifications we apply to the matrices:
+
+:::{div} only-light
+```{carousel}
+:show_controls:
+:show_indicators:
+:show_dark:
+:show_fade:
+:data-bs-interval: false
+
+~~~{image} data/matrix1_light.svg
+:align: center
+~~~
+~~~{image} data/matrix2_light.svg
+:align: center
+~~~
+~~~{image} data/matrix3_light.svg
+:align: center
+~~~
+~~~{image} data/matrix4_light.svg
+:align: center
+~~~
+```
+:::
+
+:::{div} only-dark
+```{carousel}
+:show_controls:
+:show_indicators:
+:show_fade:
+:data-bs-interval: false
+
+~~~{image} data/matrix1_dark.svg
 :align: center
+:class: only-dark
+~~~
+~~~{image} data/matrix2_dark.svg
+:align: center
+:class: only-dark
 ~~~
-~~~{image} data/matrix_stuff_dark.svg
+~~~{image} data/matrix3_dark.svg
+:align: center
 :class: only-dark
+~~~
+~~~{image} data/matrix4_dark.svg
 :align: center
+:class: only-dark
 ~~~
+```
+:::
+
+</br>
 
 The inventory information from the time-explicit databases is inserted into the matrices. For each specific point in time that product b is demanded, temporal markets are created, distributing the demand for b between the time-explicit databases. The dynamic biosphere matrix is created, containing the timing of emissions. You can see that the CO2 emission at process A occurs both in 2024 and 2025, based on the temporal distribution on this biosphere exchange.
-```
+````
 
 ## Static or dynamic impact assessment
 

diff --git a/docs/environment.yaml b/docs/environment.yaml
@@ -21,3 +21,5 @@ dependencies:
   - sphinx-copybutton=0.5.2 # for copy button in code blocks # https://anaconda.org/conda-forge/sphinx-copybutton/files
   # build process
   - sphinx-autobuild=2024.4.16 # live-html support # https://anaconda.org/conda-forge/sphinx-autobuild/files
+  - pip:
+    - sphinx-carousel=1.2.0 # for carousel support # https://pypi.org/project/sphinx-carousel/