Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: turczyneq
  • License: other
  • Language: Python
  • Default Branch: main
  • Size: 73.4 MB
Statistics
  • Stars: 2
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created over 1 year ago · Last pushed 9 months ago
Metadata Files
Readme License Citation

README.md

Tests

pypesh

This repository attempts to find a solution to advection diffusion problem

$$ 0 = \Delta \varphi - \mathrm{Pe} (u \cdot \nabla \varphi) $$

with $\varphi = 1$ for $z \to \infty$ and $\varphi = 0$ on a surface of the sphere and $\mathrm{Pe}$ denoting Peclet number. Final determined value is Sherwood number defined as

$$ \mathrm{Sh} = \frac{\Phi}{ 4 \pi D R}$$

Where $D$ is diffusion constant and $\Phi$ is flux falling onto the sphere.

Both approaches solving the same problem

(a) shows the flow field around the sphere. We use two approaches: (c) pychastic to generate and trace trajcetories of single particles and estimate the probability of hitting, which allows to calculate sherwood number. This however is expenive in time, so for smaller $\mathrm{Pe}$ we used (b) scikit-fem package to handle solving which requires rewriting equations in weak form.

How to cite

If you use pypesh in your research, please cite the associated article:

Turczynowicz, J., Waszkiewicz, R., Lisicki, M., and Somka, J. Bridging advection and diffusion in the encounter dynamics of sedimenting marine snow; arXiv (2025)

https://doi.org/10.48550/arXiv.2504.08992

bibtex @article{Turczynowicz_2025, title = {Bridging advection and diffusion in the encounter dynamics of sedimenting marine snow}, author = {Turczynowicz, Jan and Waszkiewicz, Radost and Lisicki, Maciej and Somka, Jonasz}, journal = {arXiv}, year = {2025}, doi = {10.48550/arXiv.2504.08992}, url = {https://doi.org/10.48550/arXiv.2504.08992} }

Examples

Usage as module

Basic usage ```Python python3 -m pypesh --peclet 1000 --ball_radius 0.9

```

Sample output: Sherwood for given parameters is 12.033892568100546

Usage as package

Install

Bash python3 -m pip install pypesh

Basic usage

Python import pypesh.pesh as psh psh.sherwood(peclet = 10**4, ball_radius = 0.9)

For advanced options go to: https://pypesh.readthedocs.io/en/latest/

License

Copyright (C) 2024 Radost Waszkiewicz and Jan Turczynowicz. This repository is published under GPL3.0 license.

Bibliography

  • Bubbles, Drops and Particles; R. Clift, J. Grace, M. Weber (1978)
  • Electrochemical measurements of mass transfer between a sphere and liquid in motion at high Peclet numbers; S. Kutateladze, V. Nakoryakov, M. Iskakov (1982)
  • Mass and heat transfer from fluid spheres at low Reynolds numbers; Z. Feng, E. Michaelides (2000)
  • Heat transfer from spheres to flowing media; H. Kramers (1946)

Owner

  • Login: turczyneq
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0

message: "If you use this software, please cite the associated article."

title: pypesh
type: software

authors:
  - given-names: Radost
    family-names: Waszkiewicz
    orcid: 'https://orcid.org/0000-0002-0376-1708'
  - given-names: Jan
    family-names: Turczynowicz
    orcid: 'https://orcid.org/0009-0002-8745-2298'

keywords:
  - advection-diffusion
  - stokes flow
  - marine snow

license: GPL-3.0

preferred-citation:
  type: article
  title: Bridging advection and diffusion in the encounter dynamics of sedimenting marine snow
  authors:
    - given-names: Jan
      family-names: Turczynowicz
      orcid: 'https://orcid.org/0009-0002-8745-2298'
    - given-names: Radost
      family-names: Waszkiewicz
      orcid: 'https://orcid.org/0000-0002-0376-1708'
    - given-names: Maciej
      family-names: Lisicki
      orcid: 'https://orcid.org/0000-0002-6976-0281'
    - given-names: Jonasz
      family-names: Słomka
      orcid: 'https://orcid.org/0000-0002-7097-5810'
  doi: 10.48550/arXiv.2504.08992
  date-released: 2025-04-11
  url: https://doi.org/10.48550/arXiv.2504.08992
  publisher:
    name: arXiv
  year: 2025
  journal: arXiv

GitHub Events

Total
  • Release event: 1
  • Watch event: 3
  • Push event: 98
  • Create event: 1
Last Year
  • Release event: 1
  • Watch event: 3
  • Push event: 98
  • Create event: 1

Dependencies

requirements.txt pypi
  • matplotlib *
  • meshio *
  • pygmsh *
  • scikit-fem *
.github/workflows/test.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
setup.py pypi
docs/requirements.txt pypi
  • matplotlib *
  • numpy *
  • pychastic *
  • pydata-sphinx-theme ==0.6.3
  • pygmsh *
  • scikit-fem *
  • scipy *
  • sphinx-copybutton ==0.3.1
  • sphinx-prompt ==1.4.0
  • sphinxcontrib-applehelp ==1.0.2
  • sphinxcontrib-devhelp ==1.0.2
  • sphinxcontrib-htmlhelp ==2.0.0
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-napoleon ==0.7
  • sphinxcontrib-qthelp ==1.0.3
  • sphinxcontrib-serializinghtml ==1.1.5