Skip to content

Commit

Permalink
docs landing site beef up (#1465)
Browse files Browse the repository at this point in the history
  • Loading branch information
slayoo authored Dec 14, 2024
1 parent bcb51e0 commit 0c6190d
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 12 deletions.
File renamed without changes
2 changes: 1 addition & 1 deletion .github/pysdm_logo.svg → docs/logos/pysdm_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/markdown/pysdm_landing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

<img align="left" src="https://raw.githubusercontent.com/open-atmos/PySDM/main/.github/pysdm_logo.svg" width=150 height=219 alt="pysdm logo" style="padding-right:1em">
<img align="left" src="https://raw.githubusercontent.com/open-atmos/PySDM/main/docs/logos/pysdm_logo.svg" width=150 height=219 alt="pysdm logo" style="padding-right:1em">

PySDM offers a set of building blocks for development of atmospheric cloud
simulation systems revolving around the particle-based microphysics modelling concept
Expand Down
25 changes: 16 additions & 9 deletions docs/templates/index.html.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -24,25 +24,32 @@
<main class="pdoc">
<div style="display: flex; align-items: center;">
<a href="https://open-atmos.github.io/PySDM/index.html">
<img src="https://raw.githubusercontent.com/open-atmos/PySDM/main/.github/pysdm_logo.svg" style="height:10em" alt="PySDM logo">
<img src="https://raw.githubusercontent.com/open-atmos/PySDM/main/docs/logos/pysdm_logo.svg" style="height:10em" alt="PySDM logo">
</a>
<h1 style="padding-left: 0.5em; color: #13A4DE; font-weight: normal ">Documentation</h1>
</div>
<div style="padding-top: 2em">
<h2>What is PySDM?</h2>
<p>
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
(<a href="https://doi.org/10.1002/qj.441">Shima et al. 2009</a>), hence the name.
<video controls style="float:right; width:40%">
<source src="https://github.com/open-atmos/PySDM/wiki/files/animation_save.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
PySDM is a package for simulating the <mark>dynamics of population of particles undergoing diffusional and collisional growth (and breakage)</mark>.
The package features a Pythonic high-performance (multi-threaded CPU &amp; CUDA GPU) implementation of the <mark>Super-Droplet Method (SDM) Monte-Carlo algorithm</mark>
for representing collisional growth (<a href="https://doi.org/10.1002/qj.441">Shima et al. 2009</a>), hence the name.
It is intended to serve as a building block for simulation systems modelling <mark>fluid flows involving a dispersed phase</mark>,
with PySDM being responsible for representation of the dispersed phase.
Currently, the development is focused on atmospheric <mark>cloud physics applications</mark>, 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.
</p>
</div>
<div style="padding-top: 0.5em">
<h2>What is the difference between PySDM and PySDM-examples?</h2>
<p>
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.
</p>
<p>
PySDM-examples is a Python package that provides examples of how to use PySDM.
Expand Down Expand Up @@ -159,7 +166,7 @@ jupyter-notebook PySDM/examples</code></pre>
</p>
<p>
Development of PySDM was supported by:
<ul>
<ul style="list-style:square; margin-left:1em;">
<li><a href="https://www.fnp.org.pl/en/">Foundation for Polish Science</a> (grant no. POIR.04.04.00-00-5E1C/18 co-financed by the European Union under the European Regional Development Fund)</li>
<li><a href="https://ncn.gov.pl/en">Polish National Science Centre</a> (grant no. 2020/39/D/ST10/01220)</li>
<li><a href="https://science.energy.gov">US Department of Energy</a> via the <a href="https://www.krellinst.org/csgf/">Computational Science Graduate Fellowship</a> and via the <a href="https://asr.science.energy.gov/">Atmospheric System Research Program</a> (grant no. DE-SC0021034)</li>
Expand Down
2 changes: 1 addition & 1 deletion examples/docs/pysdm_examples_landing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

<img align="left" src="https://raw.githubusercontent.com/open-atmos/PySDM/main/.github/pysdm_logo.svg" width=150 height=219 alt="pysdm logo" style="padding-right:1em">
<img align="left" src="https://raw.githubusercontent.com/open-atmos/PySDM/main/docs/logos/pysdm_logo.svg" width=150 height=219 alt="pysdm logo" style="padding-right:1em">

PySDM examples are engineered as Jupyter Python notebooks supported by auxiliary Python commons
that constitute a separate <mark>PySDM-examples</mark> Python package which is also
Expand Down

0 comments on commit 0c6190d

Please sign in to comment.