reademe update
This commit is contained in:
parent
f708bb93e2
commit
e9a37f40fd
@ -147,6 +147,15 @@ Automatically checks consistency.
|
||||
>
|
||||
> **Maturity**: EXPERIMENTAL
|
||||
|
||||
### [simulation-kt](simulation-kt)
|
||||
> A framework for combination of asynchronous simulations.
|
||||
>
|
||||
> **Maturity**: PROTOTYPE
|
||||
>
|
||||
> **Features:**
|
||||
> - [timeline](simulation-kt/#) : Timeline is an ordered discrete history containing TimeLineEvent
|
||||
|
||||
|
||||
### [controls-storage/controls-xodus](controls-storage/controls-xodus)
|
||||
> An implementation of controls-storage on top of JetBrains Xodus.
|
||||
>
|
||||
|
||||
@ -6,7 +6,7 @@ A low-code constructor for composite devices simulation
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-constructor:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-constructor:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-constructor:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-constructor:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -16,7 +16,7 @@ Core interfaces for building a device server
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-core:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-core:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -26,6 +26,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-core:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-core:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-jupyter:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-jupyter:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-jupyter:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-jupyter:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -12,7 +12,7 @@ Magix service for binding controls devices (both as RPC client and server)
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-magix:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-magix:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -22,6 +22,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-magix:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-magix:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -14,7 +14,7 @@ Automatically checks consistency.
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-modbus:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-modbus:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -24,6 +24,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-modbus:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-modbus:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -12,7 +12,7 @@ A client and server connectors for OPC-UA via Eclipse Milo
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-opcua:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-opcua:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -22,6 +22,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-opcua:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-opcua:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ Utils to work with controls-kt on Raspberry pi
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-pi:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-pi:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-pi:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-pi:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
21
controls-plc4x/README.md
Normal file
21
controls-plc4x/README.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Module controls-plc4x
|
||||
|
||||
A plugin for Controls-kt device server on top of plc4x library
|
||||
|
||||
## Usage
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-plc4x:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
repositories {
|
||||
maven("https://repo.kotlin.link")
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-plc4x:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
@ -6,7 +6,7 @@ Implementation of byte ports on top os ktor-io asynchronous API
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-ports-ktor:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-ports-ktor:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-ports-ktor:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-ports-ktor:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ Implementation of direct serial port communication with JSerialComm
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-serial:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-serial:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-serial:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-serial:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ A combined Magix event loop server with web server for visualization.
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-server:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-server:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-server:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-server:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ An API for stand-alone Controls-kt device or a hub.
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-storage:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-storage:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-storage:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-storage:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ An implementation of controls-storage on top of JetBrains Xodus.
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-xodus:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-xodus:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-xodus:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-xodus:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ Dashboard and visualization extensions for devices
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-vision:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-vision:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-vision:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-vision:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ Visualisation extension using compose-multiplatform
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:controls-visualisation-compose:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:controls-visualisation-compose:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:controls-visualisation-compose:0.4.0-dev-4")
|
||||
implementation("space.kscience:controls-visualisation-compose:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -1,14 +1,4 @@
|
||||
# Module device-collective
|
||||
|
||||
# Running demo from gradle
|
||||
|
||||
1. Install JDK 17-21 in the system (for example, from https://sdkman.io/jdks or https://github.com/ScoopInstaller/Java).
|
||||
2. Clone the repository with Git.
|
||||
3. Run `./gradlew :demo:device-collective:run` from the project root directory.
|
||||
|
||||
# Install distribution
|
||||
|
||||
1. Install JDK 17-21 in the system (for example, from https://sdkman.io/jdks or https://github.com/ScoopInstaller/Java).
|
||||
2. Clone the repository with Git.
|
||||
3. Run `./gradlew :demo:device-collective:packageUberJarForCurrentOS` from the project root directory.
|
||||
4. Go to `build/compose/jars/device-collective-<your OS>-<version>.jar`. You can copy it and run with `java -jar <full-name>.jar`
|
||||
|
||||
@ -6,7 +6,7 @@ A kotlin API for magix standard and some zero-dependency magix services
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-api:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:magix-api:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-api:0.4.0-dev-4")
|
||||
implementation("space.kscience:magix-api:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ Java API to work with magix endpoints without Kotlin
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-java-endpoint:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:magix-java-endpoint:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-java-endpoint:0.4.0-dev-4")
|
||||
implementation("space.kscience:magix-java-endpoint:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ MQTT client magix endpoint
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-mqtt:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:magix-mqtt:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-mqtt:0.4.0-dev-4")
|
||||
implementation("space.kscience:magix-mqtt:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ RabbitMQ client magix endpoint
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-rabbit:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:magix-rabbit:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-rabbit:0.4.0-dev-4")
|
||||
implementation("space.kscience:magix-rabbit:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ Magix endpoint (client) based on RSocket
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-rsocket:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:magix-rsocket:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-rsocket:0.4.0-dev-4")
|
||||
implementation("space.kscience:magix-rsocket:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ A magix event loop implementation in Kotlin. Includes HTTP/SSE and RSocket route
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-server:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:magix-server:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-server:0.4.0-dev-4")
|
||||
implementation("space.kscience:magix-server:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ Magix history database API
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-storage:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:magix-storage:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-storage:0.4.0-dev-4")
|
||||
implementation("space.kscience:magix-storage:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-storage-xodus:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:magix-storage-xodus:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-storage-xodus:0.4.0-dev-4")
|
||||
implementation("space.kscience:magix-storage-xodus:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
21
magix/magix-utils/README.md
Normal file
21
magix/magix-utils/README.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Module magix-utils
|
||||
|
||||
Common utilities and services for Magix endpoints.
|
||||
|
||||
## Usage
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-utils:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
repositories {
|
||||
maven("https://repo.kotlin.link")
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-utils:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
@ -6,7 +6,7 @@ ZMQ client endpoint for Magix
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:magix-zmq:0.4.0-dev-4`.
|
||||
The Maven coordinates of this project are `space.kscience:magix-zmq:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
@ -16,6 +16,6 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:magix-zmq:0.4.0-dev-4")
|
||||
implementation("space.kscience:magix-zmq:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
|
||||
26
simulation-kt/README.md
Normal file
26
simulation-kt/README.md
Normal file
@ -0,0 +1,26 @@
|
||||
# Module simulation-kt
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
- [timeline](#) : Timeline is an ordered discrete history containing TimeLineEvent
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
## Artifact:
|
||||
|
||||
The Maven coordinates of this project are `space.kscience:simulation-kt:0.4.0-dev-7`.
|
||||
|
||||
**Gradle Kotlin DSL:**
|
||||
```kotlin
|
||||
repositories {
|
||||
maven("https://repo.kotlin.link")
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("space.kscience:simulation-kt:0.4.0-dev-7")
|
||||
}
|
||||
```
|
||||
@ -5,10 +5,6 @@ plugins {
|
||||
`maven-publish`
|
||||
}
|
||||
|
||||
description = """
|
||||
Core interfaces for building a device server
|
||||
""".trimIndent()
|
||||
|
||||
kscience {
|
||||
jvm()
|
||||
js()
|
||||
@ -21,12 +17,17 @@ kscience {
|
||||
api(spclibs.kotlinx.datetime)
|
||||
}
|
||||
|
||||
jvmTest{
|
||||
jvmTest {
|
||||
implementation(spclibs.logback.classic)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
readme{
|
||||
readme {
|
||||
maturity = Maturity.PROTOTYPE
|
||||
description = """
|
||||
A framework for combination of asynchronous simulations.
|
||||
""".trimIndent()
|
||||
|
||||
feature("timeline") { "Timeline is an ordered discrete history containing TimeLineEvent" }
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user