Skip to content

nicolossus/neuromodels

Repository files navigation

NeuroModels

PyPi version python compatibility GitHub license

NeuroModels is a Python toolbox for simulating neuroscientific models, post-simulation analysis and feature extraction.

Overview

NeuroModels is a software that aims to provide a framework for neuroscientific simulator models and methods for extracting features from the simulated recording. The simulator models are implemented to be flexible, particularly in the sense of parameterizing the models.

NeuroModels presently includes the following neural simulators:

  • Hodgkin-Huxley Model
  • Brunel Network Model

NeuroModels is a part of the author's Master thesis.

Installation instructions

Install with pip

NeuroModels can be installed directly from PyPI:

pip install neuromodels

Requirements

  • Python >= 3.8
  • The standard scientific libraries; NumPy, Matplotlib, SciPy

Documentation

Documentation can be found at neuromodels.readthedocs.io.

Getting started

Check out the Examples gallery in the documentation.

Automated build and test

The repository uses continuous integration (CI) workflows to build and test the project directly with GitHub Actions. Tests are provided in the tests folder. Run tests locally with pytest:

python -m pytest tests -v