kscience
/
visionforge
5
1
Fork 1
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
Visualization module for dataforge
506 Commits 8 Branches 3 Tags 33 MiB
Kotlin 99.9%
CSS 0.1%
Go to file
Alexander Nozik fb12ca8902
Delete kotlin-js-store directory 		2022-04-13 17:07:15 +03:00
.github/workflows Update gh-actions and api 2022-01-20 11:52:58 +03:00
cern-root-loader Update readmes 2022-01-23 15:06:47 +03:00
demo Update readmes 2022-01-23 15:06:47 +03:00
docs Update readmes 2022-01-23 15:06:47 +03:00
gradle/wrapper Remove Ktor client 2021-12-29 20:00:03 +03:00
jupyter Update readmes 2022-01-23 15:06:47 +03:00
ui Update readmes 2022-01-23 15:06:47 +03:00
visionforge-core Update readmes 2022-01-23 15:06:47 +03:00
visionforge-fx Update readmes 2022-01-23 15:06:47 +03:00
visionforge-gdml Update readmes 2022-01-23 15:06:47 +03:00
visionforge-markdown Update readmes 2022-01-23 15:06:47 +03:00
visionforge-plotly Update readmes 2022-01-23 15:06:47 +03:00
visionforge-server Update readmes 2022-01-23 15:06:47 +03:00
visionforge-solid Update readmes 2022-01-23 15:06:47 +03:00
visionforge-tables Update readmes 2022-01-23 15:06:47 +03:00
visionforge-threejs Update readmes 2022-01-23 15:06:47 +03:00
.gitattributes Create .gitattributes 2019-04-05 15:45:59 +03:00
.gitignore Update gh-actions and api 2022-01-20 11:52:58 +03:00
.space.kts Build 2021-09-28 12:27:58 +00:00
CHANGELOG.md Update readmes 2022-01-23 15:06:47 +03:00
LICENSE Geometry update 2019-07-14 22:08:15 +03:00
README.md Update readmes 2022-01-23 15:06:47 +03:00
build.gradle.kts Update gh-actions and api 2022-01-20 11:52:58 +03:00
gradle.properties 0.2.0 release 2022-01-23 15:56:46 +03:00
gradlew Use standard GA configuration 2021-08-06 06:28:55 +07:00
gradlew.bat GDML optimization 2020-08-26 10:16:55 +03:00
settings.gradle.kts 0.2.0 release 2022-01-23 15:56:46 +03:00

README.md

JetBrains Research DOI

Gradle build

Slack

DataForge Visualization Platform

Table of Contents

Introduction

This repository contains a DataForge-based framework used for visualization in various scientific applications.

The main framework's use case for now is 3D visualization for particle physics experiments. Other applications including 2D plots are planned for the future.

The project is developed as a Kotlin multiplatform application, currently targeting browser JavaScript and JVM.

Requirements

JVM backend requires JDK 11 or later

Features

The main framework's features for now include:

  • 3D visualization of complex experimental set-ups
  • Event display such as particle tracks, etc.
  • Scales up to few hundred thousands of elements
  • Camera move, rotate, zoom-in and zoom-out
  • Scene graph as an object tree with property editor
  • Settings export and import
  • Multiple platform support

About DataForge

DataForge is a software framework for automated scientific data processing. DataForge Visualization Platform uses some of the concepts and modules of DataForge, including: Meta, Configuration, Context, Provider, and some others.

To learn more about DataForge, please consult the following URLs:

Modules contained in this repository

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: DEVELOPMENT

Maturity: PROTOTYPE

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: DEVELOPMENT

Maturity: PROTOTYPE

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Maturity: EXPERIMENTAL

Class diagram:

Prototypes

One of the important features of the framework is support for 3D object prototypes (sometimes also referred to as templates). The idea is that prototype geometry can be rendered once and reused for multiple objects. This helps to significantly decrease memory usage.

The prototypes property tree is defined in SolidGroup class via PrototypeHolder interface, and SolidReference class helps to reuse a template object.

Styles

VisionGroup has a styleSheet property that can optionally define styles at the Group's level. Styles are applied to child (descendant) objects using Vision.styles: List<String> property.

visionforge-threejs

Visualization for External Systems

The visionforge framework can be used to visualize geometry and events from external, non-Kotlin based systems, such as ROOT. This will require a plugin to convert data model of the external system to that of visionforge. Performing such integration is a work currently in progress.

Demonstrations

The demo module contains several example projects (demonstrations) of using the visionforge framework. They are briefly described in this section, for more details please consult the corresponding per-project README file.

Simple Example - Solid Showcase

Contains a simple demonstration with a grid including a few shapes that you can rotate, move camera, and so on. Some shapes will also periodically change their color and visibility.

More details

Example view:

Full-Stack Application Example - Muon Monitor Visualization

A full-stack application example, showing the Muon Monitor experiment set-up.

More details

Example view:

GDML Example

Visualization example for geometry defined as GDML file.

More details

Example view:

Thanks and references

The original three.js bindings were made by Lars Ivar Hatledal, but the project is discontinued right now.

All other libraries are explicitly shown as dependencies. We would like to express specific thanks to JetBrains Kotlin-JS team for consulting us during the work.