cgse 2025.0.3__tar.gz → 2025.0.5__tar.gz

{cgse-2025.0.3 → cgse-2025.0.5}/NOTES.md

@@ -55,29 +55,6 @@ Note that each library or project is a standalone Poetry package with its own `p
 
 All packages in the monorepo will have the same version. This can be maintained with the `bump.py` script. This script will read the version from the `pyproject.toml` file at the root of the monorepo and propagate the version to all libs and projects in the monorepo. Note that you –for now– will have to update the version number in the `pyproject.toml` file  located at the monorepo root folder manually. 
 
-# Use of Poetry (DEPRECATED: see below)
-
-I have now Poetry configurations for all `libs` in this monorepo. So, how do we use Poetry in this project?
-
-First thing to understand, Poetry is a development and dependency management tool. So, if you are installing the different packages in this repo from PyPI there is no need to use Poetry. The package will be installed in your current virtual environment.
-
-You can choose how you want to manage your virtual environments for each of the packages in the monorepo. I personally use `pyenv` to manage my virtual environments and I disable the virtual environment that would normally be used by Poetry.
-
-> Explain how to use `pyenv` for your virtual environments
-
-The following command starts a new sub-shell and activates the virtual environment: 
-```
-$ poetry shell
-```
-
-If you do not want to start a new shell, but just want to execute a command in the virtual environment, use the `poetry run` command, e.g.
-```
-$ poetry run pytest tests/test_bits.py
-```
-Or
-```
-$ poetry run python -m egse.monitoring localhost 6001
-```
 
 # Build and Publish
 

{cgse-2025.0.3 → cgse-2025.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse
-Version: 2025.0.3
+Version: 2025.0.5
 Summary: Generic Common-EGSE: Commanding and monitoring lab equipment
 Author-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>
 License: MIT

cgse-2025.0.5/conftest.py

@@ -0,0 +1,30 @@
+from glob import glob
+
+import rich
+
+# Quick hack to load plugins from different places.
+# This doesn't work, I get an import error.
+
+# def refactor(string: str) -> str:
+#     entry = string.replace("/", ".").replace("\\", ".").replace(".py", "")
+#     rich.print(f"[green]{entry = }[/]")
+#     return entry
+#
+# pytest_plugins = [
+#     refactor(conftest)
+#     for conftest in glob("**/tests/fixtures/*.py", recursive=True)
+#     if "__" not in conftest
+# ]
+
+# Doesn't work, with the following error:
+#
+# File "/Users/rik/github/cgse/libs/cgse-common/tests/fixtures/default_env.py", line 7, in <module>
+#     from fixtures.helpers import setup_data_storage_layout, teardown_data_storage_layout
+# ImportError: Error importing plugin "libs.cgse-common.tests.fixtures.default_env": No module named 'fixtures'
+#
+
+# pytest_plugins = [
+#     "libs.cgse-common.tests.fixtures.helpers",
+#     "libs.cgse-common.tests.fixtures.default_env",
+#     "libs.cgse-core.tests.fixtures.services",
+# ]

cgse-2025.0.5/docs/custom_theme/main.html

@@ -0,0 +1,32 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/fira_code.min.css" integrity="sha512-MbysAYimH1hH2xYzkkMHB6MqxBqfP0megxsCLknbYqHVwXTCg9IqHbk+ZP/vnhO8UEW6PaXAkKe2vQ+SWACxxA==" crossorigin="anonymous" referrerpolicy="no-referrer" />
+<!-- Fathom - beautiful, simple website analytics -->
+<script src="https://cdn.usefathom.com/script.js" data-site="TAUKXRLQ" defer></script>
+<!-- / Fathom -->
+
+
+<meta property="og:title" content="CGSE - {{ page.title }}">
+<meta property="og:type" content="article">
+<meta property="og:url" content="{{ page.canonical_url | url }}">
+<meta property="og:site_name" content="CGSE Documentation">
+<meta property="og:description" content="CGSE is an instrument test framework for Python.">
+<meta property="og:image" content="https://raw.githubusercontent.com/IvS-KULeuven/cgse/refs/heads/main/docs/images/icons/cgse-logo.svg">
+
+<style>
+
+    @font-face {
+        font-family: "Virgil";
+        src: url("https://unpkg.com/@excalidraw/excalidraw@0.12.0/dist/excalidraw-assets/Virgil.woff2");
+      }
+      @font-face {
+        font-family: "Cascadia";
+        src: url("https://unpkg.com/@excalidraw/excalidraw@0.12.0/dist/excalidraw-assets/Cascadia.woff2");
+      }
+
+
+
+</style>
+
+{% endblock %}

cgse-2025.0.5/docs/dev_guide/index.md

@@ -0,0 +1,6 @@
+# Developer Guide
+
+Welcome to the CGSE developer guide! An in-depth reference on how to contribute to the CGSE.
+
+First thing to know is that this repository is actually a monorepo, meaning it contains a bunch of related but 
+self-standing packages with a minimum of interdependencies. These packages are  

{cgse-2025.0.3 → cgse-2025.0.5}/docs/dev_guide/uv.md

@@ -40,15 +40,23 @@ $ uv python install 3.9.20
 
 You can check which Python versions are installed already on your system:
 
-```shell
-$ uv python list --only-installed
-cpython-3.12.8-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.12.8-macos-aarch64-none/bin/python3.12
-cpython-3.10.16-macos-aarch64-none    /Users/rik/Library/Application Support/uv/python/cpython-3.10.16-macos-aarch64-none/bin/python3.10
-cpython-3.9.21-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.9.21-macos-aarch64-none/bin/python3.9
-cpython-3.9.20-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.9.20-macos-aarch64-none/bin/python3.9
-cpython-3.9.6-macos-aarch64-none      /Library/Developer/CommandLineTools/usr/bin/python3 -> ../../Library/Frameworks/Python3.framework/Versions/3.9/bin/python3
-cpython-3.8.17-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.8.17-macos-aarch64-none/bin/python3.8
-```
+=== "Command"
+
+    ```bash
+    $ uv python list --only-installed
+    ```
+
+=== "Output"
+
+    ```
+    cpython-3.12.8-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.12.8-macos-aarch64-none/bin/python3.12
+    cpython-3.10.16-macos-aarch64-none    /Users/rik/Library/Application Support/uv/python/cpython-3.10.16-macos-aarch64-none/bin/python3.10
+    cpython-3.9.21-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.9.21-macos-aarch64-none/bin/python3.9
+    cpython-3.9.20-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.9.20-macos-aarch64-none/bin/python3.9
+    cpython-3.9.6-macos-aarch64-none      /Library/Developer/CommandLineTools/usr/bin/python3 -> ../../Library/Frameworks/Python3.framework/Versions/3.9/bin/python3
+    cpython-3.8.17-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.8.17-macos-aarch64-none/bin/python3.8
+    ```
+
 
 ## Create a virtual environment
 
@@ -94,6 +102,19 @@ $ uv pip install -e .
     $ source .venv/bin/activate
     ```
 
