Metadata-Version: 2.1
Name: tornadox
Version: 0.0.1
Summary: UNKNOWN
Author: Nicholas Krämer, Nathanael Bosch, Jonathan Schmidt
License: MIT
Platform: UNKNOWN
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: contrib
License-File: LICENSE

# tornadox
Lightweight, probabilistic ODE solvers. Fast like the wind. 🌪️ Powered by JAX.


## Usage
Use `tornadox` as follows.

```python
import jax.numpy as jnp
from tornadox import ek0, ek1, init, step, ivp

# Create a solver. Any of the following work. 
# The signatures of all solvers coincide.
solver1 = ek0.KroneckerEK0()
solver2 = ek0.ReferenceEK0(num_derivatives=6)
solver3 = ek1.ReferenceEK1(initialization=init.TaylorMode())
solver4 = ek1.DiagonalEK1(initialization=init.RungeKutta())
solver5 = ek1.ReferenceEK1(num_derivatives=5, steprule=step.AdaptiveSteps())

# Solve an IVP
vdp = ivp.vanderpol(t0=0., tmax=1., stiffness_constant=1.0)

for solver in [solver1, solver2, solver3, solver4, solver5]:
    
    # Full solve
    print(solver)
    solver.solve(vdp)
    solver.solve(vdp, stop_at=jnp.array([1.2, 1.3]))
    
    # Only solve for the final state
    solver.simulate_final_state(vdp)
    
    # Or go straight to the generator
    for state, info in solver.solution_generator(vdp):
        pass
    print(info)
    
    print()
```


## Citation
The efficient implementation of ODE filters is explained in the paper ([link](https://arxiv.org/abs/2110.11812))
```
@misc{krämer2021probabilistic,
      title={Probabilistic ODE Solutions in Millions of Dimensions}, 
      author={Nicholas Krämer and Nathanael Bosch and Jonathan Schmidt and Philipp Hennig},
      year={2021},
      eprint={2110.11812},
      archivePrefix={arXiv},
      primaryClass={stat.ML}
}
```
Please consider citing it if you use this repository for your research.


