From e9a37f40fd1da68a1f469cb4b28f190b311ca4b1 Mon Sep 17 00:00:00 2001 From: Alexander Nozik Date: Sun, 8 Dec 2024 12:15:22 +0300 Subject: [PATCH] reademe update --- README.md | 9 +++++++ controls-constructor/README.md | 4 +-- controls-core/README.md | 4 +-- controls-jupyter/README.md | 4 +-- controls-magix/README.md | 4 +-- controls-modbus/README.md | 4 +-- controls-opcua/README.md | 4 +-- controls-pi/README.md | 4 +-- controls-plc4x/README.md | 21 +++++++++++++++ controls-ports-ktor/README.md | 4 +-- controls-serial/README.md | 4 +-- controls-server/README.md | 4 +-- controls-storage/README.md | 4 +-- controls-storage/controls-xodus/README.md | 4 +-- controls-vision/README.md | 4 +-- controls-visualisation-compose/README.md | 4 +-- demo/device-collective/README.md | 10 ------- magix/magix-api/README.md | 4 +-- magix/magix-java-endpoint/README.md | 4 +-- magix/magix-mqtt/README.md | 4 +-- magix/magix-rabbit/README.md | 4 +-- magix/magix-rsocket/README.md | 4 +-- magix/magix-server/README.md | 4 +-- magix/magix-storage/README.md | 4 +-- .../magix-storage-xodus/README.md | 4 +-- magix/magix-utils/README.md | 21 +++++++++++++++ magix/magix-zmq/README.md | 4 +-- simulation-kt/README.md | 26 +++++++++++++++++++ simulation-kt/build.gradle.kts | 13 +++++----- 29 files changed, 130 insertions(+), 62 deletions(-) create mode 100644 controls-plc4x/README.md create mode 100644 magix/magix-utils/README.md create mode 100644 simulation-kt/README.md diff --git a/README.md b/README.md index 6b9c9cd..256b87d 100644 --- a/README.md +++ b/README.md @@ -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. > diff --git a/controls-constructor/README.md b/controls-constructor/README.md index 7da4d0b..f2186bd 100644 --- a/controls-constructor/README.md +++ b/controls-constructor/README.md @@ -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") } ``` diff --git a/controls-core/README.md b/controls-core/README.md index 26ed618..f7bc0bd 100644 --- a/controls-core/README.md +++ b/controls-core/README.md @@ -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") } ``` diff --git a/controls-jupyter/README.md b/controls-jupyter/README.md index 6100ddd..045b8d0 100644 --- a/controls-jupyter/README.md +++ b/controls-jupyter/README.md @@ -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") } ``` diff --git a/controls-magix/README.md b/controls-magix/README.md index c474221..f2dd35f 100644 --- a/controls-magix/README.md +++ b/controls-magix/README.md @@ -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") } ``` diff --git a/controls-modbus/README.md b/controls-modbus/README.md index 9705e81..ef52403 100644 --- a/controls-modbus/README.md +++ b/controls-modbus/README.md @@ -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") } ``` diff --git a/controls-opcua/README.md b/controls-opcua/README.md index 6867492..1d65c9d 100644 --- a/controls-opcua/README.md +++ b/controls-opcua/README.md @@ -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") } ``` diff --git a/controls-pi/README.md b/controls-pi/README.md index 0afb324..9c36e60 100644 --- a/controls-pi/README.md +++ b/controls-pi/README.md @@ -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") } ``` diff --git a/controls-plc4x/README.md b/controls-plc4x/README.md new file mode 100644 index 0000000..21cf398 --- /dev/null +++ b/controls-plc4x/README.md @@ -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") +} +``` diff --git a/controls-ports-ktor/README.md b/controls-ports-ktor/README.md index 1cb277a..376bd13 100644 --- a/controls-ports-ktor/README.md +++ b/controls-ports-ktor/README.md @@ -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") } ``` diff --git a/controls-serial/README.md b/controls-serial/README.md index ce95ee5..44598d0 100644 --- a/controls-serial/README.md +++ b/controls-serial/README.md @@ -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") } ``` diff --git a/controls-server/README.md b/controls-server/README.md index 896020d..f143d50 100644 --- a/controls-server/README.md +++ b/controls-server/README.md @@ -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") } ``` diff --git a/controls-storage/README.md b/controls-storage/README.md index dd4ab3d..116792d 100644 --- a/controls-storage/README.md +++ b/controls-storage/README.md @@ -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") } ``` diff --git a/controls-storage/controls-xodus/README.md b/controls-storage/controls-xodus/README.md index 44cdf26..e206f1e 100644 --- a/controls-storage/controls-xodus/README.md +++ b/controls-storage/controls-xodus/README.md @@ -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") } ``` diff --git a/controls-vision/README.md b/controls-vision/README.md index ff2b648..750f60f 100644 --- a/controls-vision/README.md +++ b/controls-vision/README.md @@ -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") } ``` diff --git a/controls-visualisation-compose/README.md b/controls-visualisation-compose/README.md index 0f77d54..da0d9ef 100644 --- a/controls-visualisation-compose/README.md +++ b/controls-visualisation-compose/README.md @@ -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") } ``` diff --git a/demo/device-collective/README.md b/demo/device-collective/README.md index 369ec04..433a46f 100644 --- a/demo/device-collective/README.md +++ b/demo/device-collective/README.md @@ -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--.jar`. You can copy it and run with `java -jar .jar` diff --git a/magix/magix-api/README.md b/magix/magix-api/README.md index 6f16ac0..0feb75d 100644 --- a/magix/magix-api/README.md +++ b/magix/magix-api/README.md @@ -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") } ``` diff --git a/magix/magix-java-endpoint/README.md b/magix/magix-java-endpoint/README.md index 87359f1..5b269a0 100644 --- a/magix/magix-java-endpoint/README.md +++ b/magix/magix-java-endpoint/README.md @@ -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") } ``` diff --git a/magix/magix-mqtt/README.md b/magix/magix-mqtt/README.md index 0ee054a..3661749 100644 --- a/magix/magix-mqtt/README.md +++ b/magix/magix-mqtt/README.md @@ -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") } ``` diff --git a/magix/magix-rabbit/README.md b/magix/magix-rabbit/README.md index 35b43c7..db0de2c 100644 --- a/magix/magix-rabbit/README.md +++ b/magix/magix-rabbit/README.md @@ -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") } ``` diff --git a/magix/magix-rsocket/README.md b/magix/magix-rsocket/README.md index 9f3a42c..b3cf1ba 100644 --- a/magix/magix-rsocket/README.md +++ b/magix/magix-rsocket/README.md @@ -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") } ``` diff --git a/magix/magix-server/README.md b/magix/magix-server/README.md index 8259e0f..4e0968e 100644 --- a/magix/magix-server/README.md +++ b/magix/magix-server/README.md @@ -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") } ``` diff --git a/magix/magix-storage/README.md b/magix/magix-storage/README.md index 672458e..f8d3c09 100644 --- a/magix/magix-storage/README.md +++ b/magix/magix-storage/README.md @@ -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") } ``` diff --git a/magix/magix-storage/magix-storage-xodus/README.md b/magix/magix-storage/magix-storage-xodus/README.md index 2fb495a..3a4a469 100644 --- a/magix/magix-storage/magix-storage-xodus/README.md +++ b/magix/magix-storage/magix-storage-xodus/README.md @@ -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") } ``` diff --git a/magix/magix-utils/README.md b/magix/magix-utils/README.md new file mode 100644 index 0000000..95f51a9 --- /dev/null +++ b/magix/magix-utils/README.md @@ -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") +} +``` diff --git a/magix/magix-zmq/README.md b/magix/magix-zmq/README.md index 952e02e..23c17c7 100644 --- a/magix/magix-zmq/README.md +++ b/magix/magix-zmq/README.md @@ -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") } ``` diff --git a/simulation-kt/README.md b/simulation-kt/README.md new file mode 100644 index 0000000..ed4308e --- /dev/null +++ b/simulation-kt/README.md @@ -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") +} +``` diff --git a/simulation-kt/build.gradle.kts b/simulation-kt/build.gradle.kts index b365d98..a80b1df 100644 --- a/simulation-kt/build.gradle.kts +++ b/simulation-kt/build.gradle.kts @@ -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" } } \ No newline at end of file