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
pip install fplanck
or conda
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.
Metadata
Release files for fplanck 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| fplanck-0.2.2.tar.gz | 6.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fplanck-0.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.1 kB
Release files / fplanck-0.2.2.tar.gz
| Download URL | fplanck-0.2.2.tar.gz |
|---|---|
| Size | 6.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
907f38867e02b5b97c0a1aac94fe3fc71d0627c98b6f53f9b1e4c5578d01bfa0
|
|
BLAKE2b-256 checksum How to use checksums |
4ef0fbc7fada445bc91c070f234cdcbb7e85bc5f2b053cd10938ab0c4d231026
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.6
|
Release files / fplanck-0.2.2-py3-none-any.whl
| Download URL | fplanck-0.2.2-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5576ce9fa875fd604a386f33a5ba2ef10a7f16456a19df8a55f283c219507369
|
|
BLAKE2b-256 checksum How to use checksums |
5b96774e424fd97b2d935070dfdae4f239b857e1764f4d1966e8b525cd310e8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.6
|
Security for fplanck 0.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.