+!!! info
+
+    In a workspace, maintaining a virtual environment per package might be a hassle and most of the time that is not 
+    needed. A good approach is to always use the virtual environment at the workspace root. This `venv` which will be 
+    automatically created if you run a command or if you use `uv sync` in the package folder. With `uv sync` you can 
+    make sure the virtual environment is up-to-date and contains only those dependencies that are required for the 
+    package you are in. So, each time you switch to another package and want to run a comand or a test for that 
+    package, use 
+
+    ```
+    $ uv sync
+    ```
+
 ## Building and publishing all packages
 
 We have chosen for one and the same version number for all packages in the `cgse` monorepo. That means that whenever 

cgse-2025.0.5/docs/libs/cgse-common/index.md

@@ -0,0 +1,18 @@
+# Common Code
+
+
+This package `cgse-common` contain modules that are used by all other packages. 
+
+## Binary: `egse.bits`
+
+TBW
+
+## Environment: `egse.env`
+
+TBW
+
+## System: `egse.system`
+
+TBW
+
+## 

cgse-2025.0.5/docs/libs/cgse-coordinates/index.md

@@ -0,0 +1,2 @@
+
+# Reference Coordinates

cgse-2025.0.5/docs/libs/cgse-core/index.md

@@ -0,0 +1 @@
+# Core Services

