kscience/visionforge
8
1
Fork 1
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

Create README files per demo project

Browse Source
This commit is contained in:
Peter Klimai 2020-05-07 16:52:57 +03:00
parent 103fbe94ae
commit 8c8f4adc2e
4 changed files with 60 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -2,7 +2,7 @@
# DataForge Visualization Platform
## Table of contents
## Table of Contents
* [Introduction](#introduction)
* [Features](#features)
@ -13,8 +13,8 @@
* [dataforge-vis-spatial-gdml](#dataforge-vis-spatial-gdml)
* [dataforge-vis-jsroot](#dataforge-vis-jsroot)
* [Demonstrations](#demonstrations)
* [Spatial Showcase](#spatial-showcase)
* [Muon Monitor](#muon-monitor-visualization)
* [Simple Example - Spatial Showcase](#simple-example-spatial-showcase)
* [Full-Stack Application Example - Muon Monitor](#full-stack-application-example-muon-monitor-visualization)
* [GDML Example](#gdml-example)
@ -26,8 +26,8 @@ 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 being developed as a Kotlin multiplatform application, currently targeting browser
JavaScript and JVM.
The project is being developed as a [Kotlin multiplatform](https://kotlinlang.org/docs/reference/multiplatform.html)
application, currently targeting browser JavaScript and JVM.
## Features
@ -105,42 +105,37 @@ Note: Currently, this part is experimental and put here for completeness. This m
## Demonstrations
The `demo` module contains several demonstrations of using the `dataforge-vis` framework:
The `demo` module contains several example projects (demonstrations) of using the `dataforge-vis` framework:
### Spatial Showcase
### Simple Example - Spatial 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.
To see the demo: run `demo/spatial-showcase/Tasks/distribution/installJsDist` Gradle task, then open
`build/distribuions/spatial-showcase-js-0.1.0-dev/index.html` file in your browser.
[More details](demo/spatial-showcase/README.md)
##### Example view:
![](doc/resources/spatial-showcase.png)
### Muon Monitor Visualization
### Full-Stack Application Example - Muon Monitor Visualization
A full-stack application example, showing the
[Muon Monitor](http://npm.mipt.ru/projects/physics.html#mounMonitor) experiment set-up.
Includes server back-end generating events, as well as visualization front-end.
To run full-stack app (both server and browser front-end), run
`demo/muon-monitor/application/run` task.
[More details](demo/muon-monitor/README.md)
##### Example view:
![](doc/resources/muon-monitor.png)
### GDML Example
Visualization example for geometry defined as GDML file.
To build the app, run `demo/gdml/Tasks/distribution/installJsDist` task, then open
`build/distribuions/gdml-js-0.1.0-dev/index.html` file in your browser, and
drag-and-drop GDML file to the window to see visualization. For an example file, use
`demo/gdml/src/jsMain/resources/cubes.gdml`.
[More details](demo/gdml/README.md)
##### Example view:

15
demo/gdml/README.md Normal file
View File

@ -0,0 +1,15 @@
### GDML Example
Visualization example for geometry defined as GDML file.
##### Building project
To build the app, run `demo/gdml/Tasks/distribution/jsBrowserDistribution` Gradle task, then open
`demo/gdml/build/distribuions/gdml-js-0.1.3-dev/index.html` file in your browser, and
drag-and-drop GDML file to the window to see visualization. For an example file, you can use
`demo/gdml/src/jsMain/resources/cubes.gdml`.
##### Example view:
![](../../doc/resources/gdml-demo.png)

17
demo/muon-monitor/README.md Normal file
View File

@ -0,0 +1,17 @@
### Muon Monitor Visualization
A full-stack application example, showing the
[Muon Monitor](http://npm.mipt.ru/projects/physics.html#mounMonitor) experiment set-up.
Includes server back-end generating events, as well as visualization front-end.
##### Building project
To run full-stack Muon Monitor Visualization application (both server and browser front-end), run
`demo/muon-monitor/application/run` task.
##### Example view:
![](../../doc/resources/muon-monitor.png)

13
demo/spatial-showcase/README.md Normal file
View File

@ -0,0 +1,13 @@
### Spatial 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.
##### Building project
To see the demo: run `demo/spatial-showcase/Tasks/distribution/jsBrowserDistribution` Gradle task, then open
`build/distribuions/spatial-showcase-js-0.1.3-dev/index.html` file in your browser.
##### Example view:
![](../../doc/resources/spatial-showcase.png)