Update build system

.github/workflows/install.yml

@@ -37,4 +37,4 @@ jobs:
         run: |
           cd scripts
           ./set_vars.sh
-          ./install_platform.sh
+          ./install_submodules.sh

.github/workflows/minimal_install.yml

@@ -37,5 +37,4 @@ jobs:
         run: |
           cd scripts
           ./set_vars.sh
-          ./install_minimal_platform.sh
-          ./run_sc_machine.sh -t
+          ./install_minimal_submodules.sh

.gitignore

@@ -12,6 +12,7 @@ build
 .idea
 __pycache__
 .vscode
+.DS_Store
 
 # texstudio
 *.aux

LICENSE

@@ -1,6 +1,6 @@
 Unless otherwise indicated, the Source Code is licensed under the MIT license.
 
-Copyright (c) 2010-2024 OSTIS
+Copyright (c) 2010-2025 OSTIS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,7 +2,7 @@
 
 <img src="https://github.com/ostis-ai/ostis-web-platform/actions/workflows/main.yml/badge.svg?branch=develop"> [![license](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
-It is the repository of the Platform of the [OSTIS Technology](https://github.com/ostis-ai). Platform OSTIS is intended to be a solid framework to help you deploy existing and create new ostis-systems.
+It is the repository of the Platform of the [OSTIS Technology](https://github.com/ostis-ai). OSTIS Platform is intended to be a solid framework to help you deploy existing and create new ostis-systems.
 
 OSTIS Platform contains:
 
@@ -59,33 +59,54 @@ To learn more about the platform, check out our [documentation](https://github.c
   ```sh
   git clone https://github.com/ostis-ai/ostis-web-platform --recursive
   cd ostis-web-platform
-  ./scripts/install_submodules.sh # download all submodules without compilation.
+  # download all submodules
+  ./scripts/install_submodules.sh
+  # build sc-machine, scp-machine and sc-component-manager
   docker compose build
   ```
 
    </details>
 
-- Natively (using sc-component-manager)
-
-  ```sh
-  git clone https://github.com/ostis-ai/ostis-web-platform
-  cd ostis-web-platform
-  ./scripts/install_minimal_platform.sh
-  ./scripts/run_sc_machine.sh
-  # and write write the following commands in the terminal:
-  # components init
-  # components install sc_web
-  # components install knowledge_base_ims
-  ```
-
 - Natively
 
-  Note: Currently, only Linux (Ubuntu-20.04, Ubuntu-22.04) and macOS are supported by this installation method. If you're going to use it, it might take a while to download dependencies and compile the components. Use it only if you know what you're doing!
+  Note: Currently, only Linux (Ubuntu-22.04, Ubuntu-24.04) and macOS are supported by this installation method.
 
   ```sh
   git clone https://github.com/ostis-ai/ostis-web-platform --recursive
   cd ostis-web-platform
-  ./scripts/install_platform.sh
+  ./scripts/install_submodules.sh
+
+  # to build sc-machine, see https://ostis-ai.github.io/sc-machine/build/quick_start/#start-develop-sc-machine-with-conan
+  cd sc-machine
+  # make sure, that you have `conan`, updated `cmake` and `ninja`
+  cmake --preset release-conan
+  cmake --build --preset release
+  conan install . --build=missing
+  conan export-pkg .
+  cd ..
+
+  # to build scp-machine, see https://ostis-ai.github.io/scp-machine/build/quick_start/#start-develop-scp-machine-with-conan
+  cd scp-machine
+  conan install . -s build_type=Debug --build=missing
+  cmake --preset debug-conan
+  cmake --build --preset debug
+  cd ..
+
+  # to build sc-component-manager, see https://ostis-ai.github.io/sc-component-manager/build/quick_start/#start-develop-sc-component-manager-with-conan
+  cd sc-component-manager
+  conan install . -s build_type=Debug --build=missing
+  cmake --preset debug-conan
+  cmake --build --preset debug
+  cd ..
+
+  # to build sc-web, see https://github.com/ostis-ai/sc-web/blob/main/README.md
+  cd sc-web
+  ./scripts/install_dependencies.sh
+  npm run build
+  source .venv/bin/activate
+  python3 server/app.py
+
+  # after building projects there should be three folders `build/Debug` in sc-machine, scp-machine and sc-component-manager
   ```
 
 ## Usage
@@ -94,7 +115,8 @@ To learn more about the platform, check out our [documentation](https://github.c
 
   ```sh
   # build the knowledge base
-  # required before the first startup (or if you've made updates to KB sources)
+  # required before the first startup 
+  # (or if you've made updates to knowledge base sources)
   docker compose run machine build
   # start platform services and run web interface at localhost:8000
   docker compose up
@@ -103,11 +125,10 @@ To learn more about the platform, check out our [documentation](https://github.c
 - Native installation
 
   ```sh
-  # launch semantic network processing machine
-  ./scripts/run_sc_machine.sh
-  # *in another terminal*
-  # launch semantic interfaces interpreter at localhost:8000
-  ./scripts/run_sc_web.sh
+  # to run sc-machine, see https://ostis-ai.github.io/sc-machine/build/quick_start/#run-sc-machine-in-debug
+  ./sc-machine/build/Debug/bin/sc-builder -i repo.path -o kb.bin --clear
+  ./sc-machine/build/Debug/bin/sc-machine -s kb.bin \
+    -e "sc-machine/build/Debug/lib/extensions;scp-machine/build/Debug/lib/extensions;sc-component-manager/build/Debug/lib/extensions"
   ```
 
 ## Documentation
@@ -117,8 +138,7 @@ to provide opportunity to use it in information processing and knowledge generat
 
 You can access the current version of the documentation in [docs/main.pdf](docs/main.pdf) file of this project.
 
-Documentation is written with
-the help of LaTeX tools in SCn-code representation. To build documentation manually, you'll need a LaTeX distribution installed on your computer. Alternatively, we provide a Docker image to build the documentation in case you can't / don't want to install LaTeX on your PC.
+Documentation is written with the help of LaTeX tools in SCn-code representation. To build documentation manually, you'll need a LaTeX distribution installed on your computer. Alternatively, we provide a Docker image to build the documentation in case you can't / don't want to install LaTeX on your PC.
 
 ### Download scn-tex-plugin and documentation for subprojects
 

docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   web:
-    image: ostis/sc-web:0.8.1-Unlock
+    image: ostis/sc-web:0.9.0
     build:
       context: ./interface/sc-web
     restart: unless-stopped
@@ -15,12 +15,13 @@ services:
         condition: service_healthy
 
   machine:
-    image: ostis/sc-machine:0.9.0-Unlock
+    image: ostis/sc-machine:0.10.0
     build:
       context: ./sc-machine
     restart: unless-stopped
     volumes:
-      - ./:/kb
+      # TODO(NikitaZotov): Don't load all project sources to volume to build knowledge-base.
+      - ./:/knowledge-base
       - kb-binary:/kb.bin
     networks:
       - sc-machine
@@ -31,13 +32,15 @@ services:
       interval: 5s
       timeout: 10s
       retries: 3
-      start_period: 120s
+      # start_period: 120s
     environment:
-      # Use the commented env variable if you need to rebuild KB every startup.
+      # Use the commented env variable if you need to rebuild KB every startup. Also, use commented start period.
       #- "REBUILD_KB=1"
-      - "KB_PATH=/kb/repo.path"
-      - "BINARY_PATH=/sc-machine/bin"
-      - "CONFIG_PATH=/kb/ostis-web-platform.ini"
+      - "KB_PATH=/knowledge-base/repo.path"
+      - "BINARY_PATH=/sc-machine/build/Release/bin"
+      - "EXTENSIONS_PATH=/sc-machine/build/Release/lib/extensions"
+      - "CONFIG_PATH=/knowledge-base/ostis-web-platform.ini"
+      - "SC_SERVER_HOST=0.0.0.0"
     command:
       - "run"
 

docs/changelog.md

@@ -6,15 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Breaking changes
+
+- All build and run scripts have been removed. This was done due to changes in the build system of the sc-machine. So now this repository is most suitable for developers, not for consumers.
+
 ### Added
 
-- Script `run_sc_machine.sh`
-- Script `build_scp_machine.sh`
 - Install scp-machine
-- Script `install_minimal_platform.sh`
-- Script `build_platform.sh`
+- Script `install_minimal_submodules.sh`
 - Script `update_submodules.sh`
-- Script `build_sc_component_manager.sh`
 - Install sc-component-manager
 
 ### Changed
@@ -26,6 +26,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Option `--update` in `install_submodules.sh`
 
+### Removed
+
+- Script `run_sc_server.sh`
+- Script `run_sc_web.sh`
+- Script `build_kb.sh`
+- Script `build_sc_machine.sh`
+- Script `install_dependencies.sh`
+- Script `install_platform.sh`
+
 ## [0.9.0-Unlock] - 22.01.2024
 
 ### Changes

ostis-web-platform.ini

@@ -9,8 +9,8 @@ dump_memory_period = 3600
 dump_memory_statistics = false
 dump_memory_statistics_period = 1200
 
-repo_path = kb.bin
-extensions_path = sc-machine/bin/extensions
+storage = kb.bin
+extensions = sc-machine/bin/extensions
 
 log_type = Console
 log_file = sc-machine/sc-memory.log
@@ -35,11 +35,10 @@ log_file = sc-machine/sc-server.log
 log_level = Info
 
 [sc-builder]
-log_file = sc-machine/scripts/sc_builder.log
-
-input_path = repo.path
+input = repo.path
+output = kb.bin
 
 [sc-component-manager]
-knowledge_base_components_path = kb
+knowledge_base_components_path = knowledge-base
 problem_solver_components_path = problem-solver
 interface_components_path = interface

repo.path

@@ -1,5 +1,5 @@
 # ostis-web-platform
-kb
+knowledge-base
 
 # component manager
-sc-component-manager/kb
+sc-component-manager/knowledge-base

scripts/install_minimal_platform.sh → scripts/install_minimal_submodules.sh

@@ -5,15 +5,10 @@ SCRIPTS_DIR=$(cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd)
 SUBMODULE_SCRIPTS_DIR="${SCRIPTS_DIR}/submodule-scripts"
 source "${SCRIPTS_DIR}/formats.sh"
 
-stage "Install ostis-web-platform"
+stage "Clone submodules"
 
 "${SUBMODULE_SCRIPTS_DIR}/install_sc_machine.sh"
-"${SCRIPTS_DIR}/install_sc_machine_dependencies.sh" --dev
 "${SUBMODULE_SCRIPTS_DIR}/install_scp_machine.sh"
 "${SUBMODULE_SCRIPTS_DIR}/install_sc_component_manager.sh"
-"${SCRIPTS_DIR}/build_sc_machine.sh"
-"${SCRIPTS_DIR}/build_scp_machine.sh"
-"${SCRIPTS_DIR}/build_sc_component_manager.sh"
-"${SCRIPTS_DIR}/build_kb.sh"
 
-stage "ostis-web-platform is installed successfully"
+stage "Submodules cloned successfully"