Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/johnaparker/fplanck

Numerically solve the Fokker-Planck equation in N dimensions
https://github.com/johnaparker/fplanck

physics statistics stochastic

Last synced: 12 days ago
JSON representation

Numerically solve the Fokker-Planck equation in N dimensions

Host: GitHub
URL: https://github.com/johnaparker/fplanck
Owner: johnaparker
License: mit
Created: 2019-07-09T23:03:38.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-11-20T06:16:34.000Z (about 1 year ago)
Last Synced: 2024-12-12T07:35:44.454Z (19 days ago)
Topics: physics, statistics, stochastic
Language: Python
Size: 872 KB
Stars: 82
Watchers: 8
Forks: 27
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

[![PyPi Version](https://img.shields.io/pypi/v/fplanck)](https://pypi.org/project/fplanck/)
[![Conda Version](https://img.shields.io/conda/v/japarker/fplanck)](https://anaconda.org/japarker/fplanck)
[![tests](https://github.com/johnaparker/fplanck/actions/workflows/github-actions-pytest.yml/badge.svg)](https://github.com/johnaparker/fplanck/actions/workflows/github-actions-pytest.yml)

# 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](https://arxiv.org/pdf/1804.01285.pdf) and published in [APS](https://journals.aps.org/pre/abstract/10.1103/PhysRevE.99.032117).

## 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
![](https://github.com/johnaparker/fplanck/blob/master/img/ratchet.gif)
![](https://github.com/johnaparker/fplanck/blob/master/img/harmonic.gif)

**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.