Note: This project is under heavy pre-release development and is not recommended for practical use.
NWB GUIDE is a desktop app that provides a no-code user interface for converting neurophysiology data to NWB.
Start by cloning the repository
git clone https://github.com/catalystneuro/nwb-guide
Install the appropriate Python dependencies for your operating system.
conda env create -f ./environments/environment-Windows.yml
conda env create -f ./environments/environment-MAC.yml
conda env create -f ./environments/environment-MAC-arm64.yml
conda env create -f ./environments/environment-Linux.yml
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
/src
- Contains all the source code for the frontendindex.js
- The entry point for the applicationpages.js
- The main code that controls which pages are rendered and how they are linked togetherstories
- Contains all the Web Components and related Storybook storieselectron
- Contains all the Electron-related code to enable conditional inclusion for development modeassets
- Contains all the frontend-facing assets (e.g. images, css, etc.)
/pyflask
- Contains all the source code for the backend
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