Merge pull request #961 from flohorovicic/main_fw

Updated changes in main repo for consistency with documentation

Author: Leguark

docs/source/installation.rst

@@ -15,6 +15,21 @@ The latest release version of ``GemPy`` is available via **PyPi**. To install th
 
 This will install ``GemPy`` with the minimal required dependencies.
 
+GemPy viewer
+^^^^^^^^^^^^
+
+For visualization in 2-D and 3-D, the additional package ``gempy-viewer`` can be used and installed with:
+
+.. code-block:: bash
+
+     $ pip install gempy-viewer
+
+The 3-D visualization is based on `pyvista`. This package needs to be installed separately. Please check:
+
+- PyVista: Installation guide available on the `PyVista installation page <https://docs.pyvista.org/getting-started/installation.html>`_.
+
+
+
 Enhanced Installation Options
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -39,10 +54,8 @@ For additional features, ``GemPy`` offers enhanced installation options:
       $ pip install gempy[dev]
 
 
-Note: Some functionalities in ``GemPy`` require `PyTorch` and `pyvista`. These libraries need to be installed separately:
-
-- PyTorch: Follow the instructions on the `PyTorch installation page <https://pytorch.org/get-started/locally/>`_.
-- PyVista: Installation guide available on the `PyVista installation page <https://docs.pyvista.org/getting-started/installation.html>`_.
+Note: Some advanced functionalities in ``GemPy`` require `PyTorch`. For installation, please follow the
+instructions on the `PyTorch installation page <https://pytorch.org/get-started/locally/>`_.
 
 Manual Installation
 ^^^^^^^^^^^^^^^^^^^

examples/tutorials/z_other_tutorials/README.rst

@@ -1,4 +1,4 @@
-Other tutorials
+Video tutorials
 ---------------
 
-Compilation of tutorials that do not fit in the above categories.
+Compilation of tutorials for videos on the `gempy` YouTube channel https://www.youtube.com/@GemPy3D.

examples/tutorials/z_other_tutorials/video_tutorial_model_1.py

@@ -1,15 +1,51 @@
 """
-Modeling step by step
-^^^^^^^^^^^^^^^^^^^^^
+Video Tutorial "code-along": Modeling step by step
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This tutorial demonstrates step-by-step geological modeling using the `gempy` and `gempy_viewer` libraries.
 It follows the Video tutorial series available on the `gempy` YouTube channel (https://www.youtube.com/@GemPy3D).
 """
 
+
+# %%
+# Video tutorial 1: Introduction
+# """"""""""""""""""""""""""""""
+#
+# The first video is an introduction to GemPy - please view online before starting the tutorial.
+# 
+# https://youtu.be/3elCCHhARsU
+#
+#
+
+# %%
+#.. raw:: html
+#
+#    <iframe width="560" height="315" 
+#            src="https://www.youtube.com/embed/3elCCHhARsU" 
+#            title="YouTube video player" 
+#            frameborder="0" 
+#            allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" 
+#            allowfullscreen>
+#    </iframe>
+
+
 # %%
 # Video tutorial 2: Input data
 # """"""""""""""""""""""""""""
 
+# %%
+#.. raw:: html
+#
+#    <iframe width="560" height="315" 
+#            src="https://www.youtube.com/embed/yYwJVYy8ilw" 
+#            title="YouTube video player" 
+#            frameborder="0" 
+#            allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" 
+#            allowfullscreen>
+#    </iframe>
+
+
+
 # Required imports
 import gempy as gp
 import gempy_viewer as gpv
@@ -57,6 +93,17 @@
 # Video tutorial 3: Structural frame
 # """"""""""""""""""""""""""""""""""
 
+# %%
+#.. raw:: html
+#
+#    <iframe width="560" height="315" 
+#            src="https://www.youtube.com/embed/4rav3lb2AR8" 
+#            title="YouTube video player" 
+#            frameborder="0" 
+#            allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" 
+#            allowfullscreen>
+#    </iframe>
+
 # View structural frame
 geo_model.structural_frame
 
@@ -176,4 +223,6 @@
 # %%
 
 # Display the 3d model with topography
-gpv.plot_3d(geo_model, show_lith=True, show_topography=True)
+gpv.plot_3d(geo_model, show_lith=True, show_topography=True)
+
+# sphinx_gallery_thumbnail_number = -1