Skip to content

NWB GUIDE is a desktop app that provides a no-code user interface for converting neurophysiology data to NWB.

License

Notifications You must be signed in to change notification settings

NeurodataWithoutBorders/nwb-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NeuroConv logo

NWB Graphical User Interface for Data Entry

Note: This project is under heavy pre-release development and is not recommended for practical use.

Table of Contents

About

NWB GUIDE is a desktop app that provides a no-code user interface for converting neurophysiology data to NWB.

Watch the video

Installation

Start by cloning the repository

git clone https://github.com/catalystneuro/nwb-guide

Install the appropriate Python dependencies for your operating system.

Windows

conda env create -f ./environments/environment-Windows.yml

Mac

conda env create -f ./environments/environment-MAC.yml

M1 Mac

conda env create -f ./environments/environment-MAC-arm64.yml

Linux

conda env create -f ./environments/environment-Linux.yml

Getting Started

Before starting NWB GUIDE, you'll need to ensure that the Python environment is activated.

conda activate nwb-guide

Next, install all JavaScript dependencies based on the package-lock.json file.

npm ci

You can now run the following command to start the application using Electron.

npm start

Contributing

Repo Structure

NWB GUIDE

  1. /src - Contains all the source code for the frontend
    • index.js - The entry point for the application
    • pages.js - The main code that controls which pages are rendered and how they are linked together
    • stories - Contains all the Web Components and related Storybook stories
    • electron - Contains all the Electron-related code to enable conditional inclusion for development mode
    • assets - Contains all the frontend-facing assets (e.g. images, css, etc.)
  2. /pyflask - Contains all the source code for the backend

Development Mode

Run the application in development mode to enable hot reloading of the JavaScript code by running parallel instances of the Flask server and a Vite development server.

npm run dev