Metadata-Version: 2.4
Name: jax_zero_contour
Version: 2.0.0
Summary: Find and follow a zero value contour for any 2D function written in Jax.
Author-email: Coleman Krawczyk <coleman.krawczyk@port.ac.uk>
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
License-File: LICENSE
Requires-Dist: jax >=0.4.0
Requires-Dist: jaxlib >=0.4.0
Requires-Dist: matplotlib ; extra == "doc"
Requires-Dist: myst-nb >=0.15.0 ; extra == "doc"
Requires-Dist: sphinx >=4.5.0 ; extra == "doc"
Requires-Dist: sphinx_rtd_theme >=1.0.0 ; extra == "doc"
Requires-Dist: coverage[toml] >=6.3.2 ; extra == "test"
Requires-Dist: Flake8-pyproject >=1.2.3 ; extra == "test"
Project-URL: Home, https://github.com/CKrawczyk/Jax-Zero-Contour
Provides-Extra: doc
Provides-Extra: test

[![DOI](https://zenodo.org/badge/976508586.svg)](https://doi.org/10.5281/zenodo.15410802)

# Jax-Zero-Contour

Find and follow a zero value contour for any 2D function written in Jax.  This package provides a function that takes in any 2D Jax function, its gradient, and an initial guess, finds the closest zero of the function, and follows that zero contour with a fixed step size until it either:

1. closes back on itself
2. hits an end point (e.g. a discontinuity in the function)
3. reaches some maximum number of steps

See the [documentation](https://ckrawczyk.github.io/Jax-Zero-Contour/) for more details.

## Installation

```bash
pip install jax_zero_contour
```


