cgse 2023.38.0__py3-none-any.whl → 2024.1.4__py3-none-any.whl

scripts/print_hdf5_hk_data.py

@@ -1,68 +0,0 @@
-from __future__ import annotations
-from pathlib import Path
-
-import click
-import rich
-from rich.console import Console
-from rich.table import Table
-
-from egse import h5
-from egse.fee.nfee import HousekeepingData
-
-@click.command()
-@click.argument('filename')
-def print_hk_data(filename: str | Path):
-    """Prints the updated HK data that is saved in the HDF5 file."""
-
-    filename = Path(filename)
-
-    if filename.exists():
-        console = Console(width=80)
-        try:
-            with h5.get_file(filename, mode='r') as hdf5_file:
-                rich.print(f"HK data from {filename}", end='')
-                if "/obsid" in hdf5_file:
-                    obsid = h5.get_data(hdf5_file["/obsid"]).item().decode()
-                    if obsid != 'None':
-                        rich.print(f", OBSID = {obsid}\n")
-                    else:
-                        rich.print()
-
-                # TODO:
-                #    Make a table with 5 columns where the first column is the parameter name
-                #    the next columns the values for each frame
-                #    Detect specific names and convert the values (use dictionary dispatching?)
-
-                tmp_hk_data = {}
-                tmp_frame_numbers = []
-
-                for frame_number in {0, 1, 2, 3}:
-                    if (key := f"/{frame_number}/hk_data") in hdf5_file:
-                        tmp_frame_numbers.append(frame_number)
-                        hk_data = h5.get_data(hdf5_file[key])
-                        hk_data = HousekeepingData(hk_data)
-                        # rich.print(hk_data)
-                        for par_name in hk_data:
-                            if par_name not in tmp_hk_data:
-                                tmp_hk_data[par_name] = []
-                            tmp_hk_data[par_name].append(hk_data[par_name])
-
-                table = Table(title=f"Housekeeping Data for {obsid}", expand=False)
-                table.add_column("Parameter")
-
-                for fn in tmp_frame_numbers:
-                    table.add_column(f"Frame {fn}")
-
-                for k, v in tmp_hk_data.items():
-                    table.add_row(str(k), *[f"0x{x:0x}" for x in v])
-
-                console.print(table)
-
-        except OSError as exc:
-            rich.print(f"{filename=!s}, {exc}")
-    else:
-        rich.print(f"no such file {filename!s}")
-
-
-if __name__ == "__main__":
-    print_hk_data()

scripts/print_register_map.py

@@ -1,43 +0,0 @@
-from __future__ import annotations
-from pathlib import Path
-
-import click
-import rich
-
-from egse import h5
-from egse.reg import RegisterMap
-
-@click.command()
-@click.argument('filename')
-def print_register_map(filename: str | Path):
-    """
-    Prints the Register Map that is saved in the HDF5 file.
-
-    The FILENAME argument shall be the full path to the HDF5 file from which the register map is requested.
-    """
-
-    filename = Path(filename)
-
-    if filename.exists():
-        try:
-            with h5.get_file(filename, mode='r') as hdf5_file:
-                rich.print(f"Register Map from {filename}", end='')
-                if "/obsid" in hdf5_file:
-                    obsid = h5.get_data(hdf5_file["/obsid"]).item().decode()
-                    if obsid != 'None':
-                        rich.print(f", OBSID = {obsid}\n")
-                    else:
-                        rich.print()
-
-                if "/register" in hdf5_file:
-                    reg_data = h5.get_data(hdf5_file["/register"])
-                    reg_map = RegisterMap("N-FEE", memory_map=reg_data)
-                    rich.print(reg_map)
-        except OSError as exc:
-            rich.print(f"{filename=!s}, {exc}")
-    else:
-        rich.print(f"no such file {filename!s}")
-
-
-if __name__ == "__main__":
-    print_register_map()

scripts/sron/commanding/control_heaters.py

