CuBIE
CUDA Batch Integration Engine for Python
CuBIE performs numerical integration in parallel on NVIDIA GPUs. It provides a ~10000x*
speedup over functions like MATLAB's ode45 and SciPy's solve_ivp for parallel batch integrations,
while offering a similar interface to make it easy to switch from those environments.
Under the hood, cubie uses numba-cuda to compile
python integration algorithms and your provided ODE/DAE systems into GPU code
and ferry your data in between your computer and GPU. Python-side, it generates Jacobian-vector
product (JVP), residual, and preconditioner functions from your system of equations and folds those into
iterative linear or nonlinear solvers (depending on the algorithm you choose) which are compiled
into the final kernel. By treating the core math as code instead of evaluating it per-step,
cubie achieves a low memory footprint on the GPU, allowing you to fit more integrations
onto it at once.
Capabilities
- Define systems of ODE/DAEs as either Python functions, strings, SymPy symbolic expressions, or CellML 1.0/1.1 models.
- Use fixed- or adaptive-step explicit Runge-Kutta, diagonally implicit Runge-Kutta, fully implicit Runge-Kutta, and Rosenbrock-W methods.
- Structurally simplify DAEs with alias elimination, index reduction, and tearing before generating solver code (logic taken almost verbatim from ModelingToolkit.jl).
- Supply time-dependent forcing terms as functions or sampled (measured) arrays.
- Save selected states or algebraic variables (observables) to reduce result size
- Discard trajectories and calculate summary metrics on the GPU to keep only the relevant information and allow larger solves.
- Automatically divide large solves into chunks that can fit into your GPU, and arrays that can fit into your computers RAM, to allow REALLY large solves.
- Cache solvers between sessions, so you only pay the compile time once per config.
- Build combinatorial grids of parameters/initial conditions to solve over.
Installation
pip install "cubie[mlir-cuda13]"
The extra in square brackets installs the required CUDA dependencies. There are four options:
mlir-cuda12mlir-cuda13cuda12cuda13
We recommend mlir-cuda13 unless you have a specific reason to use the older
numba-cuda backend or the CUDA 12 toolkit.
CuBIE requires Python 3.11-3.14, an up-to-date NVIDIA driver, and an NVIDIA GPU
with compute capability 6.0 or later. Python 3.10 is supported only by the
numba-cuda backend. Pandas and Matplotlib support can be installed with
pip install "cubie[optional]".
Quick start
import numpy as np
from cubie import create_ODE_system, solve_ivp
system = create_ODE_system(
["dx = v", "dv = mu * (1 - x*x) * v - x"],
states={"x": 1.0, "v": 0.0},
parameters={"mu": 1.5},
)
result = solve_ivp(
system,
y0={"x": np.linspace(1.0, 2.0, 1024), "v": [0.0]},
parameters={"mu": np.linspace(1.0, 3.0, 1024)},
method="rk45",
duration=20.0,
atol=1e-6,
rtol=1e-3,
)
This integrates all 1,048,576 combinations of the 1,024 initial values and 1,024 parameter values. The first solve compiles and caches the CUDA kernels (~0.1s); later solves reuse them (~0.025s).
Documentation
The documentation covers system creation, batching, solver configuration, outputs, and performance.
Acknowledgements
- SciML/DifferentialEquations.jl — No code is directly ported from DifferentialEquations.jl, but I treat its solver suite as the authority on numerical integration. I check CuBIE's methods against it, and when an implementation is unclear I first look at how DifferentialEquations.jl handles it. See Rackauckas and Nie (2017).
- ModelingToolkit.jl — CuBIE's DAE tearing and structural-simplification implementation is a direct port of ModelingToolkit.jl's approach, adapted to CuBIE's symbolic IR and CUDA code generation. See Ma et al. (2021).
- cellmlmanip and chaste_codegen — Their work is used to import CellML models and detect and repair removable singularities in Goldman-Hodgkin-Katz-style equations. See Hendrix et al. (2022).
Contributing
Pull requests are welcome. Please open an issue before starting a major change so that the design can be discussed first.
* One million runs of the example above, on an RTX 4070 SUPER with an i7-12700: 29 ms in cubie, 47 minutes in SciPy (98,000×) and 2.7 minutes in MATLAB (5,500×). Using multiprocessing/parfor to run the integrations in parallel on the CPU, SciPy drops to 6 minutes (12,000×) and MATLAB to 1 minute (2,200×). Rough numbers from one machine.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cubie-0.10.0.tar.gz.
File metadata
- Download URL: cubie-0.10.0.tar.gz
- Upload date:
- Size: 711.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
603b25943c141b1fc7b9a7ea35f23845c69ae7e2426eb266a459af3f44abbce1
|
|
| MD5 |
2361e76617d7dfe50417fa32d1343f84
|
|
| BLAKE2b-256 |
798222713f810f5eef3246c7bb27b38d1d782e9f778134ef66c660f341e02e07
|
Provenance
The following attestation bundles were made for cubie-0.10.0.tar.gz:
Publisher:
ci_semver_manage.yml on cubiepy/cubie
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cubie-0.10.0.tar.gz -
Subject digest:
603b25943c141b1fc7b9a7ea35f23845c69ae7e2426eb266a459af3f44abbce1 - Sigstore transparency entry: 2591635535
- Sigstore integration time:
-
Permalink:
cubiepy/cubie@c7a0fa5f2fdbba60a9891b5af03a3e2f3fc611f6 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cubiepy
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_semver_manage.yml@c7a0fa5f2fdbba60a9891b5af03a3e2f3fc611f6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file cubie-0.10.0-py3-none-any.whl.
File metadata
- Download URL: cubie-0.10.0-py3-none-any.whl
- Upload date:
- Size: 787.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bf3121ee48c3f59f0ff195bf6535a38e1df7b359cceca73e8214b567cdb6c9e8
|
|
| MD5 |
00a0db79bea8631cee318c9a3c6f8375
|
|
| BLAKE2b-256 |
fb178abfd19133d578c2343e4163bcbb927ee35247554435e80b4525da03bafd
|
Provenance
The following attestation bundles were made for cubie-0.10.0-py3-none-any.whl:
Publisher:
ci_semver_manage.yml on cubiepy/cubie
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cubie-0.10.0-py3-none-any.whl -
Subject digest:
bf3121ee48c3f59f0ff195bf6535a38e1df7b359cceca73e8214b567cdb6c9e8 - Sigstore transparency entry: 2591635974
- Sigstore integration time:
-
Permalink:
cubiepy/cubie@c7a0fa5f2fdbba60a9891b5af03a3e2f3fc611f6 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cubiepy
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_semver_manage.yml@c7a0fa5f2fdbba60a9891b5af03a3e2f3fc611f6 -
Trigger Event:
push
-
Statement type: