chaotax 0.0.1__tar.gz

chaotax-0.0.1/.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: sudo apt-get install -y pandoc
+      - run: pip install -e ".[docs]"
+      - run: sphinx-build docs docs/_build -W --keep-going
+      - uses: actions/upload-pages-artifact@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          path: docs/_build
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+    steps:
+      - id: deploy
+        uses: actions/deploy-pages@v4

chaotax-0.0.1/.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: pre-commit/action@v3.0.1

chaotax-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,71 @@
+name: Publish Python Package
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: pip
+        cache-dependency-path: pyproject.toml
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install ".[test]"
+    - name: Run tests
+      run: |
+        python -m pytest tests/
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+        cache: pip
+        cache-dependency-path: pyproject.toml
+    - name: Install dependencies
+      run: |
+        pip install build
+    - name: Build
+      run: |
+        python -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-packages
+        path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch'
+    needs: [build]
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+    - name: Download distribution packages
+      uses: actions/download-artifact@v4
+      with:
+        name: python-packages
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

chaotax-0.0.1/.github/workflows/tests.yml

@@ -0,0 +1,20 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[test]"
+      - run: pytest --cov

chaotax-0.0.1/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# VS Code Settings
+.vscode/

chaotax-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

chaotax-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Felix Köhler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

chaotax-0.0.1/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: chaotax
+Version: 0.0.1
+Summary: Simple JAX-based tool to compute Lyapunov spectra and exponents of dynamical systems.
+Project-URL: repository, https://github.com/Ceyron/chaotax
+Author: Felix Koehler
+License-Expression: MIT
+License-File: LICENSE
+Keywords: chaos,dynamical-systems,jax,lyapunov,sciml
+Requires-Python: >=3.10
+Requires-Dist: jax>=0.4.13
+Requires-Dist: jaxtyping>=0.2.20
+Provides-Extra: docs
+Requires-Dist: exponax; extra == 'docs'
+Requires-Dist: furo; extra == 'docs'
+Requires-Dist: ipykernel; extra == 'docs'
+Requires-Dist: matplotlib; extra == 'docs'
+Requires-Dist: nbsphinx; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
+Provides-Extra: gpu
+Requires-Dist: jax[cuda12]>=0.8.0; extra == 'gpu'
+Provides-Extra: test
+Requires-Dist: equinox; extra == 'test'
+Requires-Dist: exponax; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="docs/_static/logo.svg" alt="chaotax logo" width="200">
+</p>
+
+**🚨 This is a pre-release for me to cite in my dissertation. It is based on
+software I once wrote for [APEBench](https://github.com/tum-pbs/apebench) (but
+did not yet have the time to release) slightly rewritten and enhanced. Please
+check back end of May 2026 for a full release with extended features,
+documentation, and examples.**
+
+<h1 align="center">
+    <span style="color: #f2614f;">chao</span><span style="color: #3b59b4;">tax</span>
+</h1>
+<h4 align="center">Simple <a href="https://github.com/google/jax" target="_blank">JAX</a>-based tool to compute Lyapunov spectra and exponents of dynamical systems using autodiff.</h4>
+
+<p align="center">
+<a href="https://pypi.org/project/chaotax/">
+  <img src="https://img.shields.io/pypi/v/chaotax.svg" alt="PyPI">
+</a>
+<a href="https://github.com/ceyron/chaotax/actions/workflows/tests.yml">
+  <img src="https://github.com/ceyron/chaotax/actions/workflows/tests.yml/badge.svg" alt="Tests">
+</a>
+<a href="https://fkoehler.site/chaotax/">
+  <img src="https://img.shields.io/badge/docs-latest-green" alt="docs-latest">
+</a>
+<a href="https://github.com/ceyron/chaotax/blob/main/LICENSE">
+  <img src="https://img.shields.io/badge/license-MIT-blue" alt="License">
+</a>
+</p>
+
+<p align="center">
+  <a href="#installation">Installation</a> •
+  <a href="#quickstart">Quickstart</a> •
+  <a href="#documentation">Documentation</a> •
+  <a href="#related">Related</a>
+</p>
+
+`Chaotax` estimates Lyapunov exponents and spectra of dynamical systems using
+[JAX](https://github.com/google/jax)'s automatic differentiation (JVP-based
+linearisation). It works with any one-step state transition function, is
+JIT-compilable, and GPU/TPU-ready.
+
+## Installation
+
+```bash
+pip install chaotax
+```
+
+Requires Python 3.10+ and JAX 0.4.13+. See the [JAX install guide](https://jax.readthedocs.io/en/latest/installation.html).
+
+## Quickstart
+
+Estimate the largest Lyapunov exponent of a system given a one-step transition
+function:
+
+```python
+import jax
+import jax.numpy as jnp
+import chaotax
+
+# Define a one-step stepper (e.g., Lorenz via RK4)
+def lorenz_stepper(u):
+    ...
+    return u_next
+
+u_0 = jnp.array([1.0, 0.0, 0.0])
+eps_0 = jax.random.normal(jax.random.PRNGKey(0), u_0.shape)
+
+estimate_le = chaotax.lyapunov(lorenz_stepper, rollout_steps=20_000, dt=0.01)
+le = estimate_le(u_0, eps_0)
+```
+
+Compute the full Lyapunov spectrum:
+
+```python
+estimate_spectrum = chaotax.lyapunov_spectrum(lorenz_stepper, rollout_steps=20_000, dt=0.01)
+spectrum = estimate_spectrum(u_0, eps_0=jnp.eye(3))
+# Returns exponents in descending order, e.g. [+, 0, -] for Lorenz
+```
+
+## Documentation
+
+Documentation is available at [fkoehler.site/chaotax](https://fkoehler.site/chaotax/).
+
+## Related
+
+- [Exponax](https://github.com/Ceyron/exponax) — Exponential and explicit time steppers for PDEs in JAX
+- [Picardax](https://github.com/Ceyron/picardax) — Time-implicit differentiable PDE solvers in JAX
+
+## License
+
+MIT, see [here](https://github.com/Ceyron/chaotax/blob/main/LICENSE).
+
+---
+
+> [fkoehler.site](https://fkoehler.site/) &nbsp;&middot;&nbsp;
+> GitHub [@ceyron](https://github.com/ceyron) &nbsp;&middot;&nbsp;
+> X [@felix_m_koehler](https://twitter.com/felix_m_koehler) &nbsp;&middot;&nbsp;
+> LinkedIn [Felix Koehler](https://www.linkedin.com/in/felix-koehler)

chaotax-0.0.1/README.md

@@ -0,0 +1,99 @@
+<p align="center">
+  <img src="docs/_static/logo.svg" alt="chaotax logo" width="200">
+</p>
+
+**🚨 This is a pre-release for me to cite in my dissertation. It is based on
+software I once wrote for [APEBench](https://github.com/tum-pbs/apebench) (but
+did not yet have the time to release) slightly rewritten and enhanced. Please
+check back end of May 2026 for a full release with extended features,
+documentation, and examples.**
+
+<h1 align="center">
+    <span style="color: #f2614f;">chao</span><span style="color: #3b59b4;">tax</span>
+</h1>
+<h4 align="center">Simple <a href="https://github.com/google/jax" target="_blank">JAX</a>-based tool to compute Lyapunov spectra and exponents of dynamical systems using autodiff.</h4>
+
+<p align="center">
+<a href="https://pypi.org/project/chaotax/">
+  <img src="https://img.shields.io/pypi/v/chaotax.svg" alt="PyPI">
+</a>
+<a href="https://github.com/ceyron/chaotax/actions/workflows/tests.yml">
+  <img src="https://github.com/ceyron/chaotax/actions/workflows/tests.yml/badge.svg" alt="Tests">
+</a>
+<a href="https://fkoehler.site/chaotax/">
+  <img src="https://img.shields.io/badge/docs-latest-green" alt="docs-latest">
+</a>
+<a href="https://github.com/ceyron/chaotax/blob/main/LICENSE">
+  <img src="https://img.shields.io/badge/license-MIT-blue" alt="License">
+</a>
+</p>
+
+<p align="center">
+  <a href="#installation">Installation</a> •
+  <a href="#quickstart">Quickstart</a> •
+  <a href="#documentation">Documentation</a> •
+  <a href="#related">Related</a>
+</p>
+
+`Chaotax` estimates Lyapunov exponents and spectra of dynamical systems using
+[JAX](https://github.com/google/jax)'s automatic differentiation (JVP-based
+linearisation). It works with any one-step state transition function, is
+JIT-compilable, and GPU/TPU-ready.
+
+## Installation
+
+```bash
+pip install chaotax
+```
+
+Requires Python 3.10+ and JAX 0.4.13+. See the [JAX install guide](https://jax.readthedocs.io/en/latest/installation.html).
+
+## Quickstart
+
+Estimate the largest Lyapunov exponent of a system given a one-step transition
+function:
+
+```python
+import jax
+import jax.numpy as jnp
+import chaotax
+
+# Define a one-step stepper (e.g., Lorenz via RK4)
+def lorenz_stepper(u):
+    ...
+    return u_next
+
+u_0 = jnp.array([1.0, 0.0, 0.0])
+eps_0 = jax.random.normal(jax.random.PRNGKey(0), u_0.shape)
+
+estimate_le = chaotax.lyapunov(lorenz_stepper, rollout_steps=20_000, dt=0.01)
+le = estimate_le(u_0, eps_0)
+```
+
+Compute the full Lyapunov spectrum:
+
+```python
+estimate_spectrum = chaotax.lyapunov_spectrum(lorenz_stepper, rollout_steps=20_000, dt=0.01)
+spectrum = estimate_spectrum(u_0, eps_0=jnp.eye(3))
+# Returns exponents in descending order, e.g. [+, 0, -] for Lorenz
+```
+
+## Documentation
+
+Documentation is available at [fkoehler.site/chaotax](https://fkoehler.site/chaotax/).
+
+## Related
+
+- [Exponax](https://github.com/Ceyron/exponax) — Exponential and explicit time steppers for PDEs in JAX
+- [Picardax](https://github.com/Ceyron/picardax) — Time-implicit differentiable PDE solvers in JAX
+
+## License
+
+MIT, see [here](https://github.com/Ceyron/chaotax/blob/main/LICENSE).
+
+---
+
+> [fkoehler.site](https://fkoehler.site/) &nbsp;&middot;&nbsp;
+> GitHub [@ceyron](https://github.com/ceyron) &nbsp;&middot;&nbsp;
+> X [@felix_m_koehler](https://twitter.com/felix_m_koehler) &nbsp;&middot;&nbsp;
+> LinkedIn [Felix Koehler](https://www.linkedin.com/in/felix-koehler)

chaotax-0.0.1/chaotax/__init__.py

@@ -0,0 +1,15 @@
+from ._lyapunov import (
+    lyapunov,
+    lyapunov_spectrum,
+    rollout_growth,
+    rollout_growth_spectrum,
+)
+from ._temporal_utils import repeat
+
+__all__ = [
+    "lyapunov",
+    "lyapunov_spectrum",
+    "rollout_growth",
+    "rollout_growth_spectrum",
+    "repeat",
+]