Skip to content

connectome-neuprint/neuPrintExplorer

Repository files navigation

neuPrintExplorer Picture

Build Status GitHub issues

"exploring inter and intra cellular interactions"

neuPrintExplorer is a single page web application that provides simple interfaces to query an EM connectome stored in neuPrint+, which uses the graph database Neo4j. It contains a number of plugins to facilitate different types of queries. The application is written using REACT+Redux and Material-UI.

Installation

% git clone git@github.com:connectome-neuprint/neuPrintExplorer.git
% cd neuPrintExplorer

To build the package for development:

% npm install
% npm run dev

To build for production:

% npm install
% npm run build

Finally, you will need plugins to perform the queries and display the results. Core plugins can be found in their own repository at: neuPrintExplorerPlugins. These are marked as a dependency for neuPrintExplorer, so they will get installed at the same time. If you wish to make changes to the plugins and test them localy, without publishing them to npm, you will need to clone the repository and link them into your development copy of neuPrintExplorer. Please see the README in the neuPrintExplorerPlugins repository for more information on writing your own plugins.

Running

This app is dependent on neuPrintHTTP, which is an http REST API for connectomics that connects to neuPrint+ and also serves this static application. To launch neuPrintHTTP and the web application:

% neuPrintHTTP -port 11000 config.json

config.json is a configuration file for accessing the backend and pointing to the 'build' created by this distribution. For examples, please see neuPrintHTTP documentation.