Skip to content
Python package providing mesoscale connectivity models for mouse.
Python Other
  1. Python 99.9%
  2. Other 0.1%
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.cookiecutter
docs
examples
mcmodels
paper
tests
.bumpversion.cfg
.codecov.yml
.coveragerc
.editorconfig
.gitignore
.travis.yml
AUTHORS.rst
CONTRIBUTING.rst
LICENSE
MANIFEST.in
Makefile
Pipfile
Pipfile.lock
README.rst
cortical_projection.gif
requirements-doc.txt
setup.cfg
setup.py
tox.ini

README.rst

mouse_connectivity_models

Travis Codecov Readthedocs

cortical_projection.gif

mouse_connectivity_models is a Python module for constructing and testing mesoscale connectivity models using data from the Allen Institute for Brain Science.

It provides models written in Scikit-Learn estimator style, and has been used in the following publications:

Download: http://download.alleninstitute.org/publications/A_high_resolution_data-driven_model_of_the_mouse_connectome/

Website: http://mouse-connectivity-models.readthedocs.io/en/latest/

Installation

Dependencies

mouse_connectivity_models requires:

  • Python (>=2.7 or >= 3.4)
  • scikit-learn (>= 0.19)
  • allensdk (>= 0.14.4)

For running the examples Matplotlib >= 1.3.1 is required.

We have only tested and used this package on Linux.

User installation

We use Git for our version control and Github for hosting our main repository.

You can check out the latest sources and install using pip:

$ git clone https://github.com/AllenInstitute/mouse_connectivity_models.git
$ cd mouse_connectivity_models
$ pip install .

Level of Support

We are not currently supporting this code, but simply releasing it to the community AS IS but are not able to provide any guarantees of support. The community is welcome to submit issues, but you should not expect an active response.

Contrubuting

We encourage the community to contribute! Please first review the Allen Institute Contributing Agreement, then refer to the contributing guide.

Installing the dev requirements

Use pipenv to install the dev dependencies. If you do not have pipenv currently installed

$ pip install pipenv

Then install dev dependencies

$ pipenv install --dev

This will create a virtual environment on your machine for this project. To activate the virtual environment (to develop)

$ pipenv shell

Testing

After installation, you can launch the test suite from outside the source directory (mcmodels) using pytest

$ pytest mcmodels

Help and Support

Documentation

The documentation that supports mouse_connectivity_models can be found at the Website.

You can’t perform that action at this time.