cgse-2025.0.5/docs/libs/cgse-gui/index.md

@@ -0,0 +1 @@
+# GUI Components

cgse-2025.0.5/docs/libs/index.md

@@ -0,0 +1,11 @@
+
+# Libraries
+
+The libraries are those packages that make up the CGSE framework.
+
+The libraries are located under the `libs` folder, and we currently find the following packages there:
+
+- `cgse-common`
+- `cgse-core`
+- `cgse-coordinates`
+- `cgse-gui`

cgse-2025.0.5/docs/projects/cgse-tools.md

@@ -0,0 +1,2 @@
+
+# Tools for the CGSE framework

cgse-2025.0.5/docs/projects/index.md

@@ -0,0 +1,16 @@
+# Projects
+
+The projects are those packages that add functionality to the CGSE framework.
+
+The projects live under the folder `projects`, and they are organised in _generic_ and _specific_ projects. Generic 
+projects do not have an implementation that is specific for one particular project, while, obviously, specific 
+projects have. We currently have the following generic packages:
+
+- `cgse-tools`
+- `symetrie-hexapod`
+
+and then there are the project specific packages:
+
+- `plato-fits`
+- `plato-hdf5`
+- `plato-spw`

cgse-2025.0.5/docs/projects/symetrie-hexapod.md

@@ -0,0 +1,2 @@
+
+# The Symétrie Hexapods

{cgse-2025.0.3 → cgse-2025.0.5}/docs/stylesheets/custom.css

@@ -78,44 +78,20 @@ td code {
 
 }
 
-.textual-web-demo iframe {
-  border: none;
-  width: 100%;
-  aspect-ratio: 16 / 9;
-  padding: 0;
-  margin: 0;
-}
-
-
-.textual-web-demo {
-  display: flex;
-  width: 100%;
-  aspect-ratio: 16 / 9;
-  padding: 0;
-  margin: 0;
-  opacity: 0;
-  transition: 0.3s opacity;
-}
-
-.textual-web-demo.-loaded {
-  opacity: 1.0;
-  transition: 0.3s opacity;
-}
-
 :root {
-  --md-admonition-icon--textualize: url('/images/icons/logo light transparent.svg')
+  --md-admonition-icon--cgse: url('/images/icons/cgse-logo.svg')
 }
-.md-typeset .admonition.textualize,
-.md-typeset details.textualize {
+.md-typeset .admonition.cgse,
+.md-typeset details.cgse {
   border-color: rgb(43, 155, 70);
 }
-.md-typeset .textualize > .admonition-title,
-.md-typeset .textualize > summary {
+.md-typeset .cgse > .admonition-title,
+.md-typeset .cgse > summary {
   background-color: rgba(43, 155, 70, 0.1);
 }
-.md-typeset .textualize > .admonition-title::before,
-.md-typeset .textualize > summary::before {
+.md-typeset .cgse > .admonition-title::before,
+.md-typeset .cgse > summary::before {
   background-color: rgb(43, 155, 70);
-  -webkit-mask-image: var(--md-admonition-icon--textualize);
-          mask-image: var(--md-admonition-icon--textualize);
+  -webkit-mask-image: var(--md-admonition-icon--cgse);
+          mask-image: var(--md-admonition-icon--cgse);
 }

{cgse-2025.0.3 → cgse-2025.0.5}/libs/cgse-common/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "2025.0.3"
+version = "2025.0.5"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IVS KU Leuven"}
@@ -47,6 +47,7 @@ filterwarnings = [
 [tool.coverage.run]
 omit = [
     "tests/*",
+    "conftest.py",
 ]
 
 [tool.hatch.build.targets.sdist]

{cgse-2025.0.3 → cgse-2025.0.5}/libs/cgse-common/src/egse/command.py

@@ -95,7 +95,7 @@ import re
 from collections import namedtuple
 from typing import Callable
 
-from egse.control import Success
+from egse.response import Success
 from egse.exceptions import Error
 
 logger = logging.getLogger(__name__)

{cgse-2025.0.3 → cgse-2025.0.5}/libs/cgse-common/src/egse/control.py

@@ -5,7 +5,6 @@ import abc
 import logging
 import pickle
 import threading
-from typing import Any
 
 import zmq