Skip to main content

CuBIE

CUDA Batch Integration Engine for Python

Docs CUDA tests Python tests codecov PyPI version

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-cuda12
  • mlir-cuda13
  • cuda12
  • cuda13

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

cubie-0.6.0.tar.gz (673.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cubie-0.6.0-py3-none-any.whl (744.5 kB view details)

Uploaded Python 3

File details

Details for the file cubie-0.6.0.tar.gz.

File metadata

  • Download URL: cubie-0.6.0.tar.gz
  • Upload date:
  • Size: 673.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cubie-0.6.0.tar.gz
Algorithm Hash digest
SHA256 76afd1dc0d500afb7cfcfd0e5eaccb3a147e35b3ed6a1cf9cba74a7871a72ca7
MD5 63d5a7d15ec875da346d9eb66bfb142f
BLAKE2b-256 5a5223e028eba9753cb1a2415370885cbd787fc71ed700e8faaf6decec224d29

See more details on using hashes here.

Provenance

The following attestation bundles were made for cubie-0.6.0.tar.gz:

Publisher: ci_semver_manage.yml on cubiepy/cubie

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cubie-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: cubie-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 744.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cubie-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 667f804bcf1c12e0b51ae2e6fd87aea899197f122a6451869f4ce58a0580994f
MD5 eed1fde80a7688617c9649d6f303d872
BLAKE2b-256 ec9a08653c470f4322a9c73b3530e655e3888dd5a598502538562887dd2b0623

See more details on using hashes here.

Provenance

The following attestation bundles were made for cubie-0.6.0-py3-none-any.whl:

Publisher: ci_semver_manage.yml on cubiepy/cubie

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.13.0

2 files

0.12.0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.1

2 files

0.10.0

2 files

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

This release

0.6.0 This release

2 files

0.5.0

2 files

0.4.0

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page