How pinton-lab/ultraneuron works
Ultraneuron predicts ultrasound-evoked neural activity from acoustic, displacement, and temperature fields, producing voxel-wise firing maps and validation reports. Its canonical workflow runs acoustic propagation, derives elastic displacement and bioheat fields, converts strain to membrane tension, simulates neural responses, then builds reports and mechanism/sensitivity comparisons. The README documents these stages; source excerpts and the source index support the internal model and report connections. Upstream physics solvers are external, and some documented driver details are unsampled.
Main entry points: report_builder.py Report builder · multicompartment.py Multi-compartment HH · run_neural_sim.py Voxel simulation · acoustic_outputs.py Acoustic outputs
Components 34
Field generation
- Acoustic FDTD
scripts/run_halle_dacc_fdtd.py - Pressure rescaling
scripts/rescale_propagation_map.py - ARF recompute
scripts/recompute_arf.py - Shear FDTD
scripts/rerun_shear_fdtd.py - Pennes bioheat
scripts/run_bioheat.py
Cell simulation
- Voxel simulation
scripts/run_neural_sim.py - Strain conversion
ultraneuron/strain.py - Point HH neuron
ultraneuron/neuron.py - Multi-compartment HH
ultraneuron/multicompartment.py - CUDA kernels
ultraneuron/cuda_backend.py
Neural mechanisms
- Mechanosensitive channels
ultraneuron/channels.py - Channel presets
ultraneuron/channel_library.py - Calcium pool
ultraneuron/calcium.py - NICE cavitation
ultraneuron/nice.py - TRP thermosensors
ultraneuron/thermosensors.py - Astrocyte relay
ultraneuron/astrocyte.py - Synaptic transmission
ultraneuron/synapse.py - NMDA receptor
ultraneuron/nmda.py - Soliton alternative
ultraneuron/soliton.py
Validation reports
- Report builder
validation_report/report_builder.py - Acoustic outputs
validation_report/builders/acoustic_outputs.py - Elastic outputs
validation_report/builders/elastic_outputs.py - Neural outputs
validation_report/builders/neural_outputs.py - Thermal outputs
validation_report/builders/thermal_outputs.py - Astrocyte outputs
validation_report/builders/astrocyte_outputs.py - Synaptic outputs
validation_report/builders/synaptic_outputs.py - Displacement outputs
validation_report/builders/displacement_outputs.py - Wave animation
validation_report/builders/wave_animation.py
Integration support
- Parameter provenance
ultraneuron/provenance.py - Anatomical registration
ultraneuron/registration.py - External path resolution
ultraneuron/paths.py
Other components
- Researcher
- External field solvers
- Voxel firing maps
Connections 39
- Researcher → Acoustic FDTD: runs
- External field solvers → Acoustic FDTD: produces fields
- Acoustic FDTD → Pressure rescaling: pressure history
- Pressure rescaling → ARF recompute: rescaled pressure
- ARF recompute → Shear FDTD: radiation force
- Shear FDTD → Voxel simulation: displacement field
- Shear FDTD → Pennes bioheat: simulation inputs
- Pennes bioheat → Voxel simulation: temperature field
- Voxel simulation → Strain conversion: converts strain
- Strain conversion → Mechanosensitive channels: drives gating
- Channel presets → Mechanosensitive channels: defines presets
ultraneuron/channel_library.py - Multi-compartment HH → Mechanosensitive channels: uses channels
ultraneuron/multicompartment.py - Point HH neuron → Mechanosensitive channels: uses channels
ultraneuron/neuron.py - Multi-compartment HH → Calcium pool: uses calcium
ultraneuron/multicompartment.py - Multi-compartment HH → NICE cavitation: uses NICE model
ultraneuron/multicompartment.py - Multi-compartment HH → TRP thermosensors: uses thermosensors
ultraneuron/multicompartment.py - Point HH neuron → CUDA kernels: dispatches batch
ultraneuron/neuron.py - Multi-compartment HH → CUDA kernels: dispatches batch
ultraneuron/multicompartment.py - Voxel simulation → Multi-compartment HH: simulates voxels
- Voxel simulation → Voxel firing maps: writes maps
- Researcher → Report builder: builds report
- Report builder → Acoustic outputs: routes section
validation_report/report_builder.py - Report builder → Elastic outputs: routes section
validation_report/report_builder.py - Report builder → Neural outputs: routes section
validation_report/report_builder.py - Report builder → Thermal outputs: routes section
validation_report/report_builder.py - Report builder → Astrocyte outputs: routes section
validation_report/report_builder.py - Report builder → Synaptic outputs: routes section
validation_report/report_builder.py - Report builder → Displacement outputs: routes section
validation_report/report_builder.py - Report builder → Wave animation: routes animation
validation_report/report_builder.py - Neural outputs → Acoustic outputs: uses acoustic data
validation_report/builders/neural_outputs.py - Neural outputs → Elastic outputs: uses elastic data
validation_report/builders/neural_outputs.py - Elastic outputs → Acoustic outputs: uses acoustic data
validation_report/builders/elastic_outputs.py - Acoustic outputs → Anatomical registration: uses placement
validation_report/builders/acoustic_outputs.py - Acoustic outputs → External path resolution: resolves resources
- Researcher → Parameter provenance: classifies parameters
- Researcher → Soliton alternative: scores alternative
- Researcher → Astrocyte relay: selects relay
- Researcher → Synaptic transmission: selects pathway
- Researcher → NMDA receptor: selects receptor