Data

Tools

Indexes

Applications

Experiments

Open Source Science

fplanck

Numerically solve the Fokker-Planck equation in N dimensions

https://github.com/johnaparker/fplanck

Science Score: 59.0%

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

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: arxiv.org, aps.org
  • ✓
    Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary

Keywords

physics statistics stochastic
Last synced: 6 months ago · JSON representation

Repository

Numerically solve the Fokker-Planck equation in N dimensions

Basic Info
  • Host: GitHub
  • Owner: johnaparker
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 872 KB
Statistics
  • Stars: 93
  • Watchers: 8
  • Forks: 30
  • Open Issues: 7
  • Releases: 0
Topics
physics statistics stochastic
Created over 6 years ago · Last pushed over 2 years ago
Metadata Files
Readme License

README.md

PyPi Version Conda Version tests

FPlanck

FPlanck is a Python library for numerically solving the Fokker-Planck partial differential equation (also known as the Smoluchowski equation) in N dimensions using a matrix numerical method:

The method is based on the paper "Physically consistent numerical solver for time-dependent Fokker-Planck equations" by V. Holubec, K. Kroy, and S. Steffenoni, available on arXiv and published in APS.

Features

  • Can specify an external potential (conservative) and force field (non-conservative) in N-dimensions
  • Solve for the steady-state probability distribution and probability currents
  • Propagate any initial probability distribution to the solution at any later time
  • Periodic and reflecting boundary conditions (can be mixed along different dimensions)

Installation

FPlanck can be installed with pip shell pip install fplanck or conda shell conda install -c japarker fplanck

Examples

On the left: a single particle in a titled periodic potential with periodic boundary conditions. The animation shows the time evolution of the probability distribution for the particle location. The PDF is driven in the positive direction due to the tilted potential.

On the right: a single particle in a 2D harmonic potential. The particle is initially away from the center of the harmonic well, and over time is restored to the center.

Usage

See the examples folder for how to use FPlanck.

License

FPlanck is licensed under the terms of the MIT license.

References

[1] Wikipedia contributors, "Fokker–Planck equation," Wikipedia, The Free Encyclopedia, https://en.wikipedia.org/w/index.php?title=Fokker%E2%80%93Planck_equation&oldid=906834519

[2] Holubec, V., Kroy, K. and Steffenoni, S., 2019. Physically consistent numerical solver for time-dependent Fokker-Planck equations. Physical Review E, 99(3), p.032117.

Owner

  • Name: John Parker
  • Login: johnaparker
  • Kind: user
  • Company: Evozyne

Software Engineer, Evozyne

GitHub Events

Total
  • Watch event: 13
  • Fork event: 2
Last Year
  • Watch event: 13
  • Fork event: 2

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 37
  • Total Committers: 1
  • Avg Commits per committer: 37.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
John j****r@u****u 37
Committer Domains (Top 20 + Academic)
uchicago.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 10
  • Total pull requests: 1
  • Average time to close issues: 4 months
  • Average time to close pull requests: N/A
  • Total issue authors: 9
  • Total pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • johnaparker (2)
  • kirillchertoganov (1)
  • JiejunHu (1)
  • WeiZhang111 (1)
  • icedebris (1)
  • cruzchue (1)
  • SBolo (1)
  • boyanpenkov (1)
  • alxgom (1)
Pull Request Authors
  • johnaparker (1)
Top Labels
Issue Labels
bug (1) enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 50 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 3
  • Total maintainers: 1
pypi.org: fplanck

Solve the Fokker-Planck equation in N dimensions

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 50 Last month
Rankings
Forks count: 7.5%
Stargazers count: 8.3%
Dependent packages count: 10.0%
Average: 16.1%
Dependent repos count: 21.7%
Downloads: 32.8%
Maintainers (1)
japarker
Last synced: 6 months ago

Dependencies

.github/workflows/github-actions-pytest.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
setup.py pypi