diff --git a/docs/templates/index.html.jinja2 b/docs/templates/index.html.jinja2 index e24538c3..6c5078cd 100644 --- a/docs/templates/index.html.jinja2 +++ b/docs/templates/index.html.jinja2 @@ -38,7 +38,8 @@ with optional coordinate transformations.

- A separate project called PyMPDATA-MPI depicts how numba-mpi can be used to enable distributed memory parallelism in PyMPDATA. + A separate project called PyMPDATA-MPI depicts how + numba-mpi can be used to enable distributed memory parallelism in PyMPDATA.

@@ -104,15 +105,25 @@ PyMPDATA is available on PyPI and can be installed using pip: 

pip install PyMPDATA
-

Note: the way above will not install PyMPDATA-examples, to install them both you can run:

- 
pip install PyMPDATA[tests]
-
+

Note: the way above will not install PyMPDATA-examples, to install them, and run the tests, likely the most convenient way is:

+ 
git clone https://github.com/open-atmos/PySDM.git
+pip install -e PyMPDATA[tests] -e PyMPDATA/examples[tests]
+pytest PyMPDATA
+
+

(the above should be a viable way to set up development environment for PyMPDATA, see also our Python dev hints Wiki for further information)

PyMPDATA-examples is available on PyPI and can be installed using pip: 

pip install PyMPDATA-examples
-

Note: this will also install PyMPDATA

-
+

Note: this will also install PyMPDATA if needed, but the examples package wheels do not include the Jupyter notebooks - only common code used from the notebooks. + All PyMPDATA example notebooks can be viewed on GitHub and feature header cells with badges enabling single-click execution on either + Google Colab or mybinder.org platforms. + To try the notebooks out locally, use: +

+ 
git clone https://github.com/open-atmos/PyMPDATA.git
+pip install -e PyMPDATA -e PyMPDATA/examples
+jupyter-notebook PyMPDATA/examples
+

Dependencies

@@ -140,6 +151,28 @@ feature (rather than the issue tracker) for seeking support in understanding, using and extending PyMPDATA code.

+
+
+

Licensing, credits, acknowledgements

+

+ PyMPDATA and PyMPDATA-examples are free/libre open-source software packages released under the + GNU GPL v3 license. +

+ Development of PyMPDATA was started by Piotr Bartman[-Szwarc], + Sylwester Arabas and collaborators + at the Jagiellonian University in Kraków. + For an overview of features of the initial release, see the + 2022 PyMPDATA v1 JOSS paper. + See list of code committers + for a complete list of contributors. +

+

+ Development of PySDM was supported by: +

+

{% include "search.html.jinja2" %}