Skip to main content

Modeling tools for brain simulation.

Project description

Modeling tools for brain simulation

Header image of braintools.

Supported Python Version LICENSE Documentation Status PyPI version Continuous Integration DOI

braintools is a lightweight, JAX-friendly toolbox with practical utilities for brain modeling.

Highlights

  • Composable connectivity: declarative builders for point, multi-compartment, and population networks with spatial kernels, degree constraints, and unit-aware metadata
  • Visualization suite: publication plots, interactive dashboards, 3D viewers, and animation helpers in braintools.visualize
  • Metrics and solvers: losses, evaluation metrics, and PyTree-aware ODE/SDE/DDE integrators ready for jit/vmap
  • Signal and optimization helpers: reusable generators and lightweight optimizers to prototype models quickly

braintools integrates smoothly with the broader ecosystem (e.g., brainstate, brainunit) while keeping a simple, functional style.

Installation

pip install -U braintools

Optional extras are published for hardware-specific builds:

pip install -U braintools[cpu]
# CUDA 12.x wheels
pip install -U braintools[cuda12]
# TPU runtime
pip install -U braintools[tpu]

Alternatively, install the curated BrainX bundle that ships with braintools and related projects:

pip install -U BrainX

Documentation

The full documentation is available at https://braintools.readthedocs.io

Ecosystem

braintools is one part of our brain simulation ecosystem: https://brainmodeling.readthedocs.io/

Contributing

Contributions and issue reports are welcome! See CONTRIBUTING.md for guidelines.

License

Apache 2.0. See LICENSE for details.

Citation

If you use braintools in your work, please cite the Zenodo DOI: 10.5281/zenodo.17110064

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

braintools-0.1.8.tar.gz (514.9 kB view details)

Uploaded Source

Built Distribution

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

braintools-0.1.8-py3-none-any.whl (622.5 kB view details)

Uploaded Python 3

File details

Details for the file braintools-0.1.8.tar.gz.

File metadata

  • Download URL: braintools-0.1.8.tar.gz
  • Upload date:
  • Size: 514.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for braintools-0.1.8.tar.gz
Algorithm Hash digest
SHA256 17b4a0511944b91ddc15addfe83c6966d6698bd43b13ac6e32534f5463c756e1
MD5 285f1a885fafb640402ac3cbfe770e52
BLAKE2b-256 f63fcc3790504c959bfeeb635ca299f013f93175a322fd9eed9db17e777f9752

See more details on using hashes here.

File details

Details for the file braintools-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: braintools-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 622.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for braintools-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 dc4dc619896bb6a4291c4515362ffbbf8cbc17b5e0e3045ad5322f8d1e44353f
MD5 f57744138332c74a2451b5d19934bf46
BLAKE2b-256 b0f8d1275e6fb8eee7b8eca0db06127a9072f4046e162ffa85af9aad0faa6a61

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page