@@ -1,44 +0,0 @@
-#!/usr/bin/env python3
-
-import logging
-import time
-
-from argparse import ArgumentParser
-
-from egse.tempcontrol.beaglebone.beaglebone import BeagleboneProxy
-
-log = logging.getLogger(__name__)
-logging.basicConfig()
-
-parser = ArgumentParser()
-parser.add_argument('device', type=int, help='beaglebone device index [0, 1]')
-parser.add_argument('channel', type=int, help='beaglebone pwm channel [0, 3]')
-parser.add_argument('setpoint', type=int, help='pwm duty cycle in %%')
-args = parser.parse_args()
-
-assert args.device in [0, 1, 2, 3], 'device index must be in [0 - 3]'
-assert args.channel in [0, 1, 2, 3], 'pwm channel must be in [0 - 3]'
-assert args.setpoint in range(0, 101), 'pwm duty cycle must be in [0 - 100]'
-
-try:
-    beaglebone = BeagleboneProxy()
-except Exception as e:
-    log.error(f'could not connect to beaglebone control server ({e})')
-else:
-    log.info('connected to beaglebone control server')
-
-try:
-    beaglebone.set_period(args.device, args.channel, 10000)
-    beaglebone.set_duty_cycle(args.device, args.channel, (args.setpoint * 100))
-    if args.setpoint == 0:
-        beaglebone.set_enable(args.device, args.channel, False)
-    else:
-        beaglebone.set_enable(args.device, args.channel, True)
-except Exception as e:
-    log.error(f'could not set duty cycle ({e})')
-
-while True:
-    time.sleep(1)
-    print(beaglebone.get_voltage(args.device, args.channel), 'V')
-    print(beaglebone.get_current(args.device, args.channel), 'A')
-    print(beaglebone.get_power(args.device, args.channel), 'W')

scripts/sron/commanding/pumpdown.py

@@ -1,46 +0,0 @@
-#!/usr/bin/env python3
-
-import logging
-from time import sleep
-
-from egse.vacuum.instrutech.igm402 import Igm402Proxy
-from egse.vacuum.pfeiffer.tc400 import Tc400Proxy
-from egse.vacuum.pfeiffer.acp40 import Acp40Proxy
-
-log = logging.getLogger(__name__)
-logging.basicConfig()
-
-igm402 = Igm402Proxy()
-tc400 = Tc400Proxy()
-acp40 = Acp40Proxy()
-
-# TODO: check vessel door interlock
-# TODO: open gate valve
-
-log.info('Starting ACP40')
-acp40.set_enable(enable=True)
-
-log.info('Waiting for pressure to reach 6E-0 mbar...')
-while (igm402.get_cgn_pressure(index=1) > 6E-0):
-    sleep(1)
-log.info('Starting TC400')
-tc400.set_pumpingstation(enable=True)
-tc400.set_motorpump(enable=True)
-
-log.info('Waiting for pressure to reach 1.1E-3 mbar...')
-while (igm402.get_cgn_pressure(index=1) > 1.1E-3):
-    last_error = tc400.get_last_error()
-    if last_error != 0:
-        log.error(f'TC400 error: {last_error}')
-        tc400.set_pumpingstation(enable=False)
-        exit()
-    sleep(1)
-
-# log.info('Turn on ionization gauge')
-igm402.set_filament_enable(enable=True)
-
-log.info('Waiting for pressure to reach 1E-5 mbar...')
-while (igm402.get_ion_gauge_pressure() > 1E-5):
-    sleep(1)
-
-log.info('Ready for cooling')

scripts/sron/commanding/set_pid_setpoint.py

@@ -1,19 +0,0 @@
-#!/usr/bin/env python3
-
-from argparse import ArgumentParser
-from egse.tempcontrol.spid.spid import PidProxy
-
-parser = ArgumentParser()
-parser.add_argument('channel', type=int, help='channel index')
-parser.add_argument('setpoint', type=float, help='temperature setpoint')
-parser.add_argument('enable', type=bool, help="Enable controller")
-
-args = parser.parse_args()
-
-p = PidProxy()
-
-if args.enable:
-    p.set_temperature(args.channel, args.setpoint)
-    p.enable(args.channel)
-else:
-    p.disable(args.channel)

scripts/sron/commanding/shutdown_bbb_heaters.py

@@ -1,10 +0,0 @@
-#!/usr/bin/env python3
-
-from egse.tempcontrol.beaglebone.beaglebone import BeagleboneProxy
-
-bbb = BeagleboneProxy()
-
-for device in range(4):
-    for channel in range(4):
-        bbb.set_enable(device, channel, False)
-        #print(bbb.get_current(device, channel))

scripts/sron/commanding/shutdown_pumps.py

@@ -1,33 +0,0 @@
-#!/usr/bin/env python3
-
-import logging
-from time import sleep
-
-from egse.vacuum.instrutech.igm402 import Igm402Proxy
-from egse.vacuum.pfeiffer.tc400 import Tc400Proxy
-from egse.vacuum.pfeiffer.acp40 import Acp40Proxy
-
-log = logging.getLogger(__name__)
-logging.basicConfig()
-
-igm402 = Igm402Proxy()
-tc400 = Tc400Proxy()
-acp40 = Acp40Proxy()
-
-# TODO: turn of vacscan filament
-# TODO: close gate valve
-
-log.info('Turn of IGM402 filament')
-igm402.set_filament_enable(enable=False)
-
-log.info('Shut down TC400')
-tc400.set_pumpingstation(enable=False)
-
-log.info('Waiting for tc400 to reach 50 Hz...')
-while (tc400.get_active_speed() > 50):
-    sleep(1)
-
-log.info('Shut down ACP40')
-acp40.set_enable(enable=False)
-
-log.info('Done')

scripts/sron/tm_gen/tm_gen_agilent.py

@@ -1,38 +0,0 @@
-from argparse import ArgumentParser
-
-import pandas as pd
-
-# Use these names to read the agilent channels from the setup
-from egse.state import GlobalState
-
-# This script generates the tm_dictionary entries for the agilent channels defined in the setup.
-# It uses Heino's harnes excel sheet to fill in what each channel is connected to in the description.
-
-long_names = ['agilent34970_0', 'agilent34970_1', 'agilent34972_0', 'agilent34972_1']
-short_names = ['AG34970_0', 'AG34970_1', 'AG34972_0', 'AG34972_1']
-storage_mnemonic = ['AG34970-0', 'AG34970-1', 'AG34972-0', 'AG34972-1']
-sensor_types = ['two_wire', 'four_wire', 'thermocouples', 'pt100']
-
-parser = ArgumentParser()
-parser.add_argument('--filename', '-f', type=str, required=True, help="path to Heino's connection spreadsheet")
-args = parser.parse_args()
-
-with open(args.filename, 'rb') as f:
-    harness = pd.read_excel(f)
-
-setup = GlobalState.setup
-
-for long_name, short_name, mnemonic in zip(long_names, short_names, storage_mnemonic):
-    for sensor_type in sensor_types:
-        for channel in setup.gse[long_name][sensor_type]:
-
-            # find matching column in excel sheet
-            description = ""
-            for index, row in harness.iterrows():
-                if row[1].lower() == long_name and row[2] == channel:
-                    description = row[3]
-                    break
-
-            print(f'{long_name} temperature read-out;{mnemonic};GSRON_{short_name}_R{channel};GSRON_{short_name}_R{channel};timestamp;;;;;{description};;Ohm;;;;;;;;')
-            print(f'{long_name} temperature read-out;{mnemonic};GSRON_{short_name}_T{channel};GSRON_{short_name}_T{channel};timestamp;;;;;{description};;DegCelsius;;;;;;;;')
-            

scripts/sron/tm_gen/tm_gen_heaters.py

@@ -1,4 +0,0 @@
-for board in range(6):
-    for channel in range(4):
-        print(f'Beaglebone Temperature Control;BBB_HEATERS;GSRON_HTR_I_{board}_{channel};GSRON_HTR_I_{board}_{channel};timestamp;;;;;Current of beaglebone {board} heater {channel};;Ampère;;;;;;;;')
-        print(f'Beaglebone Temperature Control;BBB_HEATERS;GSRON_HTR_V_{board}_{channel};GSRON_HTR_V_{board}_{channel};timestamp;;;;;Voltage of beaglebone {board} heater {channel};;Volts;;;;;;;;')

scripts/sron/tm_gen/tm_gen_spid.py

@@ -1,13 +0,0 @@
-from egse.state import GlobalState
-
-setup = GlobalState.setup
-
-channels = []
-for category, channels in setup.gse.spid.configuration.heaters.items():
-    for channel in channels:
-        print(f'PID Controller;SPID;GSRON_PID_CH{channel[0]}_ENABLED;GSRON_PID_CH{channel[0]}_ENABLED;timestamp;;;;;{category};;;;;;;;;;')
-        print(f'PID Controller;SPID;GSRON_PID_CH{channel[0]}_SETPOINT;GSRON_PID_CH{channel[0]}_SETPOINT;timestamp;;;;;{category};;DegCelsius;;;;;;;;')
-        print(f'PID Controller;SPID;GSRON_PID_CH{channel[0]}_INPUT;GSRON_PID_CH{channel[0]}_INPUT;timestamp;;;;;{category};;DegCelsius;;;;;;;;')
-        print(f'PID Controller;SPID;GSRON_PID_CH{channel[0]}_ERROR;GSRON_PID_CH{channel[0]}_ERROR;timestamp;;;;;{category};;DegCelsius;;;;;;;;')
-        print(f'PID Controller;SPID;GSRON_PID_CH{channel[0]}_OUTPUT;GSRON_PID_CH{channel[0]}_OUTPUT;timestamp;;;;;{category};;;;;;;;;;')
-        print(f'PID Controller;SPID;GSRON_PID_CH{channel[0]}_ISUM;GSRON_PID_CH{channel[0]}_ISUM;timestamp;;;;;{category};;;;;;;;;;')

