Skip to main content

Helper library and interactive anywidgets for the DartBrains fMRI course

Project description

dartbrains-tools

Helper library and interactive anywidgets for the DartBrains fMRI course. Extracted from the book repo so the widgets and helpers can be installed standalone — including in molab and pyodide/WASM marimo notebooks.

Install

pip install dartbrains-tools

# Optional: include marimo for notebook_utils.youtube()
pip install "dartbrains-tools[notebook]"

Modules

  • dartbrains_tools.data — load the Pinel Localizer dataset from the Hugging Face Hub.
  • dartbrains_tools.mr_simulations — Bloch equation solvers, signal generators, HRF, and Plotly visualization helpers.
  • dartbrains_tools.mr_widgets — 10 anywidgets for interactive MR physics teaching (PrecessionWidget, SpinEnsembleWidget, KSpaceWidget, ConvolutionWidget, EncodingWidget, CompassWidget, NetMagnetizationWidget, TransformCubeWidget, CostFunctionWidget, SmoothingWidget).
  • dartbrains_tools.notebook_utils — small marimo helpers (youtube).

Quick start

from dartbrains_tools.mr_widgets import PrecessionWidget

w = PrecessionWidget(b0=3.0, flip_angle=90.0)
w  # Interactive 3D Three.js animation in any anywidget host.
from dartbrains_tools.data import get_subjects, get_file, load_events

subjects = get_subjects()
bold = get_file("S01", "bold")
events = load_events("S01")

Development

git clone https://github.com/ljchang/dartbrains-tools
cd dartbrains-tools
uv sync
uv run pytest
uv build

License

MIT. The parent course materials at dartbrains remain CC-BY-SA-4.0; this companion library is permissive so it can be reused in any downstream project.

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

dartbrains_tools-0.1.3.tar.gz (43.1 kB view details)

Uploaded Source

Built Distribution

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

dartbrains_tools-0.1.3-py3-none-any.whl (49.3 kB view details)

Uploaded Python 3

File details

Details for the file dartbrains_tools-0.1.3.tar.gz.

File metadata

  • Download URL: dartbrains_tools-0.1.3.tar.gz
  • Upload date:
  • Size: 43.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dartbrains_tools-0.1.3.tar.gz
Algorithm Hash digest
SHA256 069abf3007b7fc9db3139d3cfb70248e3f58785e7e5a68a06165d4e3515d922c
MD5 42958a8584b3133c32bd53576fc4dd74
BLAKE2b-256 8cacad5829faf0518b6b015a411d07e10a121ba753d6454849608095a8a6f5c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for dartbrains_tools-0.1.3.tar.gz:

Publisher: publish.yml on ljchang/dartbrains-tools

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

File details

Details for the file dartbrains_tools-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for dartbrains_tools-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 386ee124b6892f0e59b72487c1d245c2b46eec5b88f5b79d88af874c989298f9
MD5 1be851dadbd4acd8ad60d73c0a5a3566
BLAKE2b-256 2743d415c936e5e0a5b25c88224ce0506cf982e0ccc79516ba2f3f939dbb1df1

See more details on using hashes here.

Provenance

The following attestation bundles were made for dartbrains_tools-0.1.3-py3-none-any.whl:

Publisher: publish.yml on ljchang/dartbrains-tools

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

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