Update README
This commit is contained in:
parent
3353d4704f
commit
bdf09d3087
41
README.md
41
README.md
@ -1,11 +1,40 @@
|
|||||||
# DataForge plugins for visualisation
|
# DataForge Plugins for Visualisation
|
||||||
|
|
||||||
## Common visualisation objects
|
This repository contains [DataForge](http://www.inr.ru/~nozik/dataforge/)
|
||||||
|
(also [here](https://github.com/mipt-npm/dataforge-core)) components useful for visualization in
|
||||||
|
various scientific applications. Currently, the main application is 3D visualization for accelerator
|
||||||
|
experiments.
|
||||||
|
|
||||||
## JavaFX utilities for meta manipulations
|
The project is developed as a Kotlin multiplatform application, currently
|
||||||
|
targeting browser JavaScript and JVM.
|
||||||
|
|
||||||
## 3D visualisation
|
## Modules contained in this repository:
|
||||||
|
|
||||||
Includes common discription and serializers, JavaFX and Three.js implementations.
|
### dataforge-vis-common
|
||||||
|
|
||||||
|
Common visualisation objects such as VisualObject and VisualGroup.
|
||||||
|
|
||||||
|
### dataforge-vis-fx
|
||||||
|
|
||||||
|
JavaFX utilities for meta manipulations.
|
||||||
|
|
||||||
|
### dataforge-vis-jsroot
|
||||||
|
|
||||||
|
Some JSROOT bindings.
|
||||||
|
|
||||||
|
Note: Currently, this part is experimental and put here for completeness. This module will not build.
|
||||||
|
|
||||||
|
### dataforge-vis-spatial
|
||||||
|
|
||||||
|
Includes common description and serializers for 3D visualisation, JavaFX and Three.js implementations.
|
||||||
|
|
||||||
|
### dataforge-vis-spatial-gdml
|
||||||
|
|
||||||
|
GDML bindings for 3D visualisation (to be moved to gdml project)
|
||||||
|
|
||||||
|
### spatial-js-demo
|
||||||
|
|
||||||
|
Contains a simple demonstration. To see the demo: run
|
||||||
|
`spatial-js-demo/distribution/installJsDist` Gradle task, then open
|
||||||
|
`build/distribuions/spatial-js-demo-0.0.0-dev/index.html`.
|
||||||
|
|
||||||
## GDML bindings for 3D visualisation (to be moved to gdml project)
|
|
||||||
|
Loading…
Reference in New Issue
Block a user