HNN Web User Interface

This repository hosts the web-based user interface for HNN. HNN is a user-friendly software tool that gives researchers and clinicians the ability to test and develop hypotheses on the circuit mechanism underlying their EEG/MEG data in an easy-to-use environment.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Have a look in the documentation for notes on how to use the interface.

Prerequisites

Before we start make sure you have NEURON installed in a new python3 virtual environment.

python3 -m venv new_venv_folder
source new_venv_folder/bin/activate

Install HNN User Interface from sources (for developers)

Step by step instructions to get a development environment running.

First, clone HNN-UI:

git clone https://github.com/MetaCell/HNN-UI

Second, activate your virtual environment:

source new_venv_folder/bin/activate

Then run the installation script:

cd HNN-UI/utilities
python install.py

How to run

After the installation has completed, run the script:

cd ..
./HNN-UI

If everything worked, the default browser will open on http://localhost:8888/geppetto

Run with docker

To pull the docker container:

docker pull metacell/hnn-ui:release 

To run the docker container:

docker run -it -p 8888:8888 metacell/hnn-ui:release