scripts/update_operational_cgse.py

@@ -1,268 +0,0 @@
-import logging
-import multiprocessing
-import os
-import sys
-import textwrap
-from pathlib import Path
-
-import click
-import git
-import invoke
-import rich
-from rich.console import Console
-
-multiprocessing.current_process().name = "update_cgse"
-
-from egse.system import chdir
-
-THIS_FILE_LOCATION = Path(__file__).parent
-
-# The ROOT_PROJECT_FOLDER is the location where the Common-EGSE was installed.
-# For development installations, this is where the git repository was cloned,
-# for the operational system, this is usually '/cgse', but should match the
-# PLATO_INSTALL_LOCATION environment variable in any case.
-
-ROOT_PROJECT_FOLDER = THIS_FILE_LOCATION / "../.."
-
-MODULE_LOGGER = logging.getLogger("egse.scripts")
-
-
-class DirtyRepoError(Exception):
-    pass
-
-
-class GitCommandError(Exception):
-    pass
-
-
-def check_and_report_dirty_repo():
-    repo = git.Repo(Path.cwd())
-
-    if repo.is_dirty(untracked_files=False):
-        rich.print("You have uncommitted changes, unable to install the Common-EGSE.")
-
-        for item in repo.index.diff(None):
-            rich.print(f"  [red]Modified: {item.a_path}")
-
-        rich.print("Stash or submit your changes to GitHub.")
-
-        raise DirtyRepoError()
-
-
-def run_shell_command(cmd: str, hide: bool = True, warn: bool = True, msg: str = None):
-    if msg is None:
-        rich.print(f"Executing '{cmd}'...", end="", flush=True)
-    else:
-        rich.print(f"{msg}...", end="", flush=True)
-
-    response = invoke.run(cmd, hide=hide, warn=warn)
-
-    if response.return_code:
-        rich.print("[red]FAILED[/red]")
-        if response.stdout:
-            rich.print(f"{response.stdout}")
-        rich.print(f"[red]{response.stderr}[/]")
-        raise GitCommandError()
-    else:
-        rich.print("[green]succeeded[/green]")
-
-    return response
-
-
-def is_operational_install(location: str):
-    # location can be the following:
-    #
-    #   * root folder where Common-EGSE is installed, e.g. /cgse/lib/python
-    #   * the actual 'egg' folder where Common-EGSE is installed,
-    #     e.g. /cgse/lib/python/Common_EGSE-2021.3_SRON_RC37-py3.8.egg
-
-    rich.print(f"{location=}")
-
-    if ".egg" in location:
-        return True
-
-    candidates = [path for path in os.listdir(location) if path.startswith("Common_EGSE") or path.startswith("cgse")]
-
-    rich.print(f"{candidates=}")
-
-    if candidates and candidates[0].endswith(".egg"):
-        return True
-
-    # add other tests here that might indicate operational install
-
-    return False
-
-
-@click.group()
-def cli():
-    pass
-
-
-@cli.command()
-@click.option("--tag", help="The Release number to install.")
-def ops(tag=None):
-    """
-    Update the Common-EGSE on the operational machine. An operational installation is different
-    from a developer installation. There is no virtual environment and the all required Python
-    packages, including the Common-EGSE are installed at a specific location. The installation
-    process makes use of the following environment variables:
-
-      * PLATO_COMMON_EGSE_PATH: the location of the plato-common-egse repository on your machine, e.g., '~/git/plato-common-egse'
-
-      * PLATO_INSTALL_LOCATION: the location where the packages shall be installed, usually '/cgse'
-
-    Don't update the operational system without a tag.
-
-    The following commands will be executed:
-
-      * git fetch updates
-      * get checkout develop
-      * git checkout tags/<tag> -b <tag>-branch
-      * python -m pip install --home=$PLATO_INSTALL_LOCATION .
-
-    You will need to manually restart the core services as root on the egse-server:
-
-      * sudo systemctl restart log_cs cm_cs sm_cs pm_cs dyn_cs
-
-    NOTE: This command only works on an installation with setuptools (not a development
-          installation). The installation must have been done in the location set by the
-          environment variable PLATO_INSTALL_LOCATION.
-
-    Args:
-        tag: the tag that needs to be used for the update.
-
-    """
-
-    try:
-        plato_install_location = os.environ["PLATO_INSTALL_LOCATION"]
-        MODULE_LOGGER.info(f"{plato_install_location=}")
-    except KeyError:
-        rich.print(
-            "[red]On an operational system, the PLATO_INSTALL_LOCATION environment variable must "
-            "be set.[/]\n"
-            "Please set this to the root folder of the installation, usually [default]'/cgse'."
-        )
-        return
-
-    if not Path(plato_install_location).exists():
-        rich.print(
-            f"[orange3]I didn't find the '{plato_install_location}' location on your system.[/]\n"
-            "Please check if the PLATO_INSTALL_LOCATION is set to the correct folder."
-        )
-        return
-
-    try:
-        plato_cgse_location = os.environ["PLATO_COMMON_EGSE_PATH"]
-        MODULE_LOGGER.info(f"{plato_cgse_location=}")
-    except KeyError:
-        rich.print(
-            "[red]On an operational system, the PLATO_COMMON_EGSE_PATH environment variable must "
-            "be set.[/]\nPlease set this to the root folder of the cloned repository, "
-            "usually [default]'~/git/plato-common-egse'."
-        )
-        return
-
-    with chdir(plato_cgse_location):
-        rich.print("Updating plato-common-egse...")
-
-        try:
-            run_shell_command("git fetch updates")
-            run_shell_command("git checkout develop")
-        except GitCommandError:
-            return
-
-        try:
-            check_and_report_dirty_repo()
-        except DirtyRepoError:
-            return
-
-        if tag:
-            try:
-                run_shell_command(f"git checkout tags/{tag} -b {tag}-branch")
-                run_shell_command(f"{sys.executable} -m pip install --prefix={plato_install_location} . ")
-            except GitCommandError:
-                return
-        else:
-            # git rev-list --tags --timestamp --no-walk | sort -nr | head -n1 | cut -f 2 -d ' ' | xargs git describe --contains
-            rich.print("Usage: update_cgse ops --tag=<tag name>")
-            rc = invoke.run("git describe --tags --abbrev=0", hide="stdout")
-            rich.print(f"The latest tag name is '{rc.stdout.strip()}'.")
-            return
-
-        console = Console()
-        console.print(
-            textwrap.dedent(
-                f"""
-                To complete the installation process, perform the following actions:
-                
-                On the egse-client:
-                  * stop all device control servers from the PM GUI
-            
-                On the egse-server:
-                  * run (in the root folder of plato-common-egse): [grey50]invoke stop-core-egse[/]
-                  * the core services should automatically be re-started by systemd,
-                  * (if not, run (in the root folder of plato-common-egse): [grey50]invoke start-core-egse[/])
-                  * Alternatively, you can run: [grey50]sudo systemctl restart log_cs sm_cs cm_cs pm_cs syn_cs[/]
-            
-                """
-            ), highlight=False
-        )
-
-
-
-@cli.command()
-def develop():
-    """
-    Update the Common-EGSE on a develop machine.
-
-    The following commands will be executed in the background:
-
-      * git fetch updates
-
-      * git rebase updates/develop
-
-      * python3 -m pip install -e .
-
-    """
-
-    with chdir(ROOT_PROJECT_FOLDER):
-        rich.print("Updating plato-common-egse development environment.")
-
-        try:
-            check_and_report_dirty_repo()
-        except DirtyRepoError:
-            return
-
-        try:
-            run_shell_command("git fetch updates")
-            run_shell_command("git checkout develop")
-            run_shell_command("git rebase updates/develop")
-            run_shell_command(f"{sys.executable} -m pip install -e .")
-            response = run_shell_command(f"{sys.executable} -m egse.version")
-        except GitCommandError:
-            return
-
-        release = response.tail("stdout").split("\n")[-1]
-
-        try:
-            response = run_shell_command("git describe --tags --long")
-            tag = response.stdout.strip().split("-")
-
-            # The tag format is:
-            #   * the annotated tag
-            #   * the number of commits since the tag
-            #   * abbreviated commit name (starts with the letter 'g')
-
-            number_of_commits = tag[-2]
-            bare_tag = "-".join(tag[:-2])
-
-        except GitCommandError:
-            return
-
-        rich.print(f"{release.strip()}")
-        if number_of_commits != 0:
-            rich.print(f"Number of commits since {bare_tag}: {number_of_commits}")
-
-
-if __name__ == "__main__":
-    cli()