semvec/pypi-packages huggingface dataset:
fplanck 1.0.2
Solve the Fokker-Planck equation in N dimensions
Requires Python: >=3.12.0

[![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:

<p align="center">
  <img src="https://github.com/johnaparker/fplanck/blob/master/img/FokkerPlanck.svg">
</p>

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
```

## 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.
hexdoc-hextrace 0.1.0.1.20.1.1.0
Hex Trace addon for Hex Casting
Requires Python: >=3.12
Keywords: hexdoc

# hexdoc-hextrace

Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hex Trace.

Hex Trace addon for Hex Casting

## Version scheme

We use [hatch-gradle-version](https://pypi.org/project/hatch-gradle-version) to generate the version number based on whichever mod version the docgen was built with.

The version is in this format: `mod-version.python-version.mod-pre.python-dev.python-post`

For example:
* Mod version: `0.11.1-7`
* Python package version: `1.0.dev0`
* Full version: `0.11.1.1.0rc7.dev0`

## Setup

Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:

```sh
uv sync

.\.venv\Scripts\activate   # Windows
. .venv/bin/activate.fish  # fish
source .venv/bin/activate  # everything else
```

## Usage

For local testing, create a file called `.env` in the repo root following this template:

```sh
GITHUB_REPOSITORY=DucklingVivi/HexTrace
GITHUB_SHA=main
GITHUB_PAGES_URL=https://ducklingvivi.github.io/HexTrace
```

Useful commands:

```sh
# update your Python environment and lockfile if you added new dependencies
uv sync

# show help
hexdoc -h

# render and serve the web book in watch mode
nodemon --config doc/nodemon.json

# render and serve the web book
hexdoc serve

# build and merge the web book
hexdoc build
hexdoc merge

# start the Python interpreter with some extra local variables
hexdoc repl
```