Metadata-Version: 2.2
Name: bmtk
Version: 1.1.1
Summary: Brain Modeling Toolkit
Home-page: https://github.com/AllenInstitute/bmtk
Author: Kael Dai
Author-email: kaeld@alleninstitute.org
Keywords: neuroscience,scientific,modeling,simulation
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: jsonschema
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: six
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: enum; python_version <= "2.7"
Requires-Dist: scipy
Requires-Dist: scikit-image
Requires-Dist: sympy
Requires-Dist: pynrrd
Provides-Extra: bionet
Requires-Dist: NEURON; extra == "bionet"
Provides-Extra: mintnet
Requires-Dist: tensorflow; extra == "mintnet"
Provides-Extra: pointnet
Requires-Dist: NEST; extra == "pointnet"
Provides-Extra: popnet
Requires-Dist: DiPDE; extra == "popnet"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: platform
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

# The Brain Modeling Toolkit

A software development package for building, simulating, and analyzing large-scale networks of different levels of resolution.

Please give feedback via our brief [user survey](https://docs.google.com/forms/d/e/1FAIpQLSfwZQhvHF0JH9BLrKXfAtyagy9_d-Y0x5VRX85aDY2-p9-u1g/viewform), which will inform future development, fixes, and documentation.

Registering allows us to communicate with BMTK users and is encouraged, but not required: [registration link](https://secure2.convio.net/allins/site/SPageServer/?pagename=modeling_tools).

See the paper about BMTK: [link](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1008386).

Please cite BMTK as follows:

Dai et al. Brain Modeling Toolkit: An open-source software suite for multiscale modeling of brain circuits. PLoS Comput Biol 16(11): e1008386. https://doi.org/10.1371/journal.pcbi.1008386

## Level of Support

We are releasing this code to the public as a tool we expect others to use. Questions concerning bugs and related issues are welcomed. We expect to address them promptly and pull requests will be vetted by our staff before inclusion.

## Quickstart

bmtk requires Python 2.7 or 3.5+, plus [additional python dependicies](https://alleninstitute.github.io/bmtk/index.html#base-installation). To install with
base requirements from a command-line:

```bash
 $ git clone https://github.com/AllenInstitute/bmtk.git
 $ cd bmtk
 $ python setup.py install
```

There are examples of building models and running simulations located in docs/examples/. Some of the simulation engines may require additional requirements to run.

##### Tests

There are a collection of unit tests in `bmtk.tests` which can be run using pytest

```bash
  $ cd bmtk
  $ py.test
```

## Documentation

[User Guide](https://alleninstitute.github.io/bmtk/)

- [Building network models](https://alleninstitute.github.io/bmtk/builder.html)
- [Running biophysical simulations](https://alleninstitute.github.io/bmtk/bionet.html)
- [Running point-neuron simulations](https://alleninstitute.github.io/bmtk/pointnet.html)
- [Running population-level simulations](https://alleninstitute.github.io/bmtk/popnet.html)

Copyright 2017 Allen Institute
