Merge pull request #109 from ichumuh/the-great-refactoring

searched and replaced all "semantic_world", "semantic world" and "Semantic World" with semantic digital twin equivalents

Author: tomsch420

.github/workflows/build_and_deploy_doc.yml

@@ -31,23 +31,23 @@ jobs:
     steps:
     - uses: actions/checkout@v4
       with:
-        path: "ros/src/semantic_world"
+        path: "ros/src/semantic_digital_twin"
         repository: ${{ github.repository }}
         ref: ${{ github.ref }}
         submodules: 'false'
 
-    - name: Update semantic_world source files
+    - name: Update semantic_digital_twin source files
       run: |
-        rm -rf /opt/ros/semantic_world/* 
-        cd /opt/ros/semantic_world
+        rm -rf /opt/ros/semantic_digital_twin/* 
+        cd /opt/ros/semantic_digital_twin
         rm -rf .git .github .gitignore .gitmodules .readthedocs.yaml
-        cp -r /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}/ros/src/semantic_world /opt/ros
+        cp -r /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}/ros/src/semantic_digital_twin /opt/ros
 
     - name: Install dependencies
       run: |
         sudo apt-get update
-        cd /opt/ros/semantic_world
-        source /opt/ros/semantic_world-venv/bin/activate
+        cd /opt/ros/semantic_digital_twin
+        source /opt/ros/semantic_digital_twin-venv/bin/activate
         pip install -U pip && pip install -r requirements.txt && pip install . && pip install -r doc/requirements.txt
 
     # (optional) Cache your executed notebooks between runs
@@ -63,17 +63,17 @@ jobs:
     # Build the book
     - name: Build the book
       run: |
-        cd /opt/ros/semantic_world
+        cd /opt/ros/semantic_digital_twin
         source /opt/ros/overlay_ws/install/setup.bash
-        source /opt/ros/semantic_world-venv/bin/activate
+        source /opt/ros/semantic_digital_twin-venv/bin/activate
         jupyter-book build doc
 
     # Upload the book's HTML as an artifact
     - name: Upload artifact
       if: github.event_name == 'push'
       uses: actions/upload-pages-artifact@v3
       with:
-        path: "/opt/ros/semantic_world/doc/_build/html"
+        path: "/opt/ros/semantic_digital_twin/doc/_build/html"
 
     # Deploy the book's HTML to GitHub Pages
     - name: Deploy to GitHub Pages

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
         repository: ${{ github.repository }}
         ref: ${{ github.ref }}
         submodules: 'false'
-    - name: Update semantic_world source files
+    - name: Update semantic_digital_twin source files
       run: |
         rm -rf /opt/ros/semantic_world/* 
         cd /opt/ros//semantic_world
@@ -35,7 +35,7 @@ jobs:
       run: |
         sudo apt-get update
         cd /opt/ros/semantic_world
-        source /opt/ros/semantic_world-venv/bin/activate
+        source /opt/ros/semantic_digital_twin-venv/bin/activate
         git submodule init
         git submodule update
         pip install -U pip && pip install -r requirements.txt && pip install -e . && pip install pytest
@@ -47,6 +47,6 @@ jobs:
     - name: Run tests
       run: |
         source /opt/ros/overlay_ws/install/setup.bash
-        source /opt/ros/semantic_world-venv/bin/activate
+        source /opt/ros/semantic_digital_twin-venv/bin/activate
         cd /opt/ros/semantic_world
         python -m pytest -v test/

.github/workflows/notebook-test-ci.yml

@@ -20,23 +20,23 @@ jobs:
     steps:
     - uses: actions/checkout@v4
       with:
-        path: "ros/src/semantic_world"
+        path: "ros/src/semantic_digital_twin"
         repository: ${{ github.repository }}
         ref: ${{ github.ref }}
         submodules: 'false'
-    - name: Update semantic_world source files
+    - name: Update semantic_digital_twin source files
       run: |
-        rm -rf /opt/ros/semantic_world/* 
-        cd /opt/ros//semantic_world
+        rm -rf /opt/ros/semantic_digital_twin/* 
+        cd /opt/ros//semantic_digital_twin
         rm -rf .git .github .gitignore .gitmodules .readthedocs.yaml
-        cp -r /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}/ros/src/semantic_world /opt/ros/
+        cp -r /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}/ros/src/semantic_digital_twin /opt/ros/
 
     - name: Install dependencies
       run: |
         sudo apt-get update
         sudo apt install python3-cffi -y
-        cd /opt/ros/semantic_world
-        source /opt/ros/semantic_world-venv/bin/activate
+        cd /opt/ros/semantic_digital_twin
+        source /opt/ros/semantic_digital_twin-venv/bin/activate
         git submodule init
         git submodule update
         pip install -U pip && pip install -U -r requirements.txt && pip install -e . && pip install pytest
@@ -49,6 +49,6 @@ jobs:
     - name: Run tests
       run: |
         source /opt/ros/overlay_ws/install/setup.bash
-        source /opt/ros/semantic_world-venv/bin/activate
-        cd /opt/ros/semantic_world/scripts
+        source /opt/ros/semantic_digital_twin-venv/bin/activate
+        cd /opt/ros/semantic_digital_twin/scripts
         /bin/bash test_notebook_examples.sh

.github/workflows/publish-to-pypi.yml

@@ -37,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: pypi
-      url: https://pypi.org/p/semantic_world # Replace <package-name> with your PyPI project name
+      url: https://pypi.org/p/semantic_digital_twin # Replace <package-name> with your PyPI project name
     permissions:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
 

.github/workflows/update_docker.yml

@@ -5,7 +5,7 @@ on:
       - main
     paths:
       - 'docker/Dockerfile'
-      - 'semantic_world_msgs'
+      - 'semantic_digital_twin_msgs'
       - 'docker/entrypoint.sh'
 # only run when a commit has changes in the requirements.txt file
 

.junie/guidelines.md

@@ -1,4 +1,4 @@
-# Semantic World Guidelines
+# Semantic Digital Twin Guidelines
 
 ## Testing
 - If you need to run tests, execute them with pytest
@@ -9,7 +9,7 @@
 - Do not use abbreviations
 - Create classes instead of using too many primitives
 - Minimize duplication of code
-- Use the semantic_world/doc/styleguide.md for naming transformation variables
+- Use the semantic_digital_twin/doc/styleguide.md for naming transformation variables
 - Do not wrap attribute access in try-except blocks
 - Always access attributes via ".", never via getattr
 - Use existing packages whenever possible
@@ -18,7 +18,7 @@
 
 ## Design Principles
 - Always apply the SOLID principles of object-oriented programming 
-- If you have to create new view classes, stick to the design of existing views found in semantic_world.views.views
+- If you have to create new semantic annotation classes, stick to the design of existing semantic annotations found in semantic_digital_twin.semantic_annotations.semantic_annotations
 - Create meaningful custom exceptions
 - Eliminate YAGNI smells
 - Make interfaces hard to misuse

README.md

@@ -1,15 +1,15 @@
-# Welcome to the Semantic World Package
-Introducing Semantic World: A unified interface for scene data and asserted meaning.
+# Welcome to the Semantic Digital Twin Package
+Introducing Semantic Digital Twin: A unified interface for scene data and asserted meaning.
 
-The Semantic World Python package streamlines the integration and management of scene graphs with explicit semantic assertions.
+The Semantic Digital Twin Python package streamlines the integration and management of scene graphs with explicit semantic assertions.
 Agents and autonomous systems require more than just coordinates, they need contextual understanding. 
-Semantic World bridges geometry, kinematics, and meaning, allowing systems for planning, 
+Semantic Digital Twin bridges geometry, kinematics, and meaning, allowing systems for planning, 
 learning, and reasoning to process the environment through actionable, high-level concepts.
 
 This enables the construction of environments that can be readily understood,
 queried, transformed, and shared across projects.
 Whether for research prototypes or robust data pipelines,
-Semantic World translates raw environment data into structured knowledge.
+Semantic Digital Twin translates raw environment data into structured knowledge.
 
 ## Assimilated Technologies
 
@@ -53,11 +53,11 @@ real-time world synchronization.
 Structures can be created, merged, and updated at once, 
 ensuring they are accurately reflected across all connected instances.
 
-🚀 Get started with the [user-guide](https://cram2.github.io/semantic_world/user_guide.html#user-guide)!
+🚀 Get started with the [user-guide](https://cram2.github.io/semantic_digital_twin/user_guide.html#user-guide)!
 
-📖 Read the full [documentation](https://cram2.github.io/semantic_world/intro.html)!
+📖 Read the full [documentation](https://cram2.github.io/semantic_digital_twin/intro.html)!
 
-🤝 Contribute with the [developer-guide](https://cram2.github.io/semantic_world/developer_guide.html#developer-guide)!
+🤝 Contribute with the [developer-guide](https://cram2.github.io/semantic_digital_twin/developer_guide.html#developer-guide)!
 
 
 # User Installation
@@ -66,15 +66,15 @@ ensuring they are accurately reflected across all connected instances.
 You can install the package directly from PyPI:
 
 ```bash
-pip install -U semantic_world
+pip install -U semantic_digital_twin
 ```
 
 # Contributing
 
 If you are interested in contributing, you can check out the source code from GitHub:
 
 ```bash
-git clone https://github.com/cram2/semantic_world.git
+git clone https://github.com/cram2/semantic_digital_twin.git
 ```
 
 ### Development Dependencies
@@ -86,7 +86,7 @@ pip install -r requirements.txt
 
 
 # Tests
-The tests can be run with `pytest` directly in PyCharm or from the terminal after installing Semantic World as a python package.
+The tests can be run with `pytest` directly in PyCharm or from the terminal after installing Semantic Digital Twin as a python package.
 
 ```bash
 pip install -e .

doc/_config.yml

@@ -1,9 +1,9 @@
 # Book settings
 # Learn more at https://jupyterbook.org/customize/config.html
 
-title: Semantic World
+title: Semantic Digital Twin
 author: AICOR Institute for Artificial Intelligence
-logo: "images/semantic_world_logo.png"
+logo: "images/semantic_digital_twin_logo.png"
 
 # Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
@@ -41,13 +41,13 @@ sphinx:
     html_static_path: ["_static"]
     html_theme_options:
       logo:
-        image_light: "_static/images/semantic_world_logo.png"
-        image_dark: "_static/images/semantic_world_logo_dark_mode.png"
+        image_light: "_static/images/semantic_digital_twin_logo.png"
+        image_dark: "_static/images/semantic_digital_twin_logo_dark_mode.png"
 
 
 # Information about where the book exists on the web
 repository:
-  url: https://github.com/cram2/semantic_world  # Online location of your book
+  url: https://github.com/cram2/semantic_digital_twin  # Online location of your book
   path_to_book: doc  # Optional path to your book, relative to the repository root
   branch: main  # Which branch of the repository should be used when creating links (optional)
 

doc/conf.py

@@ -15,11 +15,11 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath(os.path.join("..", "src", "semantic_world")))
+sys.path.insert(0, os.path.abspath(os.path.join("..", "src", "semantic_digital_twin")))
 
 # -- Project information -----------------------------------------------------
 
-project = "semantic_world"
+project = "semantic_digital_twin"
 copyright = "2025, AICOR Institute for Artificial Intelligence"
 author = "AICOR Institute for Artificial Intelligence"
 

doc/developer_guide.rst

@@ -3,9 +3,9 @@
 Developer Guide
 ===============
 
-This guide explains how to effectively contribute to the semantic world.
+This guide explains how to effectively contribute to the semantic digital twin.
 General code style related guidelines that can also be used for your AI assistant are found in the
-`junie guidelines <https://github.com/cram2/semantic_world/tree/main/.junie/guidelines.md>`_.
+`junie guidelines <https://github.com/cram2/semantic_digital_twin/tree/main/.junie/guidelines.md>`_.
 
 Environment Setup
 -----------------
@@ -23,30 +23,29 @@ You can locally install the package with
 
 .. code-block:: bash
 
-   mkvirtualenv semantic_world --system-site-packages
-   cd /path/to/semantic_world
+   mkvirtualenv semantic_digital_twin --system-site-packages
+   cd /path/to/semantic_digital_twin
    pip install -e .
 
 Core Parts
 ----------
 
-- :py:mod:`semantic_world.adapters`: Bridges between the World and external ecosystems and file formats. They import/export world data and keep it in sync with tools like ROS2, simulators, and mesh/robot formats.
+- :py:mod:`semantic_digital_twin.adapters`: Bridges between the World and external ecosystems and file formats. They import/export world data and keep it in sync with tools like ROS2, simulators, and mesh/robot formats.
 
-- :py:mod:`semantic_world.world`: The central scene-graph/kinematic container you interact with. It owns bodies, connections, and degrees of freedom; validates and updates the kinematic structure; provides forward/inverse kinematics, collision-related utilities, callbacks for state/model changes, and orchestration of higher-level semantics like views.
+- :py:mod:`semantic_digital_twin.world`: The central scene-graph/kinematic container you interact with. It owns bodies, connections, and degrees of freedom; validates and updates the kinematic structure; provides forward/inverse kinematics, collision-related utilities, callbacks for state/model changes, and orchestration of higher-level semantics like semantic annotations.
 
-- :py:mod:`semantic_world.orm`: The database layer. It maps world entities and relationships to SQL databases via SQLAlchemy (auto-generated with `ormatic`), enabling serialization, persistence, and retrieval of complete worlds. It defines the SQL types and a thin interface to store/load worlds reproducibly. If you are unhappy with the storage and retrieval of data from databases you most likely have to change something here
+- :py:mod:`semantic_digital_twin.orm`: The database layer. It maps world entities and relationships to SQL databases via SQLAlchemy (auto-generated with `ormatic`), enabling serialization, persistence, and retrieval of complete worlds. It defines the SQL types and a thin interface to store/load worlds reproducibly. If you are unhappy with the storage and retrieval of data from databases you most likely have to change something here
 
-- :py:mod:`semantic_world.spatial_types`: Numeric/symbolic geometric primitives and transformations used across the package (e.g., `TransformationMatrix`, points, vectors, expressions, derivatives). They support composing poses, doing kinematics, and differentiating expressions for solvers.
+- :py:mod:`semantic_digital_twin.spatial_types`: Numeric/symbolic geometric primitives and transformations used across the package (e.g., `TransformationMatrix`, points, vectors, expressions, derivatives). They support composing poses, doing kinematics, and differentiating expressions for solvers.
 
-- :py:mod:`semantic_world.views`: Semantic abstractions built on top of raw bodies and connections. A `View` represents a higher-level concept (e.g., a drawer composed of a handle and a prismatic container) and can be inferred by rules. Views provide task-relevant groupings and behaviors without changing the underlying kinematic graph.
-
-- :py:mod:`semantic_world.world_description`: The domain model for kinematic structure and geometry: `Body`, `Region`, `Connection` (fixed, passive/active joints, 6-DoF), `DegreeOfFreedom`, geometry/mesh types, state and modification objects. These classes define the structure and editable state that the `World` manages and reasoners and adapters consume.
+- :py:mod:`semantic_digital_twin.semantic_annotations`: Semantic abstractions built on top of raw bodies and connections. A `SemanticAnnotation` represents a higher-level concept (e.g., a drawer composed of a handle and a prismatic container) and can be inferred by rules. semantic annotations provide task-relevant groupings and behaviors without changing the underlying kinematic graph.
+- :py:mod:`semantic_digital_twin.world_description`: The domain model for kinematic structure and geometry: `Body`, `Region`, `Connection` (fixed, passive/active joints, 6-DoF), `DegreeOfFreedom`, geometry/mesh types, state and modification objects. These classes define the structure and editable state that the `World` manages and reasoners and adapters consume.
 
 Testing
 -------
 
 The tests are all contained in the test folder and further grouped by topics and written with `pytest <https://docs.pytest.org/en/7.1.x/index.html>`_.
-The semantic world contains a module :py:mod:`semantic_world.testing` for useful fixtures that shorten your boilerplate code.
+The semantic digital twin contains a module :py:mod:`semantic_digital_twin.testing` for useful fixtures that shorten your boilerplate code.
 We aim for a test coverage > 95% and generally test everything we write. 
 Naturally, there are some exceptions, mainly including printing and visualization functionality.
 
@@ -55,7 +54,7 @@ You can execute them with
 
 .. code-block:: bash
 
-   cd /path/to/semantic_world
+   cd /path/to/semantic_digital_twin
    pytest test
 
 Documentation
@@ -66,7 +65,7 @@ You can build it locally using
 
 .. code-block:: bash
 
-   cd /path/to/semantic_world/doc
+   cd /path/to/semantic_digital_twin/doc
    jb build .
 
 
@@ -85,7 +84,7 @@ You can test the entirety of notebooks using treon with
 
 .. code-block:: bash
 
-   cd /path/to/semantic_world/scripts
+   cd /path/to/semantic_digital_twin/scripts
    bash test_notebooks.sh
 
 Contribution Guidelines
@@ -108,7 +107,7 @@ If you are a fellow pycharm enjoyer, there are a couple of hints I want to hand
 
 Help, people are unhappy with my PR
 -----------------------------------
-We only accept clean code that does something useful and feels like it belongs inside the semantic world.
+We only accept clean code that does something useful and feels like it belongs inside the semantic digital twin.
 If the reviews address the quality/cleanness of your code, here are resources to improve your python object-oriented programming skills:
 
 - `SOLID Principles <https://realpython.com/solid-principles-python/>`_