Skip to main content

A package to simulate simple stochastic processes

Project description

stochrare

Documentation Status

This Python package aims at providing tools to study stochastic processes:

  • numerical integration of SDEs
  • numerical solver for the Fokker-Planck equations
  • first-passage time computation
  • instanton computation
  • rare event algorithms

Stochastic models arise in many scientific fields: physics, chemistry, biology, finance... Although the package was initially developed with an out-of-equilibrium statistical physics point of view, it aims at providing tools to support research with stochastic processes in any of these fields.

Scope

We have identified two main use cases:

  • interactive study of low-dimensional stochastic processes. This may be useful to study a model of a particular phenomenon arising in a research context, to develop new methods and algorithms, or for pedagogical use.
  • framework for designing streamlined workflows for reproducible numerical experiments. In this context, the package may be interfaced with more complex simulation codes (e.g. computational fluid dynamics, molecular dynamics,...), acting mostly as a wrapper providing flexibility while the heavy lifting is done by the underlying code.

Until now the code has been mostly developed and tested in the first context, but this should change soon...

The package may also contain code which could be of interest to study deterministic dynamical systems, although this is not the primary goal.

Documentation

Documentation in the doc directory can be compiled in various formats.

In the demo directory, some Jupyter notebooks illustrate the basic features of the package. More should be added soon, in particular for metastability or loss of stability problem and noise-induced transitions. These notebooks will include references to the relevant litterature.

Citation

We should soon write a metapaper describing the project. In the meantime, if you use the package for your research, we would appreciate if you could give credit by citing one of the research papers where the development of stochrare started:

@article{Herbert2017,
Author = {Herbert, Corentin and Bouchet, Freddy},
Doi = {10.1007/BF01106788},
Journal = {Phys. Rev. E},
Pages = {030201(R)},
Title = {{Predictability of escape for a stochastic saddle-node bifurcation: when rare events are typical}},
Volume = {96},
Year = {2017}}

for the core features, and

@article{Lestang2018,
Author = {Lestang, Thibault and Ragone, Francesco and Br{\'e}hier, Charles-Edouard and Herbert, Corentin and Bouchet, Freddy},
Doi = {10.1088/1742-5468/aab856},
Title = {{Computing return times or return periods with rare event algorithms}},
Journal = {J. Stat. Mech.},
Volume = {043213},
Year = {2018}}

for the AMS algorithm and return time computations.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stochrare-0.0.1.tar.gz (721.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stochrare-0.0.1-py3-none-any.whl (47.0 kB view details)

Uploaded Python 3

File details

Details for the file stochrare-0.0.1.tar.gz.

File metadata

  • Download URL: stochrare-0.0.1.tar.gz
  • Upload date:
  • Size: 721.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.20.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6

File hashes

Hashes for stochrare-0.0.1.tar.gz
Algorithm Hash digest
SHA256 cac8706ea8a7e95b210f3deef91a307fdfd1ebe54a6c900ed599e4d2d305ca25
MD5 b7c8d82a3a460f3921e6457fc11e167f
BLAKE2b-256 a5abdf4123775a3df409f0ebf683e245f0b68ae8eaf1c94b605821bc22ddd717

See more details on using hashes here.

File details

Details for the file stochrare-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: stochrare-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 47.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.20.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6

File hashes

Hashes for stochrare-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5a364e747d5e2938a7e7037d5106b6d0decbc51b0c2b3e0a6e3eb4d5cf32d3e5
MD5 7d8460d364b814eced09990ff68cdc4e
BLAKE2b-256 39941d1d0e1d13b941dcd583819345ec5728c802d037e10aaf47dd1608fde8c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page