Update readme

This commit is contained in:
2026-01-10 19:31:56 +03:00
parent b6100bdce1
commit d578efa17b
18 changed files with 70 additions and 64 deletions

View File

@@ -5,20 +5,28 @@
### Added
### Changed
- Kotlin 2.3
### Deprecated
### Removed
### Fixed
### Security
## 0.5.1 - 2026-01-10
### Changed
- Kotlin 2.3
### Fixed
- Fix DSLMarker annotations for builders
- Flaky test
- Fix the problem where property listeners do not react on property child node changes
- Plotly plot title now writes proper field
### Security
## 0.5.0 - 2025-03-21
### Added

View File

@@ -5,14 +5,14 @@
[![Slack](https://img.shields.io/badge/slack-channel-green?logo=slack)](https://kotlinlang.slack.com/archives/CEXV2QWNM)
# DataForge Visualization Platform
# VisionForge platform
## Table of Contents
* [Introduction](#introduction)
* [Requirements](#requirements)
* [Features](#features)
* [About DataForge](#about-dataforge)
* [About VisionForge](#about-VisionForge)
* [Modules contained in this repository](#modules-contained-in-this-repository)
* [Visualization for External Systems](#visualization-for-external-systems)
* [Demonstrations](#demonstrations)
@@ -23,7 +23,7 @@
## Introduction
This repository contains a [DataForge](#about-dataforge)\-based framework
This repository contains a [VisionForge](#about-VisionForge) framework
used for visualization in various scientific applications.
The main framework's use case for now is 3D visualization for particle physics experiments.
@@ -41,16 +41,16 @@ JVM backend requires JDK 11 or later
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
- Scales up to hundreds of thousands of elements
- The camera moves, rotates, zoom-in and zoom-out
- Scene graph as an object tree with property editor
- Settings export and import
- Multiple platform support
## About DataForge
## About VisionForge
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`,
[DataForge](https://git.sciprog.center/kscience/dataforge-core) is a software framework for automated scientific data processing. VisionForge
Platform uses some concepts and modules of DataForge, including: `Meta`, `Configuration`, `Context`,
`Provider`, and some others.
To learn more about DataForge, please consult the following URLs:
@@ -66,10 +66,6 @@ To learn more about DataForge, please consult the following URLs:
>
> **Maturity**: EXPERIMENTAL
### [demo](demo)
>
> **Maturity**: EXPERIMENTAL
### [plotly-kt](plotly-kt)
>
> **Maturity**: EXPERIMENTAL
@@ -131,10 +127,6 @@ To learn more about DataForge, please consult the following URLs:
>
> **Maturity**: EXPERIMENTAL
### [demo/playground](demo/playground)
>
> **Maturity**: EXPERIMENTAL
### [demo/sat-demo](demo/sat-demo)
>
> **Maturity**: EXPERIMENTAL
@@ -143,10 +135,6 @@ To learn more about DataForge, please consult the following URLs:
>
> **Maturity**: EXPERIMENTAL
### [plotly-kt/examples](plotly-kt/examples)
>
> **Maturity**: EXPERIMENTAL
### [plotly-kt/plotly-kt-core](plotly-kt/plotly-kt-core)
>
> **Maturity**: DEVELOPMENT
@@ -164,18 +152,6 @@ To learn more about DataForge, please consult the following URLs:
>
> **Maturity**: EXPERIMENTAL
### [plotly-kt/examples/compose-demo](plotly-kt/examples/compose-demo)
>
> **Maturity**: EXPERIMENTAL
### [plotly-kt/examples/js-demo](plotly-kt/examples/js-demo)
>
> **Maturity**: EXPERIMENTAL
### [plotly-kt/examples/native-demo](plotly-kt/examples/native-demo)
>
> **Maturity**: EXPERIMENTAL
**Class diagram:**

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:cern-root-loader:0.5.0`.
The Maven coordinates of this project are `space.kscience:cern-root-loader:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:cern-root-loader:0.5.0")
implementation("space.kscience:cern-root-loader:0.5.1")
}
```

View File

@@ -15,10 +15,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Removed
### Fixed
- Fix legend orientation constants
### Security
## 0.5.1 - 2026-01-10
### Fixed
- Fix legend orientation constants
## 0.5.0 (package and versioning change!)
### Changed

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:plotly-kt-core:0.5.0`.
The Maven coordinates of this project are `space.kscience:plotly-kt-core:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:plotly-kt-core:0.5.0")
implementation("space.kscience:plotly-kt-core:0.5.1")
}
```

View File

@@ -2,3 +2,20 @@
## Usage
## Artifact:
The Maven coordinates of this project are `space.kscience:plotly-kt-server:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}
dependencies {
implementation("space.kscience:plotly-kt-server:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-compose-html:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-compose-html:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-compose-html:0.5.0")
implementation("space.kscience:visionforge-compose-html:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-compose-multiplatform:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-compose-multiplatform:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-compose-multiplatform:0.5.0")
implementation("space.kscience:visionforge-compose-multiplatform:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-core:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-core:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-core:0.5.0")
implementation("space.kscience:visionforge-core:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-gdml:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-gdml:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-gdml:0.5.0")
implementation("space.kscience:visionforge-gdml:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@ Common visionforge jupyter module
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-jupyter:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-jupyter:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-jupyter:0.5.0")
implementation("space.kscience:visionforge-jupyter:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@ Jupyter api artifact including all common modules
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-jupyter-common:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-jupyter-common:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-jupyter-common:0.5.0")
implementation("space.kscience:visionforge-jupyter-common:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-markdown:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-markdown:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-markdown:0.5.0")
implementation("space.kscience:visionforge-markdown:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-server:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-server:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-server:0.5.0")
implementation("space.kscience:visionforge-server:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-solid:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-solid:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-solid:0.5.0")
implementation("space.kscience:visionforge-solid:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-tables:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-tables:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-tables:0.5.0")
implementation("space.kscience:visionforge-tables:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-threejs:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-threejs:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-threejs:0.5.0")
implementation("space.kscience:visionforge-threejs:0.5.1")
}
```

View File

@@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:visionforge-threejs-server:0.5.0`.
The Maven coordinates of this project are `space.kscience:visionforge-threejs-server:0.5.1`.
**Gradle Kotlin DSL:**
```kotlin
@@ -16,6 +16,6 @@ repositories {
}
dependencies {
implementation("space.kscience:visionforge-threejs-server:0.5.0")
implementation("space.kscience:visionforge-threejs-server:0.5.1")
}
```