fixing inclusion of examples landing page in MANIFEST.in (for sdist t…

…o work) + add one more animation (open-atmos#470)
Caastlefox · Oct 25, 2024 · 6100931 · 6100931
1 parent 8fff7ce
commit 6100931
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 6 deletions.
diff --git a/examples/MANIFEST.in b/examples/MANIFEST.in
@@ -1 +1,2 @@
 global-exclude *.ipynb
+include docs/*.md
diff --git a/examples/PyMPDATA_examples/__init__.py b/examples/PyMPDATA_examples/__init__.py
@@ -1,5 +1,5 @@
 """
-.. include:: ../../docs/markdown/pympdata_examples_landing.md
+.. include:: ../docs/pympdata_examples_landing.md
 """
 
 from importlib.metadata import PackageNotFoundError, version

diff --git a/docs/markdown/pympdata_examples_landing.md → examples/docs/pympdata_examples_landing.md b/docs/markdown/pympdata_examples_landing.md → examples/docs/pympdata_examples_landing.md
@@ -25,10 +25,10 @@ The examples are grouped by the dimensionality of the computational grid.
 | tags                                                                                                                                                                                                                                                                                                    | link                                                                                                                                                                                                                                                                                                   |
 |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | <mark>advection-diffusion equation</mark><br/>$$ \partial_t (\psi) + \nabla \cdot (u \psi) + \mu \Delta (\psi) = 0 $$                                                                                                                                                                                   | `PyMPDATA_examples.advection_diffusion_2d`*<br/><img src="https://github.com/open-atmos/PyMPDATA/releases/download/tip/advection_diffusion.gif" width="50%" alt="adv-diff">                                                                                                                            |
-| <mark>Spectral-spatial advection</mark>, particle population condensational growth in a vertical column of air, time dependent flow                                                                                                                                                                     | `PyMPDATA_examples.Shipway_and_Hill_2012`                                                                                                                                                                                                                                                              |
+| <mark>Spectral-spatial advection</mark>, particle population condensational growth in a vertical column of air, time dependent flow                                                                                                                                                                     | `PyMPDATA_examples.Shipway_and_Hill_2012`<br/><img src="https://github.com/open-atmos/PyMPDATA/wiki/files/KiD-1D_PyMPDATA_n_iters=3.gif" width="50%" alt="spectral-spatial">                                                                                                                           |
 | <mark>shallow-water equations</mark><br/>$$\begin{eqnarray} \partial_t h + \partial_x (uh) + \partial_y (vh) &=& 0~  \\\ \partial_t (uh) + \partial_x ( uuh) + \partial_y (vuh) &=& - h \partial_x h~ \\\ \partial_t (vh) + \partial_x ( uvh) + \partial_y (vvh) &=& - h \partial_y h~ \end{eqnarray}$$ | `PyMPDATA_examples.Jarecka_et_al_2015`*                                                                                                                                                                                                                                                                |
 | <mark>advection equation</mark>, solid body rotation                                                                                                                                                                                                                                                    | `PyMPDATA_examples.Molenkamp_test_as_in_Jaruga_et_al_2015_Fig_12`*                                                                                                                                                                                                                                     |
-| <mark>advection equation</mark>, coordinate transformation, spherical coordinates, see also examples in [PYMPDATA-MPI](https://pypi.org/project/PyMPDATA-MPI/) $$ \partial_t (G \psi) + \nabla \cdot (Gu \psi) = 0 $$                                                                                   | `PyMPDATA_examples.Williamson_and_Rasch_1989_as_in_Jaruga_et_al_2015_Fig_14`<br><img src="https://github.com/open-atmos/PyMPDATA-MPI/releases/download/latest-generated-plots/n_iters.1_rank_0_size_1_c_field_.0.5.0.25._mpi_dim_0_n_threads_1-SphericalScenario-anim.gif", width="50%" alt="mpi-gif"> |
+| <mark>advection equation</mark>, coordinate transformation, spherical coordinates, see also examples in [PyMPDATA-MPI](https://pypi.org/project/PyMPDATA-MPI/) $$ \partial_t (G \psi) + \nabla \cdot (Gu \psi) = 0 $$                                                                                   | `PyMPDATA_examples.Williamson_and_Rasch_1989_as_in_Jaruga_et_al_2015_Fig_14`<br><img src="https://github.com/open-atmos/PyMPDATA-MPI/releases/download/latest-generated-plots/n_iters.1_rank_0_size_1_c_field_.0.5.0.25._mpi_dim_0_n_threads_1-SphericalScenario-anim.gif", width="50%" alt="mpi-gif"> |
 
 ## in 3D
 | tags                                                                                                                                | link                                   |

diff --git a/examples/setup.py b/examples/setup.py
@@ -8,9 +8,7 @@
 
 def get_long_description():
     """returns contents of the pdoc landing site with pdoc links converted into URLs"""
-    with open(
-        "../docs/markdown/pympdata_examples_landing.md", "r", encoding="utf8"
-    ) as file:
+    with open("docs/pympdata_examples_landing.md", "r", encoding="utf8") as file:
         pdoc_links = re.compile(
             r"(`)([\w\d_-]*).([\w\d_-]*)(`)", re.MULTILINE | re.UNICODE
         )