hj_reachability: Hamilton-Jacobi reachability analysis in JAX
This package implements numerical solvers for Hamilton-Jacobi (HJ) Partial Differential Equations (PDEs) which, in the context of optimal control, may be used to represent the continuous-time formulation of dynamic programming. Specifically, the focus of this package is on reachability analysis for zero-sum differential games modeled as Hamilton-Jacobi-Isaacs (HJI) PDEs, wherein an optimal controller and (optional) disturbance interact, and the set of reachable states at any time is represented as the zero sublevel set of a value function realized as the viscosity solution of the corresponding PDE.
This package is inspired by a number of related projects, including:
- A Toolbox of Level Set Methods (
toolboxls, MATLAB) - An Optimal Control Toolbox for Hamilton-Jacobi Reachability Analysis (
helperOC, MATLAB) - Berkeley Efficient API in C++ for Level Set methods (
beacls, C++/CUDA C++) - Optimizing Dynamic Programming-Based Algorithms (
optimized_dp, python)
Installation
This package accommodates different JAX versions (i.e., CPU-only vs. JAX with GPU support); if accelerator support is desired you should first install JAX according to the relevant installation instructions. A minimum JAX version requirement is listed in requirements.txt, but in general this package should be compatible with the latest JAX releases (please file an issue if you find that this is no longer the case!).
If you only want CPU computation or have already installed JAX with your preferred accelerator support, you may install this package using pip:
pip install --upgrade hj-reachability
TODOs
Aside from the specific TODOs scattered throughout the codebase, a few general TODOs:
- Single-line docstrings (at a bare minimum) for everything. Test coverage, book/paper references, and proper documentation to come... eventually.
- Look into using
jax.pmap/jax.lax.ppermutefor multi-device parallelism; see, e.g., jax demo notebooks. - Incorporate neural-network-based PDE solvers; see, e.g., Bansal, S. and Tomlin, C. "DeepReach: A Deep Learning Approach to High-Dimensional Reachability." (2020).
Metadata
Release files for hj-reachability 0.7.0
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 | |
|---|---|---|---|---|
| hj_reachability-0.7.0.tar.gz | 19.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hj_reachability-0.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 42.4 kB
Release files / hj_reachability-0.7.0.tar.gz
| Download URL | hj_reachability-0.7.0.tar.gz |
|---|---|
| Size | 19.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f90d4aa25eba1fa661aa7a311ec4924274fa1a0074cbb57e1495202875d37335
|
|
BLAKE2b-256 checksum How to use checksums |
c25dab3f2d9b3b78466af78af8855a297d04a18ddd07854d74c3a14e366cbd6d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / hj_reachability-0.7.0-py3-none-any.whl
| Download URL | hj_reachability-0.7.0-py3-none-any.whl |
|---|---|
| Size | 23.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
22a0bc69203037aafd7cbc40585bc023d9dab2b259d623fe5cd3f8ed5c8965b1
|
|
BLAKE2b-256 checksum How to use checksums |
d2b176bf23b54a8846822572f8b97a488b77b0fea06def1277c118a52026c6d4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Security for hj-reachability 0.7.0
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.