Skip to content

COMPILE.md

Latest commit

 

History

History
46 lines (36 loc) · 2.95 KB

COMPILE.md

File metadata and controls

46 lines (36 loc) · 2.95 KB
Raw

Mastodon-sciview Bridge (take2)

This is a reincarnation of an earlier project mastodon-sciview by xulman and RuoshanLan. It aims to bridge Mastodon with interactive 3D visualization in sciview (and scenery) and extends it with eye tracking-based cell tracking and other VR tracking/editing/exploration modalities.

The repository was started during the scenery and sciview hackathon in Dresden (Germany) in June 2023, where most of the code was contributed by xulman. Samuel Pantze (smlpt) is the current maintainer and extends the bridge with eye tracking, real-time data synchronization and VR interaction functionality.

Attention: this project is under active development and some features currently rely on feature branches of both scenery and sciview. Some features might be hidden in feature branches. If in doubt, ask Samuel on Zulip.

How to compile

This project is now a gradle build system project with the official current content on the master branch. It is a gradle project because scenery and sciview are gradle projects, and thus it was the most natural choice when developing or contributing to this project.

Development

Since this regime is intended for development of this project and potentially of adding relevant functions in the sciview, which shall be immediately accessible in this project, the gradle settings of this project is instructed to look for local sciview. Therefore, the following layout is expected:

├── mastodon-sciview-take2
│   ├── build
│   ├── build.gradle.kts
│   ├── gradle
│   ├── gradlew
│   ├── gradlew.bat
│   ├── settings.gradle.kts
│   └── src
├── sciview
│   └── ...
└── scenery # (<- optional, for latest features)
    └── ...

(Put simply, both this and sciview repositories are next to each other, and also scenery if the latest features are desired.)

Running

The easiest way to start currently (during active development) is to start Mastodon from Intellij IDEA by running the StartMastodon file. You can then create or open any project and launch sciview from the menu via Window -> New sciview.

For quick testing you can also use the StartSciviewBridgeDirectly.kt class and point its file path at an existing Mastodon file, which will then be opened immediately.