Skip to content

ChengLabResearch/neuroglancer-plugin

Repository files navigation

Neuroglancer Ouroboros Plugin

This plugin integrates a Neuroglancer interface into the Ouroboros medical imaging software.

To install it, open Ouroboros, open the Plugin Manager (Ouroboros > Manage Plugins), and add a plugin from the GitHub releases url: https://github.com/ChengLabResearch/neuroglancer-plugin/releases.

Then restart the app and the plugin should be visible.

Features

Click the menu on the right side of the Neuroglancer window (three dots) and you'll have the option to load or save the current JSON state.

Neuroglancer can do this natively, but the menu buttons integrate into Ouroboros's file explorer, so when you open a folder in the app, the local JSON files are immediately available.

Development

Make sure Docker is installed and running.

  1. npm install
  2. npm run dev

To test in Ouroboros, run Ouroboros in development mode as well, and use the Test Plugin page to view the plugin.

Release artifact

The current production pin for Ouroboros package builds is:

  • tag: v1.0.1
  • release asset: neuroglancer-plugin-v1.0.1.zip

That asset archive root is the same layout that Ouroboros expects inside its plugin folder:

  • package.json
  • index.html
  • icon.svg
  • compose.yml
  • ngrefactor.html
  • frontend assets and runtime files
  • plugin-release.json

Tagged releases publish neuroglancer-plugin-<tag>.zip. The plugin-release.json metadata records the release tag, artifact name, commit, and packaged plugin version.

For production package preinstalls, unpack the archive to extra-resources/preinstalled-plugins/neuroglancer-plugin/ before building the Ouroboros app package. On first launch, Ouroboros copies that folder into the normal user-data plugin directory and detects it from package.json.

About

Neuroglancer integrated into the Ouroboros medical imaging application.

Topics

Resources

Stars

Watchers

Forks

Contributors