neurotechdevkit 0.0.10

A research repo for the NDK (Neurotech Development Kit) project

Neurotech Development Kit (NDK) Research

Exploring the Repository

The NDK API was developed with easy-of-use in mind, and 3 lines of code is all you need to run a simulation:

import neurotechdevkit as ndk

scenario = ndk.make('scenario-2-2d-v0')
result = scenario.simulate_steady_state()

... and one line to see the results!

result.render_steady_state_amplitudes()

Setup

neurotechdevkit requires Python >=3.9 and <3.11 to be installed. You can find which Python version you have installed by running python --version in a terminal. If you don't have Python installed, or you are running an unsupported version, you can download it from python.org. Python environment managers like pyenv, conda, and poetry are all perfectly suitable as well.

You can install the package using:

pip install neurotechdevkit

And then you must install stride using:

pip install git+https://github.com/trustimaging/stride --no-deps

Development

See our contribution requirements for more information on how to install the package locally using poetry and on how to contribute.

A Makefile is provided to assist with common commands such as linting and running unit tests.

$ make lint

$ make test

See the Makefile for other commands.

Acknowledgements

Thanks to Fred Ehrsam for supporting this project, Quintin Frerichs and Milan Cvitkovic for providing direction, and to Sumner Norman for his ultrasound and neuroscience expertise. Thanks to Stride for facilitating ultrasound simulations, Devito for providing the backend solver, Napari for great 3D visualization, and to Jean-Francois Aubry, et al. for the basis of the simulation scenarios.