From 96d8a18897f590332e1056f15e86721377a59160 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 18 Jul 2025 10:54:44 -0400 Subject: [PATCH 01/41] [#1] Added tryspace-fsw as a submodule; --- .gitmodules | 4 ++++ fsw | 1 + 2 files changed, 5 insertions(+) create mode 100644 .gitmodules create mode 160000 fsw diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..3cdd372 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "fsw"] + path = fsw + url = https://github.com/TrySpaceOrg/tryspace-fsw.git + branch = main diff --git a/fsw b/fsw new file mode 160000 index 0000000..07c4b68 --- /dev/null +++ b/fsw @@ -0,0 +1 @@ +Subproject commit 07c4b68b790cb29f65d81ed1d6a940bd68e4a329 From 5727a1f34261dad33e1f8e5217913dab8fee88fe Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 18 Jul 2025 14:48:37 -0400 Subject: [PATCH 02/41] [#1] Updated fsw after confirmed successfully building and creating runtime; --- fsw | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fsw b/fsw index 07c4b68..1611519 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 07c4b68b790cb29f65d81ed1d6a940bd68e4a329 +Subproject commit 1611519225236831a67fe9ff15d4b34b5184f10d From dfab3b7ae4d681e0a7148a21646aac305cfa08ae Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 18 Jul 2025 14:58:41 -0400 Subject: [PATCH 03/41] [#1] Updated FSW submodule after PR review; --- fsw | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fsw b/fsw index 1611519..5acee35 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 1611519225236831a67fe9ff15d4b34b5184f10d +Subproject commit 5acee35c3b8f1a0098e284798165038a5de0ab3a From 0bb0929171867835504e09c1c7c8441c768495ae Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 18 Jul 2025 15:23:11 -0400 Subject: [PATCH 04/41] [#5] Added demo component as a submodule; --- .gitmodules | 4 ++++ comp/demo | 1 + 2 files changed, 5 insertions(+) create mode 160000 comp/demo diff --git a/.gitmodules b/.gitmodules index 3cdd372..6161b27 100644 --- a/.gitmodules +++ b/.gitmodules @@ -2,3 +2,7 @@ path = fsw url = https://github.com/TrySpaceOrg/tryspace-fsw.git branch = main +[submodule "comp/demo"] + path = comp/demo + url = https://github.com/TrySpaceOrg/tryspace-comp-demo.git + branch = main diff --git a/comp/demo b/comp/demo new file mode 160000 index 0000000..729a42f --- /dev/null +++ b/comp/demo @@ -0,0 +1 @@ +Subproject commit 729a42f1e1fbc3e97f6c12269a9fc2ef1a1ebae5 From 5984aab8a3e2565c8f12c6b410e6fd2af6337451 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 18 Jul 2025 18:15:31 -0400 Subject: [PATCH 05/41] [#5] Added simultih submodule; --- .gitmodules | 4 ++++ comp/demo | 2 +- simulith | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) create mode 160000 simulith diff --git a/.gitmodules b/.gitmodules index 6161b27..c03f2cc 100644 --- a/.gitmodules +++ b/.gitmodules @@ -6,3 +6,7 @@ path = comp/demo url = https://github.com/TrySpaceOrg/tryspace-comp-demo.git branch = main +[submodule "simulith"] + path = simulith + url = https://github.com/TrySpaceOrg/tryspace-simulith.git + branch = main diff --git a/comp/demo b/comp/demo index 729a42f..f320bbe 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 729a42f1e1fbc3e97f6c12269a9fc2ef1a1ebae5 +Subproject commit f320bbee04b71fa84a1f8cde3f9954bbe2e681b1 diff --git a/simulith b/simulith new file mode 160000 index 0000000..1465c43 --- /dev/null +++ b/simulith @@ -0,0 +1 @@ +Subproject commit 1465c43a061697afe81de1c70ef493aafd0e5373 From 75b88745c13ac6aed08d6fdf96fc9337859785c8 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 18 Jul 2025 21:15:24 -0400 Subject: [PATCH 06/41] [tryspaceorg/tryspace-lab#5] Moved to use a tryspace-lab container as the base; --- Makefile | 58 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 ++-- cfg/Dockerfile.base | 21 ++++++++++++++++ fsw | 2 +- simulith | 2 +- 5 files changed, 83 insertions(+), 4 deletions(-) create mode 100644 Makefile create mode 100644 cfg/Dockerfile.base diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..0adfb2b --- /dev/null +++ b/Makefile @@ -0,0 +1,58 @@ +# Makefile for TrySpace Lab development +.PHONY: all build build-fsw build-gsw build-sim debug run clean container runtime + +export BUILD_IMAGE_NAME ?= tryspace-lab + +# Commands +all: build + +build: + $(MAKE) build-fsw + +build-fsw: + docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_build" -w $(CURDIR)/fsw --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-fsw + +build-gsw: + +build-sim: + docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_sim_build" -w $(CURDIR)/sim --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-sim + +debug: + docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_debug" -w $(CURDIR) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) /bin/bash + +clean: + $(MAKE) clean-fsw + $(MAKE) clean-gsw + $(MAKE) clean-sim + +clean-fsw: + cd fsw && $(MAKE) clean + +clean-gsw: + + +clean-sim: + cd simulith && $(MAKE) clean + +container: + docker build -t $(BUILD_IMAGE_NAME) -f cfg/Dockerfile.base . + +runtime: + $(MAKE) container + cd fsw && $(MAKE) runtime + +start: + $(MAKE) start-fsw + $(MAKE) start-gsw + $(MAKE) start-sim + +start-fsw: + cd fsw && $(MAKE) start + +start-gsw: + + +start-sim: + +stop: + docker ps --filter name=tryspace-* --filter status=running -aq | xargs docker stop diff --git a/README.md b/README.md index f9c362c..93a2bc5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,2 @@ -# tryspace-lab -Entrypoint for orchestrating full TrySpace simulation environments +# TrySpace Lab +Entrypoint for orchestrating full TrySpace simulation environments. diff --git a/cfg/Dockerfile.base b/cfg/Dockerfile.base new file mode 100644 index 0000000..6eb464d --- /dev/null +++ b/cfg/Dockerfile.base @@ -0,0 +1,21 @@ +# TrySpace FSW Dockerfile +# https://github.com/TrySpaceOrg/tryspace-lab +# +# docker push ghcr.io/tryspaceorg/tryspace-lab:latest +# + +FROM debian:bookworm-slim@sha256:6ac2c08566499cc2415926653cf2ed7c3aedac445675a013cc09469c9e118fdd +LABEL maintainer="TrySpaceOrg" description="Base image for TrySpace Lab" + +# Install required tools +RUN apt-get update && \ + apt-get install -y --no-install-recommends \ + build-essential=12.9 \ + cmake=3.25.1-1 \ + git=1:2.39.5-0+deb12u2 \ + libzmq3-dev=4.3.4-6 \ + pkg-config=1.8.1-1 \ + && apt-get clean && rm -rf /var/lib/apt/lists/* + +# (Optional) Set up cross-compiler toolchain (example: LEON3) +# RUN apt-get update && apt-get install -y gcc-sparc64-linux-gnu diff --git a/fsw b/fsw index 5acee35..0dd70a8 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 5acee35c3b8f1a0098e284798165038a5de0ab3a +Subproject commit 0dd70a890af71ba2cf82bd76ff2c8ad62d79b8d4 diff --git a/simulith b/simulith index 1465c43..6c952e2 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 1465c43a061697afe81de1c70ef493aafd0e5373 +Subproject commit 6c952e29410aefa6ecf8a4acc19e2fda6342fcb7 From 5eb8f31fae35aff0c806a0b3870dd1aba7534b70 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Sun, 20 Jul 2025 08:15:14 -0400 Subject: [PATCH 07/41] [tryspaceorg/tryspace-lab#5] Demo component cli and sim building; --- .gitignore | 2 ++ comp/CompFlags.cmake | 42 ++++++++++++++++++++++++++++++++++++++++++ comp/demo | 2 +- fsw | 2 +- 4 files changed, 46 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 comp/CompFlags.cmake diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..af96791 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.vscode +build diff --git a/comp/CompFlags.cmake b/comp/CompFlags.cmake new file mode 100644 index 0000000..3a6455f --- /dev/null +++ b/comp/CompFlags.cmake @@ -0,0 +1,42 @@ +# TrySpace-Lab Component Settings +include(CheckCCompilerFlag) + +set(TRYSPACE_C_FLAGS + "-Wall" + "-Wextra" + "-Wpedantic" + "-Wformat=2" + "-Wno-discarded-qualifiers" + "-Winline" + "-Wpointer-arith" + "-Wredundant-decls" + "-Wwrite-strings" + "-Wuninitialized" + "-Winit-self" + "-Wswitch-default" + "-Wfloat-equal" + "-Wno-packed" + "-Wno-unused-parameter" + "-Wvariadic-macros" + "-Wvla" + "-Wstrict-overflow" + "-Wstrict-overflow=5" + "-fdiagnostics-show-option" + "-pedantic-errors" + "-fprofile-arcs" + "-ftest-coverage" +) + +# Example: Add target-specific flags +# if(${TGTNAME} STREQUAL cpu1) +# list(APPEND TRYSPACE_C_FLAGS "-Wformat=0") +# endif() + +# GCC-only flags +if(CMAKE_COMPILER_IS_GNUCC) + list(APPEND TRYSPACE_C_FLAGS "-Wlogical-op" "-Wunsafe-loop-optimizations") +endif() + +# Convert list to string and append to CMAKE_C_FLAGS +string(REPLACE ";" " " TRYSPACE_C_FLAGS "${TRYSPACE_C_FLAGS}") +set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${TRYSPACE_C_FLAGS}") diff --git a/comp/demo b/comp/demo index f320bbe..6f874a7 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit f320bbee04b71fa84a1f8cde3f9954bbe2e681b1 +Subproject commit 6f874a7b2e8b8b33dc66fda3723812a359d8839d diff --git a/fsw b/fsw index 0dd70a8..ecca433 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 0dd70a890af71ba2cf82bd76ff2c8ad62d79b8d4 +Subproject commit ecca433f3e8ea7ee64b3839f5b363b490400be24 From e3958027a407b309b782e87f6c1a72f201c9cdf5 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Sun, 20 Jul 2025 22:16:02 -0400 Subject: [PATCH 08/41] [tryspaceorg/tryspace-lab#5] Demo component CLI to SIM getting time tics; --- comp/demo | 2 +- fsw | 2 +- simulith | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/comp/demo b/comp/demo index 6f874a7..42fd525 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 6f874a7b2e8b8b33dc66fda3723812a359d8839d +Subproject commit 42fd5256adabf8a5340f190e3b4f46cabe7966c4 diff --git a/fsw b/fsw index ecca433..30b558f 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit ecca433f3e8ea7ee64b3839f5b363b490400be24 +Subproject commit 30b558fd2c1b9fc983564b0d17ddcef784a8ad32 diff --git a/simulith b/simulith index 6c952e2..86af9cc 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 6c952e29410aefa6ecf8a4acc19e2fda6342fcb7 +Subproject commit 86af9cc2f3463046b128d6ffd43e56d009c76e25 From dfd8933189d41cedce6bee548e51da057d748541 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Wed, 23 Jul 2025 20:04:47 -0400 Subject: [PATCH 09/41] [tryspaceorg/tryspace-lab#5] support/cli-compose.yml confirmed functional; --- comp/demo | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/comp/demo b/comp/demo index 42fd525..8b8a65d 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 42fd5256adabf8a5340f190e3b4f46cabe7966c4 +Subproject commit 8b8a65dbedab522b70a229c8bcc08f75f9c89458 From 5d8014fa24117f92a0ee1df749c5be87e090601e Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Wed, 23 Jul 2025 21:27:41 -0400 Subject: [PATCH 10/41] [tryspaceorg/tryspace-lab#5] Made building simulith tests optional and added CLI interface for server to pause/play and run faster/slower than real time; --- comp/demo | 2 +- simulith | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/comp/demo b/comp/demo index 8b8a65d..d578f05 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 8b8a65dbedab522b70a229c8bcc08f75f9c89458 +Subproject commit d578f0514877b8e7adfcce15dacc8d76757ac898 diff --git a/simulith b/simulith index 86af9cc..2457a94 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 86af9cc2f3463046b128d6ffd43e56d009c76e25 +Subproject commit 2457a9414da8e6b858b26787606e121f6e28eb19 From 0c52e297718efd8e25f22654484d0e3b7c56ec81 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 25 Jul 2025 09:44:52 -0400 Subject: [PATCH 11/41] [tryspaceorg/tryspace-lab#5] Submodule updates after testing and merges; --- comp/demo | 2 +- fsw | 2 +- simulith | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/comp/demo b/comp/demo index d578f05..c1468fc 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit d578f0514877b8e7adfcce15dacc8d76757ac898 +Subproject commit c1468fce6903e373a7c41659abded8ccb6843e3e diff --git a/fsw b/fsw index 30b558f..713d8ce 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 30b558fd2c1b9fc983564b0d17ddcef784a8ad32 +Subproject commit 713d8ceb59139ccd1f1944308a01643d02aaa4f7 diff --git a/simulith b/simulith index 2457a94..71570d3 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 2457a9414da8e6b858b26787606e121f6e28eb19 +Subproject commit 71570d302b638c16b60a819a96d58e3e32783f1c From 9f23cae17902453cac8f205642f8e80a5c0e1260 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 25 Jul 2025 17:50:15 -0400 Subject: [PATCH 12/41] [#3] Created lab-compose.yml file and updated FSW to use simulith time; --- .gitignore | 1 + Makefile | 35 +++++++++++++++++++++----------- cfg/lab-compose.yml | 49 +++++++++++++++++++++++++++++++++++++++++++++ fsw | 2 +- simulith | 2 +- 5 files changed, 75 insertions(+), 14 deletions(-) create mode 100644 cfg/lab-compose.yml diff --git a/.gitignore b/.gitignore index af96791..3c6fba1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .vscode build +cfg/.env diff --git a/Makefile b/Makefile index 0adfb2b..33ccb39 100644 --- a/Makefile +++ b/Makefile @@ -1,26 +1,37 @@ # Makefile for TrySpace Lab development -.PHONY: all build build-fsw build-gsw build-sim debug run clean container runtime +.PHONY: all build build-fsw build-gsw build-sim debug clean container runtime start stop export BUILD_IMAGE_NAME ?= tryspace-lab # Commands all: build -build: +env: + @if [ ! -f $(CURDIR)/cfg/.env ]; then \ + echo "Creating $(CURDIR)/cfg/.env with current user UID/GID..."; \ + mkdir -p $(CURDIR)/cfg; \ + echo "UID=$$(id -u)" > $(CURDIR)/cfg/.env; \ + echo "GID=$$(id -g)" >> $(CURDIR)/cfg/.env; \ + echo "Created $(CURDIR)/cfg/.env"; \ + fi + +build: env $(MAKE) build-fsw + $(MAKE) build-sim build-fsw: - docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_build" -w $(CURDIR)/fsw --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-fsw + docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_build" -w $(CURDIR)/fsw --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-fsw build-gsw: build-sim: - docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_sim_build" -w $(CURDIR)/sim --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-sim + docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_sim_build" -w $(CURDIR)/simulith --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-sim debug: - docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_debug" -w $(CURDIR) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) /bin/bash + docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_debug" -w $(CURDIR) --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) /bin/bash clean: + $(MAKE) stop $(MAKE) clean-fsw $(MAKE) clean-gsw $(MAKE) clean-sim @@ -37,14 +48,13 @@ clean-sim: container: docker build -t $(BUILD_IMAGE_NAME) -f cfg/Dockerfile.base . -runtime: +runtime: env $(MAKE) container - cd fsw && $(MAKE) runtime + cd $(CURDIR)/fsw && $(MAKE) runtime + cd $(CURDIR)/simulith && $(MAKE) runtime -start: - $(MAKE) start-fsw - $(MAKE) start-gsw - $(MAKE) start-sim +start: env + docker compose -f ./cfg/lab-compose.yml up start-fsw: cd fsw && $(MAKE) start @@ -53,6 +63,7 @@ start-gsw: start-sim: + cd simulith && $(MAKE) start stop: - docker ps --filter name=tryspace-* --filter status=running -aq | xargs docker stop + docker compose -f ./cfg/lab-compose.yml down diff --git a/cfg/lab-compose.yml b/cfg/lab-compose.yml new file mode 100644 index 0000000..3fbdba7 --- /dev/null +++ b/cfg/lab-compose.yml @@ -0,0 +1,49 @@ +# Start +# docker compose -f lab-compose.yml up +# View specific containers +# docker attach tryspace-fsw +# docker attach tryspace-comp-demo-sim +# docker attach tryspace-sim +services: + tryspace-sim: + image: tryspace-sim:latest + container_name: tryspace-sim + networks: + - tryspace-net + restart: unless-stopped + stdin_open: true + tty: true + + #tryspace-comp-demo-sim: + # image: tryspace-comp-demo-sim:latest + # container_name: tryspace-comp-demo-sim + # networks: + # - tryspace-net + # restart: unless-stopped + # depends_on: + # - tryspace-sim + + tryspace-fsw: + image: tryspace-fsw:latest + container_name: tryspace-fsw + networks: + - tryspace-net + restart: unless-stopped + stdin_open: true + tty: true + depends_on: + - tryspace-sim + # - tryspace-comp-demo-sim + sysctls: + - fs.mqueue.msg_max=10000 + ulimits: + rtprio: 99 + cap_add: + - SYS_NICE + #command: > + # sh -c "touch /app/.cdskeyfile /app/.resetkeyfile /app/.reservedkeyfile && + # /app/core-cpu1" + +networks: + tryspace-net: + driver: bridge diff --git a/fsw b/fsw index 713d8ce..8c82bb1 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 713d8ceb59139ccd1f1944308a01643d02aaa4f7 +Subproject commit 8c82bb19e3fbd465840e0f5554bd8d86b924c432 diff --git a/simulith b/simulith index 71570d3..75eb696 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 71570d302b638c16b60a819a96d58e3e32783f1c +Subproject commit 75eb69674d062c7fe662030b6aebd1d8b74c320b From bffc70572cbef2d35a763e8f8e7a51cda4934316 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Sat, 26 Jul 2025 08:51:24 -0400 Subject: [PATCH 13/41] [#3] Launch demo sim in lab compose; --- Makefile | 3 ++- cfg/Dockerfile.base | 1 + cfg/lab-compose.yml | 26 +++++++++++++------------- comp/demo | 2 +- fsw | 2 +- simulith | 2 +- 6 files changed, 19 insertions(+), 17 deletions(-) diff --git a/Makefile b/Makefile index 33ccb39..bf97587 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ export BUILD_IMAGE_NAME ?= tryspace-lab # Commands -all: build +all: runtime env: @if [ ! -f $(CURDIR)/cfg/.env ]; then \ @@ -50,6 +50,7 @@ container: runtime: env $(MAKE) container + cd $(CURDIR)/comp/demo/sim && $(MAKE) runtime cd $(CURDIR)/fsw && $(MAKE) runtime cd $(CURDIR)/simulith && $(MAKE) runtime diff --git a/cfg/Dockerfile.base b/cfg/Dockerfile.base index 6eb464d..b633766 100644 --- a/cfg/Dockerfile.base +++ b/cfg/Dockerfile.base @@ -13,6 +13,7 @@ RUN apt-get update && \ build-essential=12.9 \ cmake=3.25.1-1 \ git=1:2.39.5-0+deb12u2 \ + libsocketcan-dev=0.0.12-1 \ libzmq3-dev=4.3.4-6 \ pkg-config=1.8.1-1 \ && apt-get clean && rm -rf /var/lib/apt/lists/* diff --git a/cfg/lab-compose.yml b/cfg/lab-compose.yml index 3fbdba7..fef4706 100644 --- a/cfg/lab-compose.yml +++ b/cfg/lab-compose.yml @@ -13,15 +13,18 @@ services: restart: unless-stopped stdin_open: true tty: true + environment: + - NUM_CLIENTS=${NUM_CLIENTS:-2} + command: ["/bin/sh", "-c", "/app/simulith_server_standalone $${NUM_CLIENTS}"] - #tryspace-comp-demo-sim: - # image: tryspace-comp-demo-sim:latest - # container_name: tryspace-comp-demo-sim - # networks: - # - tryspace-net - # restart: unless-stopped - # depends_on: - # - tryspace-sim + tryspace-comp-demo-sim: + image: tryspace-comp-demo-sim:latest + container_name: tryspace-comp-demo-sim + networks: + - tryspace-net + restart: unless-stopped + depends_on: + - tryspace-sim tryspace-fsw: image: tryspace-fsw:latest @@ -33,17 +36,14 @@ services: tty: true depends_on: - tryspace-sim - # - tryspace-comp-demo-sim + - tryspace-comp-demo-sim sysctls: - fs.mqueue.msg_max=10000 ulimits: rtprio: 99 cap_add: - SYS_NICE - #command: > - # sh -c "touch /app/.cdskeyfile /app/.resetkeyfile /app/.reservedkeyfile && - # /app/core-cpu1" - + networks: tryspace-net: driver: bridge diff --git a/comp/demo b/comp/demo index c1468fc..a588f61 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit c1468fce6903e373a7c41659abded8ccb6843e3e +Subproject commit a588f61ad50d2aaf4c2cf5b979255f46b66bf601 diff --git a/fsw b/fsw index 8c82bb1..f2860e0 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 8c82bb19e3fbd465840e0f5554bd8d86b924c432 +Subproject commit f2860e08824151b849ebe9527c88f72550d0f6b2 diff --git a/simulith b/simulith index 75eb696..0d12f3e 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 75eb69674d062c7fe662030b6aebd1d8b74c320b +Subproject commit 0d12f3ea17016c8febd489f5f685534dd63e7e03 From 7a010b7a9d3aa5f77c06b808d82d1a822287d4ac Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Sat, 26 Jul 2025 09:03:43 -0400 Subject: [PATCH 14/41] [#3] Updates after submodule merges; --- comp/demo | 2 +- fsw | 2 +- simulith | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/comp/demo b/comp/demo index a588f61..4f16456 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit a588f61ad50d2aaf4c2cf5b979255f46b66bf601 +Subproject commit 4f16456adf1207973792bc2aade92c64c0530f0c diff --git a/fsw b/fsw index f2860e0..288848a 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit f2860e08824151b849ebe9527c88f72550d0f6b2 +Subproject commit 288848a6e3fb7e88ce14c457b9a56de474e407b8 diff --git a/simulith b/simulith index 0d12f3e..d655909 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 0d12f3ea17016c8febd489f5f685534dd63e7e03 +Subproject commit d655909d1d7d2f4d9ae6451fc992b15102888223 From 090dec80d7a5fd5a935e5a2a474a7de7ad69ce44 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Sun, 27 Jul 2025 10:46:27 -0400 Subject: [PATCH 15/41] [tryspaceorg/tryspace-lab#6] Created director of simulations; --- Makefile | 2 +- cfg/lab-compose.yml | 25 ++++++++++++++----------- comp/demo | 2 +- fsw | 2 +- simulith | 2 +- 5 files changed, 18 insertions(+), 15 deletions(-) diff --git a/Makefile b/Makefile index bf97587..a5e2bec 100644 --- a/Makefile +++ b/Makefile @@ -52,7 +52,7 @@ runtime: env $(MAKE) container cd $(CURDIR)/comp/demo/sim && $(MAKE) runtime cd $(CURDIR)/fsw && $(MAKE) runtime - cd $(CURDIR)/simulith && $(MAKE) runtime + cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server start: env docker compose -f ./cfg/lab-compose.yml up diff --git a/cfg/lab-compose.yml b/cfg/lab-compose.yml index fef4706..ecb2fa8 100644 --- a/cfg/lab-compose.yml +++ b/cfg/lab-compose.yml @@ -2,12 +2,12 @@ # docker compose -f lab-compose.yml up # View specific containers # docker attach tryspace-fsw -# docker attach tryspace-comp-demo-sim -# docker attach tryspace-sim +# docker attach tryspace-director +# docker attach tryspace-server services: - tryspace-sim: - image: tryspace-sim:latest - container_name: tryspace-sim + tryspace-server: + image: tryspace-server:latest + container_name: tryspace-server networks: - tryspace-net restart: unless-stopped @@ -17,14 +17,17 @@ services: - NUM_CLIENTS=${NUM_CLIENTS:-2} command: ["/bin/sh", "-c", "/app/simulith_server_standalone $${NUM_CLIENTS}"] - tryspace-comp-demo-sim: - image: tryspace-comp-demo-sim:latest - container_name: tryspace-comp-demo-sim + tryspace-director: + image: tryspace-director:latest + container_name: tryspace-director networks: - tryspace-net restart: unless-stopped + stdin_open: true + tty: true depends_on: - - tryspace-sim + - tryspace-server + command: ["/app/simulith_director_standalone"] tryspace-fsw: image: tryspace-fsw:latest @@ -35,8 +38,8 @@ services: stdin_open: true tty: true depends_on: - - tryspace-sim - - tryspace-comp-demo-sim + - tryspace-server + - tryspace-director sysctls: - fs.mqueue.msg_max=10000 ulimits: diff --git a/comp/demo b/comp/demo index 4f16456..783ee6b 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 4f16456adf1207973792bc2aade92c64c0530f0c +Subproject commit 783ee6b7f52121b1666d247157701f73a99c23e4 diff --git a/fsw b/fsw index 288848a..2032ae7 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 288848a6e3fb7e88ce14c457b9a56de474e407b8 +Subproject commit 2032ae7a4f5cdca1e4460640a7e64ea419d444ed diff --git a/simulith b/simulith index d655909..50d73e6 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit d655909d1d7d2f4d9ae6451fc992b15102888223 +Subproject commit 50d73e6ba4a740789824304be09615487821e20a From b3264f2a5a65511d07ab86927d416b6f5c7b44c0 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Mon, 28 Jul 2025 21:04:24 -0400 Subject: [PATCH 16/41] [tryspaceorg/tryspace-lab#6] Updates to FSW an simulith to improve OSAL; --- fsw | 2 +- simulith | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/fsw b/fsw index 2032ae7..a762477 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 2032ae7a4f5cdca1e4460640a7e64ea419d444ed +Subproject commit a7624775f43940230da85c19fb81e5ec19a7ea22 diff --git a/simulith b/simulith index 50d73e6..a77edcc 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 50d73e6ba4a740789824304be09615487821e20a +Subproject commit a77edccc249df1ac9a770579b5ca813fa62dbe7c From 5f2a48db92323c5a72893bb05cd8324d568d9f4a Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Wed, 30 Jul 2025 07:05:31 -0400 Subject: [PATCH 17/41] [tryspaceorg/tryspace-lab#6] Change to use local IPC for simulith ZMQ; --- Makefile | 4 ++-- cfg/Dockerfile.base | 6 ++++++ cfg/lab-compose.yml | 28 ++++++++++++++++++++++++++++ comp/demo | 2 +- fsw | 2 +- simulith | 2 +- 6 files changed, 39 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index a5e2bec..6f78ba3 100644 --- a/Makefile +++ b/Makefile @@ -27,7 +27,7 @@ build-gsw: build-sim: docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_sim_build" -w $(CURDIR)/simulith --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-sim -debug: +debug: env docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_debug" -w $(CURDIR) --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) /bin/bash clean: @@ -46,7 +46,7 @@ clean-sim: cd simulith && $(MAKE) clean container: - docker build -t $(BUILD_IMAGE_NAME) -f cfg/Dockerfile.base . + docker build -t $(BUILD_IMAGE_NAME) -f cfg/Dockerfile.base --build-arg USER_ID=$(shell id -u) --build-arg GROUP_ID=$(shell id -g) . runtime: env $(MAKE) container diff --git a/cfg/Dockerfile.base b/cfg/Dockerfile.base index b633766..a1aecd9 100644 --- a/cfg/Dockerfile.base +++ b/cfg/Dockerfile.base @@ -18,5 +18,11 @@ RUN apt-get update && \ pkg-config=1.8.1-1 \ && apt-get clean && rm -rf /var/lib/apt/lists/* +# Create user for development (matches host user) +ARG USER_ID=1000 +ARG GROUP_ID=1000 +RUN groupadd -g ${GROUP_ID} developer && \ + useradd -u ${USER_ID} -g ${GROUP_ID} -m -s /bin/bash tryspace + # (Optional) Set up cross-compiler toolchain (example: LEON3) # RUN apt-get update && apt-get install -y gcc-sparc64-linux-gnu diff --git a/cfg/lab-compose.yml b/cfg/lab-compose.yml index ecb2fa8..8bc66d3 100644 --- a/cfg/lab-compose.yml +++ b/cfg/lab-compose.yml @@ -16,6 +16,15 @@ services: environment: - NUM_CLIENTS=${NUM_CLIENTS:-2} command: ["/bin/sh", "-c", "/app/simulith_server_standalone $${NUM_CLIENTS}"] + cpus: "4.0" + mem_limit: 2g + volumes: + - simulith_ipc:/tmp + tmpfs: + - /dev/shm:noexec,nosuid,size=1g + security_opt: + - seccomp:unconfined + privileged: false tryspace-director: image: tryspace-director:latest @@ -28,6 +37,12 @@ services: depends_on: - tryspace-server command: ["/app/simulith_director_standalone"] + cpus: "1.0" + mem_limit: 512m + volumes: + - simulith_ipc:/tmp + tmpfs: + - /dev/shm:noexec,nosuid,size=100m tryspace-fsw: image: tryspace-fsw:latest @@ -46,7 +61,20 @@ services: rtprio: 99 cap_add: - SYS_NICE + cpus: "4.0" + mem_limit: 2g + volumes: + - simulith_ipc:/tmp + tmpfs: + - /dev/shm:noexec,nosuid,size=1g + security_opt: + - seccomp:unconfined + privileged: false networks: tryspace-net: driver: bridge + +volumes: + simulith_ipc: + driver: local diff --git a/comp/demo b/comp/demo index 783ee6b..b4c4d23 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 783ee6b7f52121b1666d247157701f73a99c23e4 +Subproject commit b4c4d239bce714b46f3b9ff0e3bb68ca3695dfc0 diff --git a/fsw b/fsw index a762477..2bf82b3 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit a7624775f43940230da85c19fb81e5ec19a7ea22 +Subproject commit 2bf82b36ae53427e863ad2aeceade9c716447000 diff --git a/simulith b/simulith index a77edcc..9549707 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit a77edccc249df1ac9a770579b5ca813fa62dbe7c +Subproject commit 9549707527471182706af124c3e2eb760d5f7fe4 From d5440503e9ba2e323328512a91dc731c318a19e4 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Wed, 30 Jul 2025 19:56:20 -0400 Subject: [PATCH 18/41] [tryspaceorg/tryspace-lab#6] Enable demo app by default; --- comp/demo | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/comp/demo b/comp/demo index b4c4d23..7a5cee6 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit b4c4d239bce714b46f3b9ff0e3bb68ca3695dfc0 +Subproject commit 7a5cee6d30fd06e091a9cde404e40aa39bf1af4e From 01aae0e24dba62160b61d9ab3deef3ed1fcb6d11 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Wed, 30 Jul 2025 19:58:26 -0400 Subject: [PATCH 19/41] [tryspaceorg/tryspace-lab#6] Submodule updates after merges; --- comp/demo | 2 +- fsw | 2 +- simulith | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/comp/demo b/comp/demo index 7a5cee6..828b69e 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 7a5cee6d30fd06e091a9cde404e40aa39bf1af4e +Subproject commit 828b69e25bec15a0859421e8d64633ab1dbb68d7 diff --git a/fsw b/fsw index 2bf82b3..205133a 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 2bf82b36ae53427e863ad2aeceade9c716447000 +Subproject commit 205133ad6872de290964f51bdd4da883a5932280 diff --git a/simulith b/simulith index 9549707..ac68ff7 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 9549707527471182706af124c3e2eb760d5f7fe4 +Subproject commit ac68ff79ed5cadc3ad9550aa8d93c0966ca22da0 From 2c377491ede7439362e8c779d7cbb9dfb03bfba0 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Thu, 31 Jul 2025 21:22:16 -0400 Subject: [PATCH 20/41] [tryspaceorg/tryspace-lab#11] Add 42 to simulith director and SVB use in demo component; --- comp/demo | 2 +- simulith | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/comp/demo b/comp/demo index 828b69e..eae143f 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 828b69e25bec15a0859421e8d64633ab1dbb68d7 +Subproject commit eae143f6ca227c93323ada1cc1e9ec9260f273e2 diff --git a/simulith b/simulith index ac68ff7..0e9f74f 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit ac68ff79ed5cadc3ad9550aa8d93c0966ca22da0 +Subproject commit 0e9f74f14a79238bb7aa9632cc315c1cc09f31ff From c8834707a04a1fdf1b95e9d8a86502534dcdb1a0 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 1 Aug 2025 09:00:39 -0400 Subject: [PATCH 21/41] [tryspaceorg/tryspace-lab#11] Merge submodules after PR review; --- comp/demo | 2 +- simulith | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/comp/demo b/comp/demo index eae143f..9f20973 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit eae143f6ca227c93323ada1cc1e9ec9260f273e2 +Subproject commit 9f2097378cd9e125e4566666c7f0fb40d6d78d87 diff --git a/simulith b/simulith index 0e9f74f..2b82d85 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 0e9f74f14a79238bb7aa9632cc315c1cc09f31ff +Subproject commit 2b82d858d49922b9083f492a96fa373370536918 From 32c36c1c210014aed0c4ae57608fb013552609a2 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 1 Aug 2025 11:25:38 -0400 Subject: [PATCH 22/41] [tryspaceorg/tryspace-lab#7] Move cli-compose.yml up to top level tryspace-lab; --- Makefile | 12 +++++++- cfg/cli-compose.yml | 69 +++++++++++++++++++++++++++++++++++++++++++++ comp/demo | 2 +- fsw | 2 +- 4 files changed, 82 insertions(+), 3 deletions(-) create mode 100644 cfg/cli-compose.yml diff --git a/Makefile b/Makefile index 6f78ba3..f25069c 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ # Makefile for TrySpace Lab development -.PHONY: all build build-fsw build-gsw build-sim debug clean container runtime start stop +.PHONY: all build build-fsw build-gsw build-sim build-cli debug clean container runtime start stop cli export BUILD_IMAGE_NAME ?= tryspace-lab @@ -19,6 +19,11 @@ build: env $(MAKE) build-fsw $(MAKE) build-sim +build-cli: env + $(MAKE) container + cd $(CURDIR)/comp/demo/cli && $(MAKE) runtime + cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server + build-fsw: docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_build" -w $(CURDIR)/fsw --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-fsw @@ -57,6 +62,10 @@ runtime: env start: env docker compose -f ./cfg/lab-compose.yml up +cli: env + $(MAKE) build-cli + docker compose -f ./cfg/cli-compose.yml up + start-fsw: cd fsw && $(MAKE) start @@ -67,4 +76,5 @@ start-sim: cd simulith && $(MAKE) start stop: + docker compose -f ./cfg/cli-compose.yml down docker compose -f ./cfg/lab-compose.yml down diff --git a/cfg/cli-compose.yml b/cfg/cli-compose.yml new file mode 100644 index 0000000..938a673 --- /dev/null +++ b/cfg/cli-compose.yml @@ -0,0 +1,69 @@ +# Start +# docker compose -f cli-compose.yml up +# View specific containers +# docker attach tryspace-comp-demo-cli +# docker attach tryspace-sim +# docker attach tryspace-director +services: + tryspace-sim: + image: tryspace-server:latest + container_name: tryspace-sim + networks: + - tryspace-net + restart: unless-stopped + stdin_open: true + tty: true + environment: + - NUM_CLIENTS=${NUM_CLIENTS:-1} + command: ["/bin/sh", "-c", "/app/simulith_server_standalone $${NUM_CLIENTS}"] + cpus: "4.0" + mem_limit: 2g + volumes: + - simulith_ipc:/tmp + tmpfs: + - /dev/shm:noexec,nosuid,size=1g + security_opt: + - seccomp:unconfined + privileged: false + + tryspace-director: + image: tryspace-director:latest + container_name: tryspace-director + networks: + - tryspace-net + restart: unless-stopped + stdin_open: true + tty: true + depends_on: + - tryspace-sim + command: ["/app/simulith_director_standalone"] + cpus: "1.0" + mem_limit: 512m + volumes: + - simulith_ipc:/tmp + tmpfs: + - /dev/shm:noexec,nosuid,size=100m + + tryspace-comp-demo-cli: + image: tryspace-comp-demo-cli:latest + container_name: tryspace-comp-demo-cli + networks: + - tryspace-net + restart: unless-stopped + stdin_open: true + tty: true + depends_on: + - tryspace-sim + - tryspace-director + volumes: + - simulith_ipc:/tmp + tmpfs: + - /dev/shm:noexec,nosuid,size=100m + +networks: + tryspace-net: + driver: bridge + +volumes: + simulith_ipc: + driver: local diff --git a/comp/demo b/comp/demo index 9f20973..bf779c7 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 9f2097378cd9e125e4566666c7f0fb40d6d78d87 +Subproject commit bf779c760b5cae90039a73377b4471e4e7c7497e diff --git a/fsw b/fsw index 205133a..217973c 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 205133ad6872de290964f51bdd4da883a5932280 +Subproject commit 217973c1a8663746e19ca0b39b3846da0d84f09d From 33ecf2eac7efb06ccf8c0384a16c97f2c95c9867 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Fri, 1 Aug 2025 13:14:05 -0400 Subject: [PATCH 23/41] [tryspaceorg/tryspace-lab#7] Updates to hwlib to resolve FSW use; --- fsw | 2 +- simulith | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/fsw b/fsw index 217973c..8edd6f2 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 217973c1a8663746e19ca0b39b3846da0d84f09d +Subproject commit 8edd6f2739771075dda87ecfe8c40679522eb6c0 diff --git a/simulith b/simulith index 2b82d85..098bf1b 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 2b82d858d49922b9083f492a96fa373370536918 +Subproject commit 098bf1b690cb13923c8f6d87c44d2ac01ee13f4a From b857e59e8c92c323c7781c6eb4e38f795c1382b3 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Mon, 4 Aug 2025 19:06:40 -0400 Subject: [PATCH 24/41] [tryspaceorg/tryspace-lab#7] Initial tryspace-orchestrator.py with missions and scenarios; --- .gitignore | 2 + Makefile | 37 +++++++-- cfg/Dockerfile.base | 10 ++- cfg/drm/drm.yaml | 8 ++ cfg/drm/scenarios/drm-flight.yaml | 3 + cfg/drm/scenarios/drm-nominal.yaml | 2 + cfg/requirements.txt | 2 + cfg/tryspace-config.yaml | 6 ++ cfg/tryspace-orchestrator.py | 128 +++++++++++++++++++++++++++++ comp/demo | 2 +- 10 files changed, 191 insertions(+), 9 deletions(-) create mode 100644 cfg/drm/drm.yaml create mode 100644 cfg/drm/scenarios/drm-flight.yaml create mode 100644 cfg/drm/scenarios/drm-nominal.yaml create mode 100644 cfg/requirements.txt create mode 100644 cfg/tryspace-config.yaml create mode 100644 cfg/tryspace-orchestrator.py diff --git a/.gitignore b/.gitignore index 3c6fba1..fc2446a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ .vscode build cfg/.env +cfg/active.yaml +cfg/build.yaml \ No newline at end of file diff --git a/Makefile b/Makefile index f25069c..85ba327 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ # Makefile for TrySpace Lab development -.PHONY: all build build-fsw build-gsw build-sim build-cli debug clean container runtime start stop cli +.PHONY: all build build-fsw build-gsw build-sim build-cli cfg clean container debug real-clean runtime start stop cli export BUILD_IMAGE_NAME ?= tryspace-lab @@ -14,6 +14,12 @@ env: echo "GID=$$(id -g)" >> $(CURDIR)/cfg/.env; \ echo "Created $(CURDIR)/cfg/.env"; \ fi + $(MAKE) cfg + +# Configure orchestrator (merges configs and updates active.yaml) using Docker +cfg: + @echo "[Makefile] Running orchestrator to merge configs in Docker..." + docker run --rm -v $(CURDIR):$(CURDIR) -w $(CURDIR)/cfg --user $(shell id -u):$(shell id -g) $(BUILD_IMAGE_NAME) python3 tryspace-orchestrator.py build: env $(MAKE) build-fsw @@ -21,7 +27,11 @@ build: env build-cli: env $(MAKE) container - cd $(CURDIR)/comp/demo/cli && $(MAKE) runtime + @for dir in $(CURDIR)/comp/*/cli ; do \ + if [ -f "$$dir/Makefile" ]; then \ + $(MAKE) -C "$$dir" runtime; \ + fi; \ + done cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server build-fsw: @@ -30,17 +40,25 @@ build-fsw: build-gsw: build-sim: - docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_sim_build" -w $(CURDIR)/simulith --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-sim + docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_sim_build" -w $(CURDIR)/simulith --user $(shell id -u):$(shell id -g) $(BUILD_IMAGE_NAME) make -j build-sim debug: env docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_debug" -w $(CURDIR) --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) /bin/bash clean: $(MAKE) stop + $(MAKE) clean-cli $(MAKE) clean-fsw $(MAKE) clean-gsw $(MAKE) clean-sim +clean-cli: + @for dir in $(CURDIR)/comp/*/cli ; do \ + if [ -f "$$dir/Makefile" ]; then \ + $(MAKE) -C "$$dir" clean; \ + fi; \ + done + clean-fsw: cd fsw && $(MAKE) clean @@ -50,6 +68,10 @@ clean-gsw: clean-sim: cd simulith && $(MAKE) clean +cli: env + $(MAKE) build-cli + docker compose -f ./cfg/cli-compose.yml up + container: docker build -t $(BUILD_IMAGE_NAME) -f cfg/Dockerfile.base --build-arg USER_ID=$(shell id -u) --build-arg GROUP_ID=$(shell id -g) . @@ -59,13 +81,12 @@ runtime: env cd $(CURDIR)/fsw && $(MAKE) runtime cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server +real-clean: clean + docker ps -a --filter "name=tryspace-" -q | xargs -r docker rm -f + start: env docker compose -f ./cfg/lab-compose.yml up -cli: env - $(MAKE) build-cli - docker compose -f ./cfg/cli-compose.yml up - start-fsw: cd fsw && $(MAKE) start @@ -78,3 +99,5 @@ start-sim: stop: docker compose -f ./cfg/cli-compose.yml down docker compose -f ./cfg/lab-compose.yml down + docker images -f "dangling=true" -q | xargs -r docker rmi + diff --git a/cfg/Dockerfile.base b/cfg/Dockerfile.base index a1aecd9..4f21f0e 100644 --- a/cfg/Dockerfile.base +++ b/cfg/Dockerfile.base @@ -1,6 +1,8 @@ # TrySpace FSW Dockerfile # https://github.com/TrySpaceOrg/tryspace-lab -# +# +# Assumes build using `make container` from top level of tryspace-lab repository +# # docker push ghcr.io/tryspaceorg/tryspace-lab:latest # @@ -16,8 +18,14 @@ RUN apt-get update && \ libsocketcan-dev=0.0.12-1 \ libzmq3-dev=4.3.4-6 \ pkg-config=1.8.1-1 \ + python3 \ + python3-pip \ && apt-get clean && rm -rf /var/lib/apt/lists/* +# Install orchestrator requirements for python +COPY cfg/requirements.txt /requirements.txt +RUN pip3 install --break-system-packages --no-cache-dir -r /requirements.txt + # Create user for development (matches host user) ARG USER_ID=1000 ARG GROUP_ID=1000 diff --git a/cfg/drm/drm.yaml b/cfg/drm/drm.yaml new file mode 100644 index 0000000..40540e8 --- /dev/null +++ b/cfg/drm/drm.yaml @@ -0,0 +1,8 @@ +mission_name: "drm" +components: + - name: "demo" +scenarios: + - name: "nominal" + config_file: "drm/scenarios/drm-nominal.yaml" + - name: "flight" + config_file: "drm/scenarios/drm-flight.yaml" diff --git a/cfg/drm/scenarios/drm-flight.yaml b/cfg/drm/scenarios/drm-flight.yaml new file mode 100644 index 0000000..6b7eb17 --- /dev/null +++ b/cfg/drm/scenarios/drm-flight.yaml @@ -0,0 +1,3 @@ +scenario_name: "flight" +overrides: + debug: false diff --git a/cfg/drm/scenarios/drm-nominal.yaml b/cfg/drm/scenarios/drm-nominal.yaml new file mode 100644 index 0000000..bcdd9bb --- /dev/null +++ b/cfg/drm/scenarios/drm-nominal.yaml @@ -0,0 +1,2 @@ +scenario_name: "nominal" +overrides: diff --git a/cfg/requirements.txt b/cfg/requirements.txt new file mode 100644 index 0000000..2cd1ee4 --- /dev/null +++ b/cfg/requirements.txt @@ -0,0 +1,2 @@ +pyyaml +jinja2 diff --git a/cfg/tryspace-config.yaml b/cfg/tryspace-config.yaml new file mode 100644 index 0000000..eea3f2b --- /dev/null +++ b/cfg/tryspace-config.yaml @@ -0,0 +1,6 @@ +build: + missions: + - name: "drm" + config_file: "drm/drm.yaml" + components: + - name: "demo" diff --git a/cfg/tryspace-orchestrator.py b/cfg/tryspace-orchestrator.py new file mode 100644 index 0000000..503b2d1 --- /dev/null +++ b/cfg/tryspace-orchestrator.py @@ -0,0 +1,128 @@ +from jinja2 import Environment, FileSystemLoader +#!/usr/bin/env python3 +""" +Orchestrator for tryspace-lab configuration. +Loads global, mission, and scenario YAMLs, merges them, and writes to active.yaml. +""" +import sys +import os +import yaml + +CFG_DIR = os.path.dirname(os.path.abspath(__file__)) +ACTIVE_PATH = os.path.join(CFG_DIR, "active.yaml") +BUILD_PATH = os.path.join(CFG_DIR, "build.yaml") +GLOBAL_CONFIG = os.path.join(CFG_DIR, "tryspace-config.yaml") + + +def fail(msg): + print(f"[orchestrator] ERROR: {msg}", file=sys.stderr) + sys.exit(1) + + +def load_yaml(path): + if not os.path.exists(path): + return None + with open(path, "r") as f: + return yaml.safe_load(f) + + +def main(): + # If active.yaml does not exist, create with defaults from global config + active = load_yaml(ACTIVE_PATH) + global_cfg = load_yaml(GLOBAL_CONFIG) + if active is None: + # Use first mission and scenario as defaults + missions = global_cfg["build"]["missions"] + if not missions: + fail("No missions defined in global config.") + mission = missions[0]["name"] + mission_cfg_path = os.path.join(CFG_DIR, os.path.relpath(missions[0]["config_file"], CFG_DIR)) + mission_cfg = load_yaml(mission_cfg_path) + scenarios = mission_cfg.get("scenarios", []) + scenario = scenarios[0]["name"] if scenarios else "nominal" + active = {"mission": mission, "scenario": scenario} + with open(ACTIVE_PATH, "w") as f: + yaml.safe_dump(active, f) + print(f"[orchestrator] Created {ACTIVE_PATH} with defaults: mission={mission}, scenario={scenario}") + + mission = active.get("mission") + scenario = active.get("scenario", "nominal") + + # Find mission config file + mission_entry = next((m for m in global_cfg["build"]["missions"] if m["name"] == mission), None) + if not mission_entry: + fail(f"Mission '{mission}' not found in global config.") + mission_cfg_path = os.path.join(CFG_DIR, os.path.relpath(mission_entry["config_file"], CFG_DIR)) + mission_cfg = load_yaml(mission_cfg_path) + + # Find scenario config file + scenario_entry = next((s for s in mission_cfg["scenarios"] if s["name"] == scenario), None) + if not scenario_entry: + fail(f"Scenario '{scenario}' not found in mission config.") + scenario_cfg_path = os.path.join(CFG_DIR, os.path.relpath(scenario_entry["config_file"], CFG_DIR)) + scenario_cfg = load_yaml(scenario_cfg_path) + + # Merge configs (minimal: just collect for now) + merged = { + "mission": mission, + "scenario": scenario, + "global": global_cfg, + "mission_cfg": mission_cfg, + "scenario_cfg": scenario_cfg, + } + + # Write merged config to build.yaml + with open(BUILD_PATH, "w") as f: + yaml.safe_dump(merged, f) + print(f"[orchestrator] Merged config written to {BUILD_PATH}") + + # Render config files for all components defined in the mission config + components = merged["mission_cfg"].get("components", []) + for comp in components: + comp_name = comp.get("name") + if not comp_name: + continue + + # Full cascading merge: fallback -> global -> mission -> scenario -> scenario overrides + # 1. Fallback config + fallback_path = os.path.abspath(os.path.join(CFG_DIR, f'../comp/{comp_name}/support/device_config.yaml')) + fallback_data = load_yaml(fallback_path) + comp_cfg = dict(fallback_data.get(comp_name, {})) if fallback_data and fallback_data.get(comp_name) else {} + + # 2. Global config + global_cfg_comp = merged["global"].get(comp_name, {}) + comp_cfg.update(global_cfg_comp) + + # 3. Mission config + mission_cfg_comp = merged["mission_cfg"].get(comp_name, {}) + comp_cfg.update(mission_cfg_comp) + + # 4. Scenario config + scenario_cfg_comp = merged["scenario_cfg"].get(comp_name, {}) + comp_cfg.update(scenario_cfg_comp) + + # 5. Scenario-level 'overrides' dict + overrides = merged["scenario_cfg"].get("overrides", {}) + comp_cfg.update(overrides) + + # Try to find a template for this component + template_path = os.path.abspath(os.path.join(CFG_DIR, f'../comp/{comp_name}/support')) + template_file = f'device_config.j2' + template_full_path = os.path.join(template_path, template_file) + if os.path.exists(template_full_path) and comp_cfg: + env = Environment(loader=FileSystemLoader(template_path)) + template = env.get_template(template_file) + output = template.render(config=comp_cfg) + + # Output path for the generated config (e.g., comp//shared/_cfg.h) + output_path = os.path.abspath(os.path.join(CFG_DIR, f'../comp/{comp_name}/shared/device_cfg.h')) + os.makedirs(os.path.dirname(output_path), exist_ok=True) + with open(output_path, 'w') as f: + f.write(output) + print(f"[orchestrator] device_cfg.h written to {output_path}") + else: + print(f"[orchestrator] No config or template found for component '{comp_name}', skipping.") + + +if __name__ == "__main__": + main() diff --git a/comp/demo b/comp/demo index bf779c7..be54786 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit bf779c760b5cae90039a73377b4471e4e7c7497e +Subproject commit be547861fe3f5860005a9d668521311f2e5934ba From 86c378361aaf2857a95a79b2b6a55746f2528e5e Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Mon, 4 Aug 2025 19:51:56 -0400 Subject: [PATCH 25/41] [tryspaceorg/tryspace-lab#7] Additional updates to further clean up and cover for a lack of overrides; --- Makefile | 1 + cfg/tryspace-orchestrator.py | 2 ++ 2 files changed, 3 insertions(+) diff --git a/Makefile b/Makefile index 85ba327..a5c5aeb 100644 --- a/Makefile +++ b/Makefile @@ -83,6 +83,7 @@ runtime: env real-clean: clean docker ps -a --filter "name=tryspace-" -q | xargs -r docker rm -f + docker images "tryspace-*" -q | xargs -r docker rmi start: env docker compose -f ./cfg/lab-compose.yml up diff --git a/cfg/tryspace-orchestrator.py b/cfg/tryspace-orchestrator.py index 503b2d1..79497df 100644 --- a/cfg/tryspace-orchestrator.py +++ b/cfg/tryspace-orchestrator.py @@ -103,6 +103,8 @@ def main(): # 5. Scenario-level 'overrides' dict overrides = merged["scenario_cfg"].get("overrides", {}) + if overrides is None: + overrides = {} comp_cfg.update(overrides) # Try to find a template for this component From 14b064d9ef22f06fcd295c3cd09662eec6f2d870 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Mon, 4 Aug 2025 19:55:03 -0400 Subject: [PATCH 26/41] [tryspaceorg/tryspace-lab#7] Submodule updates after merges; --- fsw | 2 +- simulith | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/fsw b/fsw index 8edd6f2..98b3654 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 8edd6f2739771075dda87ecfe8c40679522eb6c0 +Subproject commit 98b3654e1d80d67a97f435abdbacb7734500f46d diff --git a/simulith b/simulith index 098bf1b..413006e 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 098bf1b690cb13923c8f6d87c44d2ac01ee13f4a +Subproject commit 413006eeb13c7ba2d0d10454b89a2bd256be35e5 From 86d4d8a4507f776f6a536bdd48496de1e2418c9d Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Tue, 5 Aug 2025 08:12:11 -0400 Subject: [PATCH 27/41] [tryspaceorg/tryspace#38] Remove previous license.txt; --- LICENSE | 201 -------------------------------------------------------- 1 file changed, 201 deletions(-) delete mode 100644 LICENSE diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. From 89b992fcb0b24d954b7b6da169a436853e582660 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Tue, 5 Aug 2025 08:15:41 -0400 Subject: [PATCH 28/41] [tryspaceorg/tryspace#38] Added AGPLv3 LICENSE.txt; --- LICENSE.txt | 661 ++++++++++++++++++++++++++++++++++++++++++++++++++++ comp/demo | 2 +- simulith | 2 +- 3 files changed, 663 insertions(+), 2 deletions(-) create mode 100644 LICENSE.txt diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..1f84167 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. \ No newline at end of file diff --git a/comp/demo b/comp/demo index be54786..7fce3b1 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit be547861fe3f5860005a9d668521311f2e5934ba +Subproject commit 7fce3b1e68891e2b98015ae92508ca27c51dd377 diff --git a/simulith b/simulith index 413006e..7c45eb7 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 413006eeb13c7ba2d0d10454b89a2bd256be35e5 +Subproject commit 7c45eb77a32b4f03ca3a078515f51cd0f3b0e506 From 69680993de8d2452c66278463a8a0fdf715b9597 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Tue, 5 Aug 2025 08:20:54 -0400 Subject: [PATCH 29/41] [tryspaceorg/tryspace-lab#38] Updated submodules with AGPLv3; --- comp/demo | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/comp/demo b/comp/demo index 7fce3b1..b7cb6b5 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit 7fce3b1e68891e2b98015ae92508ca27c51dd377 +Subproject commit b7cb6b565225138f939ad3b53d337d27f2545faa From 97bbef19abb0dec85d4a4e06490130266512a7a9 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Tue, 5 Aug 2025 10:01:03 -0400 Subject: [PATCH 30/41] [tryspaceorg/tryspace-lab#38] Added GSW submodule; --- .gitmodules | 4 ++++ gsw | 1 + simulith | 2 +- 3 files changed, 6 insertions(+), 1 deletion(-) create mode 160000 gsw diff --git a/.gitmodules b/.gitmodules index c03f2cc..76bfe1c 100644 --- a/.gitmodules +++ b/.gitmodules @@ -10,3 +10,7 @@ path = simulith url = https://github.com/TrySpaceOrg/tryspace-simulith.git branch = main +[submodule "gsw"] + path = gsw + url = https://github.com/TrySpaceOrg/tryspace-ext-yamcs.git + branch = master diff --git a/gsw b/gsw new file mode 160000 index 0000000..0773d97 --- /dev/null +++ b/gsw @@ -0,0 +1 @@ +Subproject commit 0773d97f3ebbc00e2868fe129b52642afc5bad4a diff --git a/simulith b/simulith index 7c45eb7..204ec5f 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 7c45eb77a32b4f03ca3a078515f51cd0f3b0e506 +Subproject commit 204ec5f9e2f5b61ea87879400692390491f2adb0 From 357c726a46da7091b9a71054463735aba504f1e9 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Mon, 11 Aug 2025 09:50:00 -0400 Subject: [PATCH 31/41] [tryspaceorg/tryspace-lab#23] Working with cFS CI/TO_Lab; --- Makefile | 23 +++++++++++++++-------- cfg/Dockerfile.base | 6 +++--- cfg/lab-compose.yml | 22 ++++++++++++++++++++++ fsw | 2 +- gsw | 2 +- 5 files changed, 42 insertions(+), 13 deletions(-) diff --git a/Makefile b/Makefile index a5c5aeb..53e10a2 100644 --- a/Makefile +++ b/Makefile @@ -22,8 +22,9 @@ cfg: docker run --rm -v $(CURDIR):$(CURDIR) -w $(CURDIR)/cfg --user $(shell id -u):$(shell id -g) $(BUILD_IMAGE_NAME) python3 tryspace-orchestrator.py build: env - $(MAKE) build-fsw $(MAKE) build-sim + $(MAKE) build-gsw + $(MAKE) build-fsw build-cli: env $(MAKE) container @@ -38,6 +39,7 @@ build-fsw: docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_build" -w $(CURDIR)/fsw --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-fsw build-gsw: + cd $(CURDIR)/gsw && $(MAKE) runtime build-sim: docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_sim_build" -w $(CURDIR)/simulith --user $(shell id -u):$(shell id -g) $(BUILD_IMAGE_NAME) make -j build-sim @@ -63,7 +65,7 @@ clean-fsw: cd fsw && $(MAKE) clean clean-gsw: - + cd gsw && $(MAKE) clean clean-sim: cd simulith && $(MAKE) clean @@ -75,15 +77,20 @@ cli: env container: docker build -t $(BUILD_IMAGE_NAME) -f cfg/Dockerfile.base --build-arg USER_ID=$(shell id -u) --build-arg GROUP_ID=$(shell id -g) . +real-clean: clean + docker ps -a --filter "name=tryspace-" -q | xargs -r docker rm -f + docker images "tryspace-*" -q | xargs -r docker rmi + docker volume ls -q --filter "name=gsw-data" | xargs -r docker volume rm + docker volume ls -q --filter "name=simulith_ipc" | xargs -r docker volume rm + docker network ls -q --filter "name=tryspace-net" | xargs -r docker network rm + docker network ls -q --filter "name=cfg_tryspace-net" | xargs -r docker network rm + runtime: env $(MAKE) container cd $(CURDIR)/comp/demo/sim && $(MAKE) runtime - cd $(CURDIR)/fsw && $(MAKE) runtime cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server - -real-clean: clean - docker ps -a --filter "name=tryspace-" -q | xargs -r docker rm -f - docker images "tryspace-*" -q | xargs -r docker rmi + cd $(CURDIR)/fsw && $(MAKE) runtime + $(MAKE) build-gsw start: env docker compose -f ./cfg/lab-compose.yml up @@ -92,7 +99,7 @@ start-fsw: cd fsw && $(MAKE) start start-gsw: - + cd gsw && $(MAKE) start start-sim: cd simulith && $(MAKE) start diff --git a/cfg/Dockerfile.base b/cfg/Dockerfile.base index 4f21f0e..9b5a1d3 100644 --- a/cfg/Dockerfile.base +++ b/cfg/Dockerfile.base @@ -1,4 +1,4 @@ -# TrySpace FSW Dockerfile +# TrySpace Base Dockerfile # https://github.com/TrySpaceOrg/tryspace-lab # # Assumes build using `make container` from top level of tryspace-lab repository @@ -18,8 +18,8 @@ RUN apt-get update && \ libsocketcan-dev=0.0.12-1 \ libzmq3-dev=4.3.4-6 \ pkg-config=1.8.1-1 \ - python3 \ - python3-pip \ + python3=3.11.2-1+b1 \ + python3-pip=23.0.1+dfsg-1 \ && apt-get clean && rm -rf /var/lib/apt/lists/* # Install orchestrator requirements for python diff --git a/cfg/lab-compose.yml b/cfg/lab-compose.yml index 8bc66d3..03780ca 100644 --- a/cfg/lab-compose.yml +++ b/cfg/lab-compose.yml @@ -5,6 +5,26 @@ # docker attach tryspace-director # docker attach tryspace-server services: + tryspace-gsw: + image: tryspace-gsw:latest + container_name: tryspace-gsw + networks: + - tryspace-net + restart: unless-stopped + attach: false + ports: + - "8090:8090" # YAMCS Web Interface + volumes: + - gsw-data:/app/yamcs-data + healthcheck: + test: ["CMD", "curl", "-f", "http://localhost:8090"] + interval: 30s + timeout: 5s + retries: 10 + start_period: 60s + cpus: "2.0" + mem_limit: 1g + tryspace-server: image: tryspace-server:latest container_name: tryspace-server @@ -78,3 +98,5 @@ networks: volumes: simulith_ipc: driver: local + gsw-data: + driver: local diff --git a/fsw b/fsw index 98b3654..6e00d7a 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 98b3654e1d80d67a97f435abdbacb7734500f46d +Subproject commit 6e00d7aca1147b2989320447036f01496fa7d20c diff --git a/gsw b/gsw index 0773d97..643173f 160000 --- a/gsw +++ b/gsw @@ -1 +1 @@ -Subproject commit 0773d97f3ebbc00e2868fe129b52642afc5bad4a +Subproject commit 643173f11afc1e4a216c977c09d0a450bc068975 From d31446cec04aa1f55a6389c97a6005a903e14a45 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Mon, 11 Aug 2025 10:00:29 -0400 Subject: [PATCH 32/41] [tryspaceorg/tryspace-lab#23] Updates to submodules after PR review; --- fsw | 2 +- gsw | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/fsw b/fsw index 6e00d7a..30eadf2 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 6e00d7aca1147b2989320447036f01496fa7d20c +Subproject commit 30eadf27609b6de8a0af52dc4aad7f17c97706ca diff --git a/gsw b/gsw index 643173f..b1edc4e 160000 --- a/gsw +++ b/gsw @@ -1 +1 @@ -Subproject commit 643173f11afc1e4a216c977c09d0a450bc068975 +Subproject commit b1edc4edb87171ecb27fa45b01e215e891dfde11 From 5807d2f58535ef376f476be4446df58cc4e0825f Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Mon, 11 Aug 2025 10:12:54 -0400 Subject: [PATCH 33/41] [tryspaceorg/tryspace-lab#15] Initial attempt at templates; --- .github/ISSUE_TEMPLATE/1-BUG_REPORT.yml | 39 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/2-FEATURE_REQUEST.yml | 19 ++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/pull_request_template.md | 15 ++++++++ 4 files changed, 74 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-BUG_REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/2-FEATURE_REQUEST.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/1-BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/1-BUG_REPORT.yml new file mode 100644 index 0000000..4eea123 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-BUG_REPORT.yml @@ -0,0 +1,39 @@ +name: "Bug Report" +description: Create a new ticket for a bug. +labels: ["Bug"] +body: + - type: textarea + id: description + attributes: + label: "Description" + value: | + Define the problem. + + Capture the setup: + * Which branch and git hash used + * Any changes in configuration + + Steps to recreate: + * ... + + Add logs or screenshots as desired. + validations: + required: true + - type: dropdown + id: os + attributes: + label: "OS" + description: What is the impacted environment? + multiple: true + options: + - Windows (Direct Clone) + - Windows (Shared Folders) + - Linux (Direct Clone) + - Linux (Shared Folders) + - Mac (Direct Clone) + - Mac (Shared Folders) + validations: + required: false + - type: markdown + attributes: + value: "Optional: Please apply any labels or types as necessary - leave blank for unknown." diff --git a/.github/ISSUE_TEMPLATE/2-FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/2-FEATURE_REQUEST.yml new file mode 100644 index 0000000..a85689f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-FEATURE_REQUEST.yml @@ -0,0 +1,19 @@ +name: "Feature Request" +description: Create a new ticket for a new request +labels: ["NewIssue"] +body: + - type: markdown + attributes: + value: "Please add a short descriptive title to feature request." + - type: textarea + id: description + attributes: + label: "Description" + value: | + Provide details related to the new feature. + render: bash + validations: + required: true + - type: markdown + attributes: + value: "Optional: Please apply any labels or types as necessary - leave blank for unknown." diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ac2e8b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..b1a25cc --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +## Summary of PR goals + +Provide a brief description of the purpose of this pull request. + +## How to test? + +Provide instructions for testing this pull request. + +## Submodule PRs and actions prior to closing this + +List any submodule pull requests or actions that need to be completed before closing this pull request. + +## Closes + +Reference the issue(s) this pull request closes, e.g., Closes #123. From 214e4fc93e8f34d6dc0651afcdb286563b85f6ad Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Mon, 11 Aug 2025 10:35:20 -0400 Subject: [PATCH 34/41] [tryspaceorg/tryspace-lab#13] Created CONTRIBUTING.md; --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ README.md | 17 +++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aef9051 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing to TrySpace Lab + +Thank you for considering contributing to TrySpace Lab! +We welcome contributions from everyone. +To ensure a smooth collaboration, please follow these guidelines: + +## How to Contribute + +1. **Fork the Repository**: Start by forking the repository to your GitHub account. +2. **Create a Branch**: Create a new branch for your feature or bug fix. Use a descriptive name, such as `feature/add-new-tool` or `bugfix/fix-typo`. +3. **Make Changes**: Implement your changes in the new branch. Ensure your code follows the project's coding standards. +4. **Test Your Changes**: Run tests to verify that your changes work as expected and do not break existing functionality. +5. **Submit a Pull Request**: Open a pull request (PR) to the `dev` branch of this repository. Provide a clear description of your changes and reference any related issues. + +## Licensing + +By contributing to this repository, you agree that your contributions will be licensed under the [GNU Affero General Public License v3 (AGPLv3)](https://www.gnu.org/licenses/agpl-3.0.html) or any other license explicitly noted in the repository. +Please ensure you are comfortable with this licensing before submitting your contributions. + +## Questions or Feedback + +If you have any questions or need further clarification, feel free to open a [GitHub Discussion](https://github.com/TrySpaceOrg/tryspace-lab/discussions) or contact the maintainers directly. + +Thank you for your contributions and support! diff --git a/README.md b/README.md index 93a2bc5..0d102fc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # TrySpace Lab + Entrypoint for orchestrating full TrySpace simulation environments. + +## Community Support + +If you have questions, ideas, or need help, feel free to start a [GitHub Discussion](https://github.com/TrySpaceOrg/tryspace-lab/discussions). +Discussions are a great place to engage with the community and maintainers. + +For bug reports or feature requests, please open a [GitHub Issue](https://github.com/TrySpaceOrg/tryspace-lab/issues). + +## Contributing + +We welcome contributions from everyone. Please review our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started. + +## Licensing + +This project is licensed under the [GNU Affero General Public License v3 (AGPLv3)](https://www.gnu.org/licenses/agpl-3.0.html). +By contributing, you agree that your contributions will also be licensed under the AGPLv3 or any other license explicitly noted in the repository. From acf8bf2bdf712fcb9d3bd1612e24effba2c04e2f Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Mon, 11 Aug 2025 12:21:39 -0400 Subject: [PATCH 35/41] [tryspaceorg/tryspace-lab#12] Added atlas with documentation; --- .gitmodules | 4 ++++ README.md | 4 ++++ atlas | 1 + 3 files changed, 9 insertions(+) create mode 160000 atlas diff --git a/.gitmodules b/.gitmodules index 76bfe1c..7d90257 100644 --- a/.gitmodules +++ b/.gitmodules @@ -14,3 +14,7 @@ path = gsw url = https://github.com/TrySpaceOrg/tryspace-ext-yamcs.git branch = master +[submodule "atlas"] + path = atlas + url = https://github.com/TrySpaceOrg/TrySpaceOrg.github.io.git + branch = main diff --git a/README.md b/README.md index 0d102fc..f81792d 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ Discussions are a great place to engage with the community and maintainers. For bug reports or feature requests, please open a [GitHub Issue](https://github.com/TrySpaceOrg/tryspace-lab/issues). +## Documentation + +The full documentation for TrySpace Lab is available at [TrySpace Atlas](https://tryspaceorg.github.io/). + ## Contributing We welcome contributions from everyone. Please review our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started. diff --git a/atlas b/atlas new file mode 160000 index 0000000..42a1453 --- /dev/null +++ b/atlas @@ -0,0 +1 @@ +Subproject commit 42a1453e3bb5405d1f88a9db318331981507249a From c2c5d00dc274b298a78fea7d4cb3bb8c649dd673 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Wed, 13 Aug 2025 08:43:52 -0400 Subject: [PATCH 36/41] [tryspaceorg/tryspace-lab#40] Moved simulith calls to PSP; --- Makefile | 19 ++++++++++++++----- fsw | 2 +- simulith | 2 +- 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/Makefile b/Makefile index 53e10a2..3595132 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ # Makefile for TrySpace Lab development -.PHONY: all build build-fsw build-gsw build-sim build-cli cfg clean container debug real-clean runtime start stop cli +.PHONY: all build build-fsw build-gsw build-sim build-cli cfg cli clean container debug fsw gsw real-clean runtime sim start stop export BUILD_IMAGE_NAME ?= tryspace-lab @@ -77,6 +77,16 @@ cli: env container: docker build -t $(BUILD_IMAGE_NAME) -f cfg/Dockerfile.base --build-arg USER_ID=$(shell id -u) --build-arg GROUP_ID=$(shell id -g) . +fsw: env + cd $(CURDIR)/fsw && $(MAKE) runtime + +gsw: env + $(MAKE) build-gsw + +sim: env + cd $(CURDIR)/comp/demo/sim && $(MAKE) runtime + cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server + real-clean: clean docker ps -a --filter "name=tryspace-" -q | xargs -r docker rm -f docker images "tryspace-*" -q | xargs -r docker rmi @@ -87,10 +97,9 @@ real-clean: clean runtime: env $(MAKE) container - cd $(CURDIR)/comp/demo/sim && $(MAKE) runtime - cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server - cd $(CURDIR)/fsw && $(MAKE) runtime - $(MAKE) build-gsw + $(MAKE) sim + $(MAKE) fsw + $(MAKE) gsw start: env docker compose -f ./cfg/lab-compose.yml up diff --git a/fsw b/fsw index 30eadf2..dfe47dd 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 30eadf27609b6de8a0af52dc4aad7f17c97706ca +Subproject commit dfe47dd0cbfc53423bf9b0ca338807838e83ba6a diff --git a/simulith b/simulith index 204ec5f..8771d8a 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 204ec5f9e2f5b61ea87879400692390491f2adb0 +Subproject commit 8771d8a5f5f7a61199f9d8f94f7be7814b16e915 From 20d9f782e7677168bc86128d00be78789d90e9e5 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Wed, 13 Aug 2025 12:40:24 -0400 Subject: [PATCH 37/41] [tryspaceorg/tryspace-lab#40] Functional now with SCH; --- fsw | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fsw b/fsw index dfe47dd..38b210f 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit dfe47dd0cbfc53423bf9b0ca338807838e83ba6a +Subproject commit 38b210fe9e4dc5ad44ce4e281eb09c12395d6e10 From a653173052cd134c5339c4a54e2aba912a6847b2 Mon Sep 17 00:00:00 2001 From: "Lucas, John P." Date: Wed, 13 Aug 2025 13:30:39 -0400 Subject: [PATCH 38/41] [tryspaceorg/tryspace-lab#40] Updates after PR reviews and merges; --- fsw | 2 +- simulith | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/fsw b/fsw index 38b210f..c7ba41f 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 38b210fe9e4dc5ad44ce4e281eb09c12395d6e10 +Subproject commit c7ba41f1e5d676c6658580f9f6fb4d11a8c886a0 diff --git a/simulith b/simulith index 8771d8a..0ed4901 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 8771d8a5f5f7a61199f9d8f94f7be7814b16e915 +Subproject commit 0ed490157ea09a8086a4ebdb239ad26f3fd00390 From 42c73eeb10d211a7417382e3c5b70befdeb70880 Mon Sep 17 00:00:00 2001 From: "John P. Lucas" Date: Thu, 14 Aug 2025 13:12:08 -0400 Subject: [PATCH 39/41] [#14] CI (#45) * [tryspaceorg/tryspace-lab#14] Cleanup of Dockerfile.base and Makefile, initial CI.yml; * [tryspaceorg/tryspace-lab#14] Updates to use public container and cleanup make/cmake; * [tryspaceorg/tryspace-lab#14] Use public container in ci.yml; * [tryspaceorg/tryspace-lab#14] Attempt to build component sims and added orchestrator step to FSW CI; * [tryspaceorg/tryspace-lab#14] Updated ci.yml formatting; * [tryspaceorg/tryspace-lab#14] Added cfg step to build-simulith; * [tryspaceorg/tryspace-lab#14] Updates after submodule merges; --- .github/workflows/ci.yml | 48 ++++++++++++ Makefile | 162 +++++++++++++++++++++------------------ cfg/Dockerfile.base | 23 +++--- comp/demo | 2 +- fsw | 2 +- gsw | 2 +- simulith | 2 +- 7 files changed, 152 insertions(+), 89 deletions(-) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..2f80404 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,48 @@ +name: CI + +on: + pull_request: + branches: + - '**' + +jobs: + build-simulith: + runs-on: ubuntu-latest + container: + image: tryspaceorg/tryspace-lab + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + submodules: recursive + fetch-depth: 1 + - name: Build Simulith + run: | + cd cfg + python3 tryspace-orchestrator.py + cd .. + for dir in $(pwd)/comp/*/sim ; do + if [ -d "$dir" ] && [ -f "$dir/Makefile" ]; then + echo "Building component in $dir" + make -C "$dir" build-sim + fi + done + cd simulith + make build-sim + + build-fsw: + runs-on: ubuntu-latest + container: + image: tryspaceorg/tryspace-lab + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + submodules: recursive + fetch-depth: 1 + - name: Build FSW + run: | + cd cfg + python3 tryspace-orchestrator.py + cd ../fsw + make build-fsw diff --git a/Makefile b/Makefile index 3595132..4a98e66 100644 --- a/Makefile +++ b/Makefile @@ -1,58 +1,33 @@ # Makefile for TrySpace Lab development -.PHONY: all build build-fsw build-gsw build-sim build-cli cfg cli clean container debug fsw gsw real-clean runtime sim start stop +.PHONY: build clean clean-cli clean-fsw clean-gsw clean-sim cfg cli container debug env fsw gsw help sim start stop uninstall -export BUILD_IMAGE_NAME ?= tryspace-lab +# Build image name +export BUILD_IMAGE ?= tryspaceorg/tryspace-lab -# Commands -all: runtime - -env: - @if [ ! -f $(CURDIR)/cfg/.env ]; then \ - echo "Creating $(CURDIR)/cfg/.env with current user UID/GID..."; \ - mkdir -p $(CURDIR)/cfg; \ - echo "UID=$$(id -u)" > $(CURDIR)/cfg/.env; \ - echo "GID=$$(id -g)" >> $(CURDIR)/cfg/.env; \ - echo "Created $(CURDIR)/cfg/.env"; \ - fi - $(MAKE) cfg - -# Configure orchestrator (merges configs and updates active.yaml) using Docker -cfg: - @echo "[Makefile] Running orchestrator to merge configs in Docker..." - docker run --rm -v $(CURDIR):$(CURDIR) -w $(CURDIR)/cfg --user $(shell id -u):$(shell id -g) $(BUILD_IMAGE_NAME) python3 tryspace-orchestrator.py +# Common paths +CFG_DIR := $(CURDIR)/cfg +ENV_FILE := $(CFG_DIR)/.env +# Commands build: env - $(MAKE) build-sim - $(MAKE) build-gsw - $(MAKE) build-fsw - -build-cli: env - $(MAKE) container - @for dir in $(CURDIR)/comp/*/cli ; do \ - if [ -f "$$dir/Makefile" ]; then \ - $(MAKE) -C "$$dir" runtime; \ - fi; \ - done - cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server - -build-fsw: - docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_build" -w $(CURDIR)/fsw --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) make -j build-fsw - -build-gsw: - cd $(CURDIR)/gsw && $(MAKE) runtime - -build-sim: - docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_sim_build" -w $(CURDIR)/simulith --user $(shell id -u):$(shell id -g) $(BUILD_IMAGE_NAME) make -j build-sim + $(MAKE) sim + $(MAKE) fsw + $(MAKE) gsw -debug: env - docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_debug" -w $(CURDIR) --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE_NAME) /bin/bash +cfg: container + docker run --rm -v $(CURDIR):$(CURDIR) -w $(CURDIR)/cfg --user $(shell id -u):$(shell id -g) $(BUILD_IMAGE) python3 tryspace-orchestrator.py clean: $(MAKE) stop - $(MAKE) clean-cli - $(MAKE) clean-fsw - $(MAKE) clean-gsw - $(MAKE) clean-sim + @if docker image inspect $(BUILD_IMAGE):latest >/dev/null 2>&1; then \ + $(MAKE) clean-cli; \ + $(MAKE) clean-fsw; \ + $(MAKE) clean-gsw; \ + $(MAKE) clean-sim; \ + else \ + echo "Docker image $(BUILD_IMAGE) does not exist. Skipping clean subcommands."; \ + fi + rm -f $(ENV_FILE) $(CFG_DIR)/active.yaml $(CFG_DIR)/build.yaml clean-cli: @for dir in $(CURDIR)/comp/*/cli ; do \ @@ -68,53 +43,92 @@ clean-gsw: cd gsw && $(MAKE) clean clean-sim: + @for dir in $(CURDIR)/comp/* ; do \ + if [ -d "$$dir" ] && [ -f "$$dir/Makefile" ]; then \ + $(MAKE) -C "$$dir" clean; \ + fi; \ + done cd simulith && $(MAKE) clean cli: env - $(MAKE) build-cli + $(MAKE) container + @for dir in $(CURDIR)/comp/*/cli ; do \ + if [ -f "$$dir/Makefile" ]; then \ + $(MAKE) -C "$$dir" runtime; \ + fi; \ + done + cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server docker compose -f ./cfg/cli-compose.yml up -container: - docker build -t $(BUILD_IMAGE_NAME) -f cfg/Dockerfile.base --build-arg USER_ID=$(shell id -u) --build-arg GROUP_ID=$(shell id -g) . +container: cfg/Dockerfile.base + docker build -t $(BUILD_IMAGE) -f cfg/Dockerfile.base --build-arg USER_ID=$(shell id -u) --build-arg GROUP_ID=$(shell id -g) . + +debug: env + docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_debug" -w $(CURDIR) --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE) /bin/bash + +env: + @command -v docker >/dev/null 2>&1 || { echo "Error: docker is not installed or not in PATH."; exit 1; } + @if [ ! -f $(ENV_FILE) ]; then \ + echo "Creating $(ENV_FILE) with current user UID/GID..."; \ + mkdir -p $(CFG_DIR); \ + echo "UID=$$(id -u)" > $(ENV_FILE); \ + echo "GID=$$(id -g)" >> $(ENV_FILE); \ + echo "Created $(ENV_FILE)"; \ + fi + $(MAKE) cfg fsw: env cd $(CURDIR)/fsw && $(MAKE) runtime gsw: env - $(MAKE) build-gsw + cd $(CURDIR)/gsw && $(MAKE) runtime + +help: + @echo "Usage: make " + @echo "Targets:" + @echo " build - Build the full runtime environment" + @echo " cfg - Run orchestrator to configure environment" + @echo " cli - Build CLI and start CLI services" + @echo " clean - Remove build artifacts and stop services" + @echo " clean-cli - Clean CLI components" + @echo " clean-fsw - Clean FSW components" + @echo " clean-gsw - Clean GSW components" + @echo " clean-sim - Clean simulation components" + @echo " container - Build the Docker container" + @echo " debug - Start a debug shell in the container" + @echo " env - Create .env file and check required tools" + @echo " fsw - Build FSW" + @echo " gsw - Build GSW" + @echo " sim - Build Simulith and component simulators" + @echo " start - Start lab services" + @echo " stop - Stop lab and CLI services, clean up Docker images" + @echo " uninstall - Remove containers, images, volumes, and networks" sim: env - cd $(CURDIR)/comp/demo/sim && $(MAKE) runtime + @for dir in $(CURDIR)/comp/*/sim ; do \ + if [ -d "$$dir" ] && [ -f "$$dir/Makefile" ]; then \ + echo "Building component in $$dir"; \ + $(MAKE) -C "$$dir" runtime; \ + fi; \ + done cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server -real-clean: clean - docker ps -a --filter "name=tryspace-" -q | xargs -r docker rm -f - docker images "tryspace-*" -q | xargs -r docker rmi - docker volume ls -q --filter "name=gsw-data" | xargs -r docker volume rm - docker volume ls -q --filter "name=simulith_ipc" | xargs -r docker volume rm - docker network ls -q --filter "name=tryspace-net" | xargs -r docker network rm - docker network ls -q --filter "name=cfg_tryspace-net" | xargs -r docker network rm - -runtime: env - $(MAKE) container - $(MAKE) sim - $(MAKE) fsw - $(MAKE) gsw - start: env docker compose -f ./cfg/lab-compose.yml up -start-fsw: - cd fsw && $(MAKE) start - -start-gsw: - cd gsw && $(MAKE) start - -start-sim: - cd simulith && $(MAKE) start - stop: docker compose -f ./cfg/cli-compose.yml down docker compose -f ./cfg/lab-compose.yml down docker images -f "dangling=true" -q | xargs -r docker rmi +uninstall: clean + docker ps -a --filter "name=tryspace-" -q | xargs -r docker rm -f + docker images "tryspace-*" -q | xargs -r docker rmi + docker volume ls -q --filter "name=gsw-data" | xargs -r docker volume rm + docker volume ls -q --filter "name=simulith_ipc" | xargs -r docker volume rm + docker network ls -q --filter "name=tryspace-net" | xargs -r docker network rm + docker network ls -q --filter "name=cfg_tryspace-net" | xargs -r docker network rm + @echo "" + @echo "To remove everything docker run: " + @echo " docker system prune -a" + @echo "" diff --git a/cfg/Dockerfile.base b/cfg/Dockerfile.base index 9b5a1d3..98a8142 100644 --- a/cfg/Dockerfile.base +++ b/cfg/Dockerfile.base @@ -2,29 +2,30 @@ # https://github.com/TrySpaceOrg/tryspace-lab # # Assumes build using `make container` from top level of tryspace-lab repository -# -# docker push ghcr.io/tryspaceorg/tryspace-lab:latest +# +# docker push tryspaceorg/tryspace-lab: # FROM debian:bookworm-slim@sha256:6ac2c08566499cc2415926653cf2ed7c3aedac445675a013cc09469c9e118fdd +ENV DEBIAN_FRONTEND=noninteractive LABEL maintainer="TrySpaceOrg" description="Base image for TrySpace Lab" # Install required tools RUN apt-get update && \ apt-get install -y --no-install-recommends \ - build-essential=12.9 \ - cmake=3.25.1-1 \ - git=1:2.39.5-0+deb12u2 \ - libsocketcan-dev=0.0.12-1 \ - libzmq3-dev=4.3.4-6 \ - pkg-config=1.8.1-1 \ - python3=3.11.2-1+b1 \ - python3-pip=23.0.1+dfsg-1 \ + build-essential \ + cmake \ + git \ + libsocketcan-dev \ + libzmq3-dev \ + pkg-config \ + python3 \ + python3-pip \ && apt-get clean && rm -rf /var/lib/apt/lists/* # Install orchestrator requirements for python COPY cfg/requirements.txt /requirements.txt -RUN pip3 install --break-system-packages --no-cache-dir -r /requirements.txt +RUN pip3 install --break-system-packages --no-cache-dir --upgrade -r /requirements.txt && pip cache purge # Create user for development (matches host user) ARG USER_ID=1000 diff --git a/comp/demo b/comp/demo index b7cb6b5..bd81a9b 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit b7cb6b565225138f939ad3b53d337d27f2545faa +Subproject commit bd81a9bc096217eb5e0dab46d60be2d460690720 diff --git a/fsw b/fsw index c7ba41f..8e08c2c 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit c7ba41f1e5d676c6658580f9f6fb4d11a8c886a0 +Subproject commit 8e08c2c677530a8068812b40a74364a388215db9 diff --git a/gsw b/gsw index b1edc4e..361dda0 160000 --- a/gsw +++ b/gsw @@ -1 +1 @@ -Subproject commit b1edc4edb87171ecb27fa45b01e215e891dfde11 +Subproject commit 361dda0cf45cf402a5230f81f0cf39fbf76d373c diff --git a/simulith b/simulith index 0ed4901..15b5dd9 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 0ed490157ea09a8086a4ebdb239ad26f3fd00390 +Subproject commit 15b5dd911bd24bd55c003b9ffa567c17d0040564 From eda3ccc78eb708c14da8ca799c22a21b385c48c5 Mon Sep 17 00:00:00 2001 From: "John P. Lucas" Date: Thu, 14 Aug 2025 16:24:21 -0400 Subject: [PATCH 40/41] [#21] Updates for FSW unit tests; (#46) * [tryspaceorg/tryspace-lab#21] Updates for FSW unit tests; * [tryspaceorg/tryspace-lab#21] Added print on error to ci.yml for unit tests; * [tryspaceorg/tryspace-lab#21] Ignored failing OSAL tests for now - revisit these! * [tryspaceorg/tryspace-lab#21] Ignored additional OSAL tests due to CI failures, added PR template for release; * [tryspaceorg/tryspace-lab#21] Added curl and gpg to base container for codecov; * [tryspaceorg/tryspace-lab#21] Submodule updates after merges --- .../issue.md} | 0 .github/PULL_REQUEST_TEMPLATE/release.md | 32 +++++++++++++++++++ .github/workflows/ci.yml | 25 +++++++++++++++ cfg/Dockerfile.base | 6 +++- comp/demo | 2 +- fsw | 2 +- 6 files changed, 64 insertions(+), 3 deletions(-) rename .github/{pull_request_template.md => PULL_REQUEST_TEMPLATE/issue.md} (100%) create mode 100644 .github/PULL_REQUEST_TEMPLATE/release.md diff --git a/.github/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/issue.md similarity index 100% rename from .github/pull_request_template.md rename to .github/PULL_REQUEST_TEMPLATE/issue.md diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md new file mode 100644 index 0000000..5d0a99d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -0,0 +1,32 @@ +# Release 0.0.0 + +## Code and Feature Readiness + +Provide a brief description of the purpose of this release. + +- [ ] **Feature complete**: Verified that all planned features for this release are fully implemented and tested. +- [ ] **CI passes**: Continuous Integration (CI) pipeline is green, with all tests passing and no linting errors. + +## Container and Image Management + +- [ ] **Containers updated**: Update container versions to latest packages available. +- [ ] **Containers versioned**: The container images are date tagged and pushed. +- [ ] **Container CI updates**: CI updated to use latest containers +- [ ] **Verify image functionality**: Manually verified containers to ensure they work as expected. + +## Documentation and Communication + +- [ ] **Update README**: Reviewed and updated the `README.md` file. +- [ ] **Review other documentation**: Reviewed atlas and other relevant docs. +- [ ] **Version updates**: Versions updated across submodules. + +## Works for Me + +- [ ] **Old Laptop**: Runs on the old laptop +- [ ] **Virtual Machine**: Runs within a standard Ubuntu VM +- [ ] **Windows Subsystem for Linux**: Runs on WSL + +## Post-Release + +- [ ] **Create GitHub release**: A new release will be created from the `main` branch with the new version tag. +- [ ] **Announce the release**: The release will be announced on all relevant platforms. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2f80404..009da73 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,6 +5,9 @@ on: branches: - '**' +env: + CTEST_OUTPUT_ON_FAILURE: true + jobs: build-simulith: runs-on: ubuntu-latest @@ -46,3 +49,25 @@ jobs: python3 tryspace-orchestrator.py cd ../fsw make build-fsw + + build-test: + runs-on: ubuntu-latest + container: + image: tryspaceorg/tryspace-lab + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + submodules: recursive + fetch-depth: 1 + - name: Build Tests + run: | + cd cfg + python3 tryspace-orchestrator.py + cd ../fsw + make build-test + - name: Upload to Codecov + uses: codecov/codecov-action@v5 + with: + verbose: true + recurse_submodules: true diff --git a/cfg/Dockerfile.base b/cfg/Dockerfile.base index 98a8142..df651e0 100644 --- a/cfg/Dockerfile.base +++ b/cfg/Dockerfile.base @@ -15,7 +15,11 @@ RUN apt-get update && \ apt-get install -y --no-install-recommends \ build-essential \ cmake \ + curl \ + gcovr \ git \ + gpg \ + lcov \ libsocketcan-dev \ libzmq3-dev \ pkg-config \ @@ -25,7 +29,7 @@ RUN apt-get update && \ # Install orchestrator requirements for python COPY cfg/requirements.txt /requirements.txt -RUN pip3 install --break-system-packages --no-cache-dir --upgrade -r /requirements.txt && pip cache purge +RUN pip3 install --break-system-packages --no-cache-dir --upgrade -r /requirements.txt # Create user for development (matches host user) ARG USER_ID=1000 diff --git a/comp/demo b/comp/demo index bd81a9b..a638bc3 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit bd81a9bc096217eb5e0dab46d60be2d460690720 +Subproject commit a638bc38baf5ce845c77397d73b6895c22bd020a diff --git a/fsw b/fsw index 8e08c2c..690acec 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 8e08c2c677530a8068812b40a74364a388215db9 +Subproject commit 690acecdb2b8ac9a3a075d566d766c3fcff81d31 From ea80d4a2c5aaf4fdddf4a36c9a0d46b5612db6b2 Mon Sep 17 00:00:00 2001 From: "John P. Lucas" Date: Mon, 18 Aug 2025 08:48:53 -0400 Subject: [PATCH 41/41] [#47] Release 0.0.0 to `dev` (#49) * [tryspaceorg/tryspace-lab#47] User guide updates after review; * [tryspaceorg/tryspace-lab#47] Change to versioned container; * [tryspaceorg/tryspace-lab#47] Limited number of parallel jobs and removed env; * [tryspaceorg/tryspace-lab#47] PR suggestions and removed compose restart; * [tryspaceorg/tryspace-lab#47] Submodule merges; * [tryspaceorg/tryspace-lab#47] Update to PR release template; --- .github/PULL_REQUEST_TEMPLATE/release.md | 12 +++--- .github/workflows/ci.yml | 6 +-- .gitignore | 1 - Makefile | 40 ++++++++------------ README.md | 48 +++++++++++++++++++----- atlas | 2 +- cfg/Dockerfile.base | 2 +- cfg/cli-compose.yml | 5 --- cfg/lab-compose.yml | 8 ---- cfg/tryspace-orchestrator.py | 2 +- comp/demo | 2 +- fsw | 2 +- gsw | 2 +- simulith | 2 +- 14 files changed, 68 insertions(+), 66 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md index 5d0a99d..8edda3a 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -1,5 +1,3 @@ -# Release 0.0.0 - ## Code and Feature Readiness Provide a brief description of the purpose of this release. @@ -10,7 +8,7 @@ Provide a brief description of the purpose of this release. ## Container and Image Management - [ ] **Containers updated**: Update container versions to latest packages available. -- [ ] **Containers versioned**: The container images are date tagged and pushed. +- [ ] **Containers versioned**: The container images are tagged and pushed. - [ ] **Container CI updates**: CI updated to use latest containers - [ ] **Verify image functionality**: Manually verified containers to ensure they work as expected. @@ -22,11 +20,11 @@ Provide a brief description of the purpose of this release. ## Works for Me -- [ ] **Old Laptop**: Runs on the old laptop -- [ ] **Virtual Machine**: Runs within a standard Ubuntu VM +- [ ] **Raspberry Pi 3 Model B**: Runs on an old 64-bit RPi +- [ ] **Virtual Machine**: Runs within a standard Ubuntu VM (4 core, 8GB) - [ ] **Windows Subsystem for Linux**: Runs on WSL -## Post-Release - +## Release +- [ ] **Merge branches**: all features into `dev`, then `dev` into `main` - [ ] **Create GitHub release**: A new release will be created from the `main` branch with the new version tag. - [ ] **Announce the release**: The release will be announced on all relevant platforms. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 009da73..c3a3441 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,7 +12,7 @@ jobs: build-simulith: runs-on: ubuntu-latest container: - image: tryspaceorg/tryspace-lab + image: tryspaceorg/tryspace-lab:0.0.0 steps: - name: Checkout repository uses: actions/checkout@v4 @@ -36,7 +36,7 @@ jobs: build-fsw: runs-on: ubuntu-latest container: - image: tryspaceorg/tryspace-lab + image: tryspaceorg/tryspace-lab:0.0.0 steps: - name: Checkout repository uses: actions/checkout@v4 @@ -53,7 +53,7 @@ jobs: build-test: runs-on: ubuntu-latest container: - image: tryspaceorg/tryspace-lab + image: tryspaceorg/tryspace-lab:0.0.0 steps: - name: Checkout repository uses: actions/checkout@v4 diff --git a/.gitignore b/.gitignore index fc2446a..e8d0fb6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ .vscode build -cfg/.env cfg/active.yaml cfg/build.yaml \ No newline at end of file diff --git a/Makefile b/Makefile index 4a98e66..fb6a367 100644 --- a/Makefile +++ b/Makefile @@ -1,15 +1,14 @@ # Makefile for TrySpace Lab development -.PHONY: build clean clean-cli clean-fsw clean-gsw clean-sim cfg cli container debug env fsw gsw help sim start stop uninstall +.PHONY: build clean clean-cli clean-fsw clean-gsw clean-sim cfg cli container debug fsw gsw help sim start stop uninstall # Build image name -export BUILD_IMAGE ?= tryspaceorg/tryspace-lab +export BUILD_IMAGE ?= tryspaceorg/tryspace-lab:0.0.0 # Common paths CFG_DIR := $(CURDIR)/cfg -ENV_FILE := $(CFG_DIR)/.env # Commands -build: env +build: cfg $(MAKE) sim $(MAKE) fsw $(MAKE) gsw @@ -24,10 +23,12 @@ clean: $(MAKE) clean-fsw; \ $(MAKE) clean-gsw; \ $(MAKE) clean-sim; \ + docker volume ls -q --filter "name=gsw-data" | xargs -r docker volume rm \ + docker volume ls -q --filter "name=simulith_ipc" | xargs -r docker volume rm \ else \ echo "Docker image $(BUILD_IMAGE) does not exist. Skipping clean subcommands."; \ fi - rm -f $(ENV_FILE) $(CFG_DIR)/active.yaml $(CFG_DIR)/build.yaml + rm -f $(CFG_DIR)/active.yaml $(CFG_DIR)/build.yaml clean-cli: @for dir in $(CURDIR)/comp/*/cli ; do \ @@ -50,7 +51,7 @@ clean-sim: done cd simulith && $(MAKE) clean -cli: env +cli: cfg $(MAKE) container @for dir in $(CURDIR)/comp/*/cli ; do \ if [ -f "$$dir/Makefile" ]; then \ @@ -61,26 +62,16 @@ cli: env docker compose -f ./cfg/cli-compose.yml up container: cfg/Dockerfile.base + @command -v docker >/dev/null 2>&1 || { echo "Error: docker is not installed or not in PATH."; exit 1; } docker build -t $(BUILD_IMAGE) -f cfg/Dockerfile.base --build-arg USER_ID=$(shell id -u) --build-arg GROUP_ID=$(shell id -g) . -debug: env +debug: cfg docker run --rm -it -v $(CURDIR):$(CURDIR) --name "tryspace_fsw_debug" -w $(CURDIR) --user $(shell id -u):$(shell id -g) --sysctl fs.mqueue.msg_max=10000 --ulimit rtprio=99 --cap-add=sys_nice $(BUILD_IMAGE) /bin/bash - -env: - @command -v docker >/dev/null 2>&1 || { echo "Error: docker is not installed or not in PATH."; exit 1; } - @if [ ! -f $(ENV_FILE) ]; then \ - echo "Creating $(ENV_FILE) with current user UID/GID..."; \ - mkdir -p $(CFG_DIR); \ - echo "UID=$$(id -u)" > $(ENV_FILE); \ - echo "GID=$$(id -g)" >> $(ENV_FILE); \ - echo "Created $(ENV_FILE)"; \ - fi - $(MAKE) cfg - -fsw: env + +fsw: cfg cd $(CURDIR)/fsw && $(MAKE) runtime -gsw: env +gsw: cfg cd $(CURDIR)/gsw && $(MAKE) runtime help: @@ -96,7 +87,6 @@ help: @echo " clean-sim - Clean simulation components" @echo " container - Build the Docker container" @echo " debug - Start a debug shell in the container" - @echo " env - Create .env file and check required tools" @echo " fsw - Build FSW" @echo " gsw - Build GSW" @echo " sim - Build Simulith and component simulators" @@ -104,7 +94,7 @@ help: @echo " stop - Stop lab and CLI services, clean up Docker images" @echo " uninstall - Remove containers, images, volumes, and networks" -sim: env +sim: cfg @for dir in $(CURDIR)/comp/*/sim ; do \ if [ -d "$$dir" ] && [ -f "$$dir/Makefile" ]; then \ echo "Building component in $$dir"; \ @@ -113,7 +103,7 @@ sim: env done cd $(CURDIR)/simulith && $(MAKE) director && $(MAKE) server -start: env +start: cfg docker compose -f ./cfg/lab-compose.yml up stop: @@ -129,6 +119,6 @@ uninstall: clean docker network ls -q --filter "name=tryspace-net" | xargs -r docker network rm docker network ls -q --filter "name=cfg_tryspace-net" | xargs -r docker network rm @echo "" - @echo "To remove everything docker run: " + @echo "To cleanup everything docker even unrelated to TrySpace: " @echo " docker system prune -a" @echo "" diff --git a/README.md b/README.md index f81792d..6322f86 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,50 @@ Entrypoint for orchestrating full TrySpace simulation environments. -## Community Support +## Quick Start + +Assuming you're running Linux, Mac, or Windows Subsystem for Linux you'll also need to install the following prerequisites: +* Docker Engine and Compose +* Make +* Git + +Once you have those installed you can: +* Clone + * `git clone https://github.com/TrySpaceOrg/tryspace-lab.git` + * `cd tryspace-lab` + * `git submodule update --init --recursive` +* Build + * `make` +* Run + * `make start` +* Use + * Attach to containers + * `docker attach tryspace-server` + * Open GSW + * `firefox localhost:8090` +* Stop + * CTRL+C + * Inspect volumes and logs as desired + * `make stop` + +## Documentation and Support + +The full documentation for TrySpace Lab is available at [TrySpace Atlas](https://tryspaceorg.github.io/). If you have questions, ideas, or need help, feel free to start a [GitHub Discussion](https://github.com/TrySpaceOrg/tryspace-lab/discussions). Discussions are a great place to engage with the community and maintainers. For bug reports or feature requests, please open a [GitHub Issue](https://github.com/TrySpaceOrg/tryspace-lab/issues). -## Documentation - -The full documentation for TrySpace Lab is available at [TrySpace Atlas](https://tryspaceorg.github.io/). - -## Contributing - -We welcome contributions from everyone. Please review our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started. - -## Licensing +## Licensing, Contributing, and Release Notes This project is licensed under the [GNU Affero General Public License v3 (AGPLv3)](https://www.gnu.org/licenses/agpl-3.0.html). By contributing, you agree that your contributions will also be licensed under the AGPLv3 or any other license explicitly noted in the repository. + +We welcome contributions from everyone. +Please review our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started. + +GitHub maintains the full set of [release notes](https://github.com/TrySpaceOrg/tryspace-lab/releases). +Here is the short history for quick reference: +* 0.0.0 - August 18th, 2025 + * Initial proof of concept diff --git a/atlas b/atlas index 42a1453..b2640ae 160000 --- a/atlas +++ b/atlas @@ -1 +1 @@ -Subproject commit 42a1453e3bb5405d1f88a9db318331981507249a +Subproject commit b2640ae08c899bc5f74d0e654554a7d254abe369 diff --git a/cfg/Dockerfile.base b/cfg/Dockerfile.base index df651e0..0e462fd 100644 --- a/cfg/Dockerfile.base +++ b/cfg/Dockerfile.base @@ -3,7 +3,7 @@ # # Assumes build using `make container` from top level of tryspace-lab repository # -# docker push tryspaceorg/tryspace-lab: +# docker push tryspaceorg/tryspace-lab:0.0.0 # FROM debian:bookworm-slim@sha256:6ac2c08566499cc2415926653cf2ed7c3aedac445675a013cc09469c9e118fdd diff --git a/cfg/cli-compose.yml b/cfg/cli-compose.yml index 938a673..312ad0a 100644 --- a/cfg/cli-compose.yml +++ b/cfg/cli-compose.yml @@ -10,7 +10,6 @@ services: container_name: tryspace-sim networks: - tryspace-net - restart: unless-stopped stdin_open: true tty: true environment: @@ -22,8 +21,6 @@ services: - simulith_ipc:/tmp tmpfs: - /dev/shm:noexec,nosuid,size=1g - security_opt: - - seccomp:unconfined privileged: false tryspace-director: @@ -31,7 +28,6 @@ services: container_name: tryspace-director networks: - tryspace-net - restart: unless-stopped stdin_open: true tty: true depends_on: @@ -49,7 +45,6 @@ services: container_name: tryspace-comp-demo-cli networks: - tryspace-net - restart: unless-stopped stdin_open: true tty: true depends_on: diff --git a/cfg/lab-compose.yml b/cfg/lab-compose.yml index 03780ca..444934d 100644 --- a/cfg/lab-compose.yml +++ b/cfg/lab-compose.yml @@ -10,7 +10,6 @@ services: container_name: tryspace-gsw networks: - tryspace-net - restart: unless-stopped attach: false ports: - "8090:8090" # YAMCS Web Interface @@ -30,7 +29,6 @@ services: container_name: tryspace-server networks: - tryspace-net - restart: unless-stopped stdin_open: true tty: true environment: @@ -42,8 +40,6 @@ services: - simulith_ipc:/tmp tmpfs: - /dev/shm:noexec,nosuid,size=1g - security_opt: - - seccomp:unconfined privileged: false tryspace-director: @@ -51,7 +47,6 @@ services: container_name: tryspace-director networks: - tryspace-net - restart: unless-stopped stdin_open: true tty: true depends_on: @@ -69,7 +64,6 @@ services: container_name: tryspace-fsw networks: - tryspace-net - restart: unless-stopped stdin_open: true tty: true depends_on: @@ -87,8 +81,6 @@ services: - simulith_ipc:/tmp tmpfs: - /dev/shm:noexec,nosuid,size=1g - security_opt: - - seccomp:unconfined privileged: false networks: diff --git a/cfg/tryspace-orchestrator.py b/cfg/tryspace-orchestrator.py index 79497df..7f935c4 100644 --- a/cfg/tryspace-orchestrator.py +++ b/cfg/tryspace-orchestrator.py @@ -1,4 +1,3 @@ -from jinja2 import Environment, FileSystemLoader #!/usr/bin/env python3 """ Orchestrator for tryspace-lab configuration. @@ -6,6 +5,7 @@ """ import sys import os +from jinja2 import Environment, FileSystemLoader import yaml CFG_DIR = os.path.dirname(os.path.abspath(__file__)) diff --git a/comp/demo b/comp/demo index a638bc3..ff15044 160000 --- a/comp/demo +++ b/comp/demo @@ -1 +1 @@ -Subproject commit a638bc38baf5ce845c77397d73b6895c22bd020a +Subproject commit ff150449448af06b91ae6083be220aa06febf749 diff --git a/fsw b/fsw index 690acec..f9f1a7d 160000 --- a/fsw +++ b/fsw @@ -1 +1 @@ -Subproject commit 690acecdb2b8ac9a3a075d566d766c3fcff81d31 +Subproject commit f9f1a7dad249bc98bba622d2636362b46a9271ef diff --git a/gsw b/gsw index 361dda0..aef7367 160000 --- a/gsw +++ b/gsw @@ -1 +1 @@ -Subproject commit 361dda0cf45cf402a5230f81f0cf39fbf76d373c +Subproject commit aef73672a950f438602b9f0ba6a232dc35879be2 diff --git a/simulith b/simulith index 15b5dd9..7356dbc 160000 --- a/simulith +++ b/simulith @@ -1 +1 @@ -Subproject commit 15b5dd911bd24bd55c003b9ffa567c17d0040564 +Subproject commit 7356dbc338bdf5867150a580abea0d124abf47c7