Skip to main content

BMTool

Project description

bmtool

A collection of modules to make developing Neuron and BMTK models easier.

license

In depth documentation and examples can be found here

Getting Started

Installation

pip install bmtool

For developers who will be pulling down additional updates to this repository regularly use the following instead.

git clone https://github.com/cyneuro/bmtool.git
cd bmtool
python setup.py develop

Then download updates (from this directory) with

git pull

BMTool provides several modules to simplify the development of computational neuroscience models with NEURON and the Brain Modeling Toolkit (BMTK). It offers functionality for:

  • Single Cell Modeling: Analyze passive properties, current injection, FI curves, and impedance profiles
  • Synapse Development: Tools for tuning synaptic properties and gap junctions
  • Network Construction: Connectors for building complex network structures
  • Visualization: Plot connection matrices, network positions, and more
  • Simulation Management: Run simulations on SLURM clusters with parameter sweeps
  • Analysis: Process simulation results efficiently

Development

Code Quality Tools

BMTool now uses modern Python code quality tools to maintain high standards:

  • Ruff: A fast Python linter for code style and error checking
  • Pyright: Static type checker to catch type-related bugs early

To install development dependencies in your conda environment:

# Activate your conda environment
conda activate bmtk

# Install development dependencies
pip install -e ".[dev]"

To run the tools:

# Run Ruff linter
ruff check bmtool/

# Run Ruff with auto-fix
ruff check --fix bmtool/

# Run Pyright type checker
pyright

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

bmtool-0.7.4.tar.gz (148.7 kB view details)

Uploaded Source

Built Distribution

bmtool-0.7.4-py3-none-any.whl (156.0 kB view details)

Uploaded Python 3

File details

Details for the file bmtool-0.7.4.tar.gz.

File metadata

  • Download URL: bmtool-0.7.4.tar.gz
  • Upload date:
  • Size: 148.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bmtool-0.7.4.tar.gz
Algorithm Hash digest
SHA256 005c5177f4bfbad67a632b32b1fa6c9ff2040dfeba0871d2a4da5ce3264cacf8
MD5 444525d1f789475b12da6dff815226ef
BLAKE2b-256 c67e8c3f6b405e56579b5161c7cc6394695bcbb4c19e8ce478d1c5e2a3f509c0

See more details on using hashes here.

File details

Details for the file bmtool-0.7.4-py3-none-any.whl.

File metadata

  • Download URL: bmtool-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 156.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bmtool-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4c8dcbf51a660af6f0fe71feb580592247abd37da4337bdf174734cfa86dbe09
MD5 5f48bfe852dc938a1245fb3b6da206df
BLAKE2b-256 c263715ce1494edd831578b642f70ecbd7a998564a53260245cda5e5ceb3cd23

See more details on using hashes here.

Supported by

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