From 0c6190dd9316a9406e92cafc701ea942c37230ac Mon Sep 17 00:00:00 2001 From: Sylwester Arabas Date: Sun, 15 Dec 2024 00:59:11 +0100 Subject: [PATCH] docs landing site beef up (#1465) --- {.github => docs/logos}/pysdm_logo.png | Bin {.github => docs/logos}/pysdm_logo.svg | 2 +- docs/markdown/pysdm_landing.md | 2 +- docs/templates/index.html.jinja2 | 25 +++++++++++++++--------- examples/docs/pysdm_examples_landing.md | 2 +- 5 files changed, 19 insertions(+), 12 deletions(-) rename {.github => docs/logos}/pysdm_logo.png (100%) rename {.github => docs/logos}/pysdm_logo.svg (99%) diff --git a/.github/pysdm_logo.png b/docs/logos/pysdm_logo.png similarity index 100% rename from .github/pysdm_logo.png rename to docs/logos/pysdm_logo.png diff --git a/.github/pysdm_logo.svg b/docs/logos/pysdm_logo.svg similarity index 99% rename from .github/pysdm_logo.svg rename to docs/logos/pysdm_logo.svg index 78569d965..65dae40a1 100644 --- a/.github/pysdm_logo.svg +++ b/docs/logos/pysdm_logo.svg @@ -1 +1 @@ - \ No newline at end of file + diff --git a/docs/markdown/pysdm_landing.md b/docs/markdown/pysdm_landing.md index c71e039a7..2518b4d92 100644 --- a/docs/markdown/pysdm_landing.md +++ b/docs/markdown/pysdm_landing.md @@ -1,6 +1,6 @@ # Introduction -pysdm logo +pysdm logo PySDM offers a set of building blocks for development of atmospheric cloud simulation systems revolving around the particle-based microphysics modelling concept diff --git a/docs/templates/index.html.jinja2 b/docs/templates/index.html.jinja2 index 1266fe1ea..05c492e3a 100644 --- a/docs/templates/index.html.jinja2 +++ b/docs/templates/index.html.jinja2 @@ -24,25 +24,32 @@
- PySDM logo + PySDM logo

Documentation

What is PySDM?

- PySDM is a package for simulating the dynamics of population of particles. - It is intended to serve as a building block for simulation systems modelling fluid flows involving a dispersed phase, with PySDM being responsible for representation of the dispersed phase. - Currently, the development is focused on atmospheric cloud physics applications, in particular on modelling the dynamics of particles immersed in moist air using the particle-based (a.k.a. super-droplet) approach to represent aerosol/cloud/rain microphysics. - The package features a Pythonic high-performance implementation of the Super-Droplet Method (SDM) Monte-Carlo algorithm for representing collisional growth - (Shima et al. 2009), hence the name. + + PySDM is a package for simulating the dynamics of population of particles undergoing diffusional and collisional growth (and breakage). + The package features a Pythonic high-performance (multi-threaded CPU & CUDA GPU) implementation of the Super-Droplet Method (SDM) Monte-Carlo algorithm + for representing collisional growth (Shima et al. 2009), hence the name. + It is intended to serve as a building block for simulation systems modelling fluid flows involving a dispersed phase, + with PySDM being responsible for representation of the dispersed phase. + Currently, the development is focused on atmospheric cloud physics applications, in particular on modelling the dynamics of + particles immersed in moist air using the particle-based (a.k.a. super-droplet) approach to represent aerosol/cloud/rain microphysics. + The key goal of PySDM is to enable rapid development and independent reproducibility of simulations in cloud microphysics + while being free from the two-language barrier commonly separating prototype and high-performance research code.

What is the difference between PySDM and PySDM-examples?

- PySDM is a Python package that provides the implementation of the Super-Droplet Method (SDM) Monte-Carlo algorithm. - It is a library that can be used in your own projects. + PySDM is a Python package that provides the implementation of SDM that can be used in your own projects.

PySDM-examples is a Python package that provides examples of how to use PySDM. @@ -159,7 +166,7 @@ jupyter-notebook PySDM/examples

Development of PySDM was supported by: -