cgse 2024.7.0__py3-none-any.whl → 2025.0.1__py3-none-any.whl

scripts/fdir/cs_recovery/fdir_cs_recovery.py

@@ -1,54 +0,0 @@
-import importlib
-import logging
-from argparse import ArgumentParser
-
-from egse.control import is_control_server_active
-from egse.procman import ProcessManagerProxy
-from egse.setup import Setup, load_setup
-from egse.zmq_ser import connect_address
-
-logger = logging.getLogger(__name__)
-logging.basicConfig()
-
-parser = ArgumentParser()
-parser.add_argument('cs_name', help='Name of the CS in the config')
-args = parser.parse_args()
-
-SETUP = load_setup()
-SETUP = SETUP['gse']
-
-devices = {}
-devices = Setup.find_devices(SETUP, devices=devices)
-
-cs_name = args.cs_name
-
-for key, value in devices.items():
-    if cs_name in key:
-        proxy = value[0]
-        args = value[1]
-        module_name = proxy[7:].rsplit(".", 1)[0]
-
-        module = importlib.import_module(module_name)
-
-        ctrl_settings = module.CTRL_SETTINGS
-        transport = ctrl_settings.PROTOCOL
-        hostname = ctrl_settings.HOSTNAME
-        if module_name == "egse.aeu.aeu" or "egse.tempcontrol.agilent.agilent3497" in module_name:
-            name = key.split(" ")[1].upper()
-            commanding_port = ctrl_settings[name]["COMMANDING_PORT"]
-        else:
-            commanding_port = ctrl_settings.COMMANDING_PORT
-
-if is_control_server_active(connect_address(transport,
-                                            hostname,
-                                            commanding_port)):
-    logger.info("False positive: CS seems to be online")
-else:
-    try:
-        with ProcessManagerProxy() as procman:
-            procman.start_cs(cs_name, False)
-
-    except Exception as e:
-        logger.error(f"Could not start {args.cs_name}")
-
-        logger.info(f"finished {__name__}")

scripts/fdir/fdir_table.yaml

@@ -1,70 +0,0 @@
-# This file hold the configuration of the FDIR system
-# Each entry represents a predefined FDIR situation.
-# The entries hold:
-#   - priority: only FDIR signals with a higher priority that the current state of the FDIR manager
-#     are acted on (idle = -1).
-#   - script: the mitigation script to execute with its arguments.
-#   - actions: description of the mitigation actions performed by the script. This information is
-#     shown in the alert pop-up on the client.
-
-# Just for testing
-FDIR_TEST:
-    priority: 1
-    script: /fdir_test_recovery.py
-    actions:
-        - don't worry
-        - just a test
-
-# Hardware failures
-# Are called whenever the CS loses its connection with the device
-# Usually recovers by trying to reconnect to the device and gettings its IDN
-# If the CS is unable to retreive an IDN from the device, it will alert an operator
-FDIR_AGILENT_HW:
-    priority: 1
-    script: /hw_recovery/fdir_agilent_hw_recovery.py
-    args: [agilent_index]
-    actions:
-        - shut down heaters regulated by this DAQ
-        - alert operator
-
-# Control server failures
-# Are called whenever proxies can't reach a control server
-# Usually recovers by trying to restart the control server
-# If the CS can't be restarted, it will alert an operator
-FDIR_CS_STOPPED:
-    priority: 1
-    script: /cs_recovery/fdir_cs_recovery.py
-    actions:
-        - alert operator
-
-# Hardware errors
-# Are called when a device raises an error flag
-# Recovery depends on the type of error
-# An operator will be alerted if scripts is unable to recover within a set amount of time
-FDIR_TC400_ERROR:
-    priority: 1
-    script: /error_recovery/fdir_tc400_error_recovery.py
-    actions:
-        - alert operator
-
-# Housekeeping limit violations
-# Are called when a upper or lower limit on some HK variable is crossed
-# Recovery depends on the type of error
-# An operator will always be alerted in this case
-FDIR_PRESSURE_LIMIT:
-    priority: 1
-    script: /limit_recovery/fdir_pressure_limit_recovery.py
-    actions:
-        - close gate valve
-        - close LN2 valves
-        - Turn off IG filament
-
-
-# Pealing of heaters, which leads to high resistance.
-FDIR_BB_HEATER_LIMIT:
-    priority: 1
-    scripts: /limit_recovery/fdir_bb_beaglebone_limit.py
-    args: [agilent_index, channel_index]
-    actions:
-        - shut down heater and corresponding PID channel
-        - alert operator

scripts/fdir/fdir_test_recovery.py

@@ -1,10 +0,0 @@
-import logging
-
-log = logging.getLogger(__name__)
-logging.basicConfig()
-
-log.info(f'running {__name__}')
-
-# sys.exit("Error!")
-
-log.info(f"finished {__name__}")

scripts/fdir/hw_recovery/fdir_agilent_hw_recovery.py

@@ -1,73 +0,0 @@
-import logging
-from argparse import ArgumentParser
-
-import sys
-from numpy import mean
-from time import time
-
-from egse.hk import get_housekeeping
-from egse.setup import load_setup
-from egse.system import EPOCH_1958_1970
-from egse.tempcontrol.beaglebone.beaglebone import BeagleboneProxy
-from egse.tempcontrol.spid.spid import PidProxy
-
-# This script is triggered when one of the agilent DAQs becomes unresponsive.
-# This script is called with the agilent index as argument.
-# All PID channels driven by a sensor connected to the DAQ are disabled.
-# All corresponding heaters are set to the last value given by the PID.
-
-log = logging.getLogger(__name__)
-logging.basicConfig()
-
-log.info(f'running {__name__}')
-
-parser = ArgumentParser()
-parser.add_argument('device_index', type=int, help='DAQ device index [0 - 3]')
-args = parser.parse_args()
-
-# Try to get the setup from the SM.
-setup = load_setup()
-
-# Try to get device proxies.
-bb_proxy = BeagleboneProxy()
-pid_proxy = PidProxy()
-
-if not bb_proxy.is_cs_connected():
-    log.crticial("Could not connect to Beaglebone proxy")
-    sys.exit("Could not connect to Beaglebone proxy")
-if not pid_proxy.is_cs_connected():
-    log.crticial("Could not connect to PID proxy")
-    sys.exit("Could not connect to PID proxy")
-
-pid_channels = []
-for l in setup.gse.spid.configuration.heaters.values():
-    pid_channels.extend(l)
-
-# Turn off all PID channels controlled by this DAQ and set the heater power to the last value.
-for (channel, agilent_idx, _, beaglebone_idx, beaglebone_ch, _, _, _) in pid_channels:
-
-    if agilent_idx == args.device_index:
-
-        # Calculate the average duty cycle over the last minute before shutting down
-        hk_name = f"GSRON_PID_CH{channel}_OUTPUT"
-        timestamp, values = get_housekeeping(hk_name=hk_name, time_window=60)
-        if time() - (float(timestamp[-1]) - EPOCH_1958_1970) > 30:
-            sys.exit("Retrieved duty cycles are more than a minute old")
-             
-        values = [float(val) for val in values]
-        duty_cycle = mean(values)
-        
-        # Read heater power before disabling PID channel.
-        pid_proxy.disable(channel=channel)
-        log.info(f'Disabled PID channel {channel}')
-
-        # Set heater power to last value.
-
-        bb_proxy.set_duty_cycle(beaglebone_idx, beaglebone_ch, int(duty_cycle * 10000))
-        bb_proxy.set_enable(beaglebone_idx, beaglebone_ch, True)
-        log.info(f'Set heater {beaglebone_idx}.{beaglebone_ch} to (fixed) {duty_cycle * 100} %')
-
-    else:
-        log.info(f"PID channel #{channel} not associated with DAQ #{args.device_index}")
-
-log.info(f'finished {__name__}')

scripts/fdir/limit_recovery/fdir_agilent_limit.py

@@ -1,61 +0,0 @@
-import logging
-from argparse import ArgumentParser
-
-import sys
-
-from egse.setup import load_setup
-from egse.tempcontrol.beaglebone.beaglebone import BeagleboneProxy
-from egse.tempcontrol.spid.spid import PidProxy
-
-# This script is triggered when one of the agilent channels violated the rate of change limit.
-# This script is called with the agilent index and channel index as arguments.
-# The corresponding PID channel and heater are turned off.
-
-log = logging.getLogger(__name__)
-logging.basicConfig()
-
-log.info(f'running {__name__}')
-
-parser = ArgumentParser()
-parser.add_argument('hk_name', type=str, help='HK metric name')
-args = parser.parse_args()
-
-setup = load_setup()
-
-bb_proxy = BeagleboneProxy()
-pid_proxy = PidProxy()
-
-if not pid_proxy.is_cs_connected():
-    log.critical(f"Could not connect to PID proxy")
-    sys.exit(f"Could not connect to PID proxy")
-if not bb_proxy.is_cs_connected():
-    log.critical(f"Could not connect to Beaglebone Black proxy")
-    sys.exit(f"Could not connect to Beaglebone Black proxy")
-
-agilent_model = 0 if args.hk_name.split('_')[1] == 'AG34972' else 2
-agilent_num = 0 if int(args.hk_name.split('_')[2]) == 0 else 1
-agilent_channel = int(args.hk_name.split('_')[3][1:])
-daq_num = agilent_model + agilent_num
-
-
-pid_channels = []
-for l in setup.gse.spid.configuration.heaters.values():
-    pid_channels.extend(l)
-
-# Turn off all PID channels controlled by this DAQ and set the heater power to the last value.
-for (pid_channel, agilent_idx, channel_index, beaglebone_idx, beaglebone_ch, _, _, _) in pid_channels:
-
-    if agilent_idx == daq_num and channel_index == agilent_channel:
-        log.info(f"Temperature sensor {agilent_channel} of DAQ {daq_num} was associated to PID channel {pid_channel}")
-        log.info(f"PID channel {pid_channel} was associated with heater {beaglebone_idx} channel {beaglebone_ch}")
-       
-        log.info(f"Turning off PID channel {pid_channel}")
-        # log.debug(f"pid_proxy.disable({pid_channel})")
-        pid_proxy.disable(pid_channel)
-        
-        log.info(f'Disabling heater {beaglebone_idx} channel {beaglebone_ch}')
-        # log.debug(f"bb_proxy.set_enable({beaglebone_idx}, {beaglebone_ch}, False)")
-        bb_proxy.set_enable(beaglebone_idx, beaglebone_ch, False)
-
-
-log.info(f'finished {__name__}')

scripts/fdir/limit_recovery/fdir_bb_heater_limit.py

@@ -1,59 +0,0 @@
-import logging
-from argparse import ArgumentParser
-
-import sys
-
-from egse.setup import load_setup
-from egse.tempcontrol.beaglebone.beaglebone import BeagleboneProxy
-from egse.tempcontrol.spid.spid import PidProxy
-
-# This script is triggered when the resistance of a heater becomes too high (because of pealing).
-# The corresponding PID channel and heater are disabled.
-
-log = logging.getLogger(__name__)
-logging.basicConfig()
-
-log.info(f'running {__name__}')
-
-parser = ArgumentParser()
-parser.add_argument('hk_name', type=str, help="HK metric name")
-args = parser.parse_args()
-
-setup = load_setup()
-
-bb_proxy = BeagleboneProxy()
-pid_proxy = PidProxy()
-
-if not pid_proxy.is_cs_connected():
-    log.critical(f"Could not connect to PID proxy")
-    sys.exit(f"Could not connect to PID proxy")
-if not bb_proxy.is_cs_connected():
-    log.critical(f"Could not connect to Beaglebone Black proxy")
-    sys.exit(f"Could not connect to Beaglebone Black proxy")
-
-agilent_model = 0 if args.hk_name.split('_')[1] == 'AG34972' else 2
-agilent_num = 0 if int(args.hk_name.split('_')[2]) == 0 else 1
-agilent_channel = int(args.hk_name.split('_')[3][1:])
-daq_num = agilent_model + agilent_num
-
-pid_channels = []
-for l in setup.gse.spid.configuration.heaters.values():
-    pid_channels.extend(l)
-
-# Turn off all PID channels controlled by this DAQ and set the heater power to the last value.
-for (pid_channel, agilent_idx, channel_index, beaglebone_idx, beaglebone_ch, _, _, _) in pid_channels:
-
-    if agilent_idx == daq_num and channel_index == agilent_channel:
-        log.info(f"Resistor {agilent_channel} was associated to PID channel {pid_channel}")
-        log.info(f"PID channel {pid_channel} was associated with heater {beaglebone_idx} channel {beaglebone_ch}")
-        
-        log.info(f"Turning off PID channel {pid_channel}")
-        # log.debug(f"pid_proxy.disable({pid_channel})")
-        pid_proxy.disable(pid_channel)
-        
-        log.info(f"Disabling heater {beaglebone_idx} channel {beaglebone_ch}")
-        # log.debug(f"bb_proxy.set_enable({beaglebone_idx}, {beaglebone_ch}, False)")
-        bb_proxy.set_enable(beaglebone_idx, beaglebone_ch, False)
-
-
-log.info(f'finished {__name__}')

scripts/fdir/limit_recovery/fdir_ensemble_limit.py

@@ -1,33 +0,0 @@
-import logging
-
-from egse.setup import load_setup
-from egse.stages.aerotech.ensemble import EnsembleProxy
-
-# This script is triggerend when the gimbal motor tempertature is too high.
-# The gimbal is moved to the resting position and is disabled.
-
-log = logging.getLogger(__name__)
-logging.basicConfig()
-
-log.info(f'running {__name__}')
-
-setup = load_setup()
-
-# Get resting position values from the setup.
-position = setup.gse.ensemble.resting_positions
-
-with EnsembleProxy() as ensemble:
-
-    # Move to resting position.
-    ensemble.move_axes_degrees(position['X'], position['Y'])
-    while ensemble.is_moving():
-        pass
-
-    log.info('moved to resting position')
-
-    # Disable motors.
-    ensemble.disable_axis('X')
-    ensemble.disable_axis('Y')
-    log.info('disabled axes')
-
-log.info(f'finished {__name__}')

scripts/fdir/limit_recovery/fdir_pressure_limit_recovery.py

@@ -1,71 +0,0 @@
-import logging
-import sys
-
-from time import time
-
-from egse.hk import get_housekeeping
-from egse.system import EPOCH_1958_1970
-from egse.vacuum.beaglebone.beaglebone import BeagleboneProxy
-from egse.vacuum.instrutech.igm402 import Igm402Proxy
-# This script is run when the pressure in the vessel is too high.
-# Indicating something wrong with the pump(s) or a leak.
-# First the gate valve is closed. Then the LN2 valve. and finally the IGM402 filament is disabled.
-
-MAXPRESSURE = 1.5E-6
-
-log = logging.getLogger(__name__)
-logging.basicConfig()
-
-log.info(f'Running {__name__}')
-
-# Try to connect to the Beaglebone Valve controller and IGM402 pressure gauge proxy
-
-valves = BeagleboneProxy()
-igm402 = Igm402Proxy()
-if not valves.is_cs_connected():
-    log.critical(f"Could not connect to Beaglebone Black proxy")
-    sys.exit(f"Could not connect to Beaglebone Black proxy")
-if not igm402.is_cs_connected():
-    log.critical(f"Could not connect to IGM402 proxy")
-    sys.exit(f"Could not connect to IGM402 proxy")    
-
-
-# Get the most recent values from the housekeeping
-igm402Timestamp, igm402Value = get_housekeeping("GSRON_IGM402_IG_P") 
-tpg261Timestamp, tpg261Value, = get_housekeeping("GSRON_TPG261_P_1")
-
-igm402Age = time() - (float(igm402Timestamp) - EPOCH_1958_1970)
-tpg261Age = time() - (float(tpg261Timestamp) - EPOCH_1958_1970)
-
-# Ensure that these values are not too old
-if igm402Age > 60:
-    raise Exception(f"IGM402 HK is more than 60 seconds old")
-
-if tpg261Age > 60:
-    raise Exception(f"TPG261 HK is more than 60 seconds old")
-log.info(f"IGM402 - Current value: {igm402Value}, Max: {MAXPRESSURE}")
-log.info(f"TPG261 - Current value: {tpg261Value}, Max: {MAXPRESSURE}")
-
-# Make sure that both pressure gauges are exeecuding their limits
-if float(igm402Value) > float(MAXPRESSURE):
-    if float(tpg261Value) > float(MAXPRESSURE):
-        # Close the gate valve
-        log.info("Closing Gate valve")
-        # log.debug("set_valve, MV001, False")
-        valves.set_valve('MV001', False)
-
-        # Close the LN2 valves
-        log.info("Closing the LN2 valves")
-        for i in range(1, 5):
-            # log.debug(f"set_valve, MV01{i}, False")
-            valves.set_valve(f"MV01{i}", False)
-
-        log.info("Turning off IG filament")
-        # log.debug("set_filament_enable, False")
-        igm402.set_filament_enable(False)
-    else:
-        log.info(f"TPG261 is still in a safe range: {tpg261Value}")
-else:
-    log.info(f"IGM402 is still in a safe range: {igm402Value}")
-    
-log.info(f'Finished {__name__}')

scripts/fix_csv.py

@@ -1,80 +0,0 @@
-"""
-Small script to fix some problems with CSV files.
-
-All the functions are written for a specific problem, you might need to run the script for
-several functions to fix different problems.
-
-Synopsis:
-
-   $ python3 fix_csv.py original_input.csv out.csv --function newlines
-   $ python3 fix_csv.py out.csv out2.csv --function vbar
-
-"""
-def fix_newlines_in_fields(input_file, output_file, delimiter: str = ','):
-    """
-    Sometimes we have seen that a field contains a newline character (usually due to an error
-    in processing the response from a device where the trailing newline was not removed). This
-    function tries to fix that problem.
-
-    Args:
-        input_file: the original CSV file where the problem occurs
-        output_file: the file with the fixed lines
-        delimiter: the delimiter that is used for the CSV [default=',']
-
-    Returns:
-        None.
-    """
-
-    with open(input_file, 'r') as fd:
-        lines = fd.read().split('\n')
-        fixed_lines = []
-        prev_line = None
-
-        for line in lines:
-            if prev_line is None:
-                # We assume the first row in the CSV file has the correct number of fields
-                expected_num_delimiters = line.count(delimiter)
-                prev_line = line
-            elif prev_line.count(delimiter) < expected_num_delimiters:
-                prev_line += line
-            else:
-                fixed_lines.append(prev_line)
-                prev_line = line
-
-        if prev_line is not None:
-            fixed_lines.append(prev_line)
-
-    with open(output_file, 'w', newline='\n') as fd:
-        fd.writelines([f"{x}\n" for x in fixed_lines])
-
-def fix_vertical_bar(input_file, output_file, delimiter: str = ','):
-    """Removes all vertical bar '|' characters from the file."""
-
-    with open(input_file, 'r') as fd:
-        lines = fd.read().split('\n')
-        fixed_lines = [line.replace('|', '') for line in lines]
-
-    with open(output_file, 'w', newline='\n') as fd:
-        fd.writelines([f"{x}\n" for x in fixed_lines])
-
-
-if __name__ == '__main__':
-
-    import argparse
-
-    parser = argparse.ArgumentParser(description="Script to fix several CSV issues")
-
-    parser.add_argument("input_file", help="Path to the input file")
-    parser.add_argument("output_file", help="Path to the output file")
-
-    parser.add_argument('--function', default='newlines', choices=('newlines', 'vbar'),
-                        help="Function to apply to the input file. Default: 'newlines'")
-
-    args = parser.parse_args()
-
-    if args.function == "newlines":
-        fix_newlines_in_fields(args.input_file, args.output_file)
-    elif args.function == "vbar":
-        fix_vertical_bar(args.input_file, args.output_file)
-    else:
-        print(f"Invalid function argument given: {args.function}.")

scripts/ias/correct_ccd_temp_cal_elfique.py

@@ -1,43 +0,0 @@
-import os
-
-from egse.setup import _load_yaml
-from scripts.correct_ccd_cold_temperature_cal import correct_obsid_range, correct_od_range
-
-SITE_ID = "IAS"
-
-
-def correct_elfique(data_dir: str = None):
-    """ Apply correct CCD temperature calibration in the cold.
-
-     The problem was reported in https://github.com/IvS-KULeuven/plato-cgse-conf/issues/403:
-     Correction needed to Cold CCD Temperature Calibration Coefficient
-
-    During the Elfique test campaign, the CCD temperature calibration in the cold was incorrect.
-
-    For all N-FEE HK files of the Elfique test campaign (obsid 1529 - 1754 / OD 20230822 - 20231009), this functions does
-    the following:
-
-        * Make a copy of the original N-FEE HK files (incl. "old" in their filename)
-        * In the original files: Apply the correct CCD temperature calibration in the columns for the calibrated CCD
-          temperatures (in the cold)
-
-    These changes will be applied to the relevant folders in the /obs and /daily sub-folder of the given data folder.
-
-    Args:
-        - data_dir: Full path to the directory in which the data resides.  This is the folder with sub-folders /obs and
-                    /daily, in which the N-FEE HK files are stored.  Default is the content of the
-                    PLATO_DATA_STORAGE_LOCATION environment variable.
-    """
-
-    data_dir = data_dir or os.environ["PLATO_DATA_STORAGE_LOCATION"]
-
-    cal_filename = "yaml//../../common/n-fee/nfee_sensor_calibration_elfique_v2.yaml"
-    sensor_info = _load_yaml(cal_filename).temperatures.CCD_PT1000
-
-    # Correct /obs folder -> https://github.com/IvS-KULeuven/plato-common-egse/issues/2772
-
-    correct_obsid_range(1529, 1754, sensor_info, "elfique", data_dir, SITE_ID)
-
-    # Correct /daily folder -> https://github.com/IvS-KULeuven/plato-common-egse/issues/2772
-
-    correct_od_range(20230822, 20231009, sensor_info, data_dir, SITE_ID)

scripts/ias/correct_ccd_temp_cal_floreffe.py

@@ -1,43 +0,0 @@
-import os
-
-from egse.setup import _load_yaml
-from scripts.correct_ccd_cold_temperature_cal import correct_obsid_range, correct_od_range
-
-SITE_ID = "IAS"
-
-
-def correct_floreffe(data_dir: str = None):
-    """ Apply correct CCD temperature calibration in the cold.
-
-     The problem was reported in https://github.com/IvS-KULeuven/plato-cgse-conf/issues/403:
-     Correction needed to Cold CCD Temperature Calibration Coefficient
-
-    During the Floreffe test campaign, the CCD temperature calibration in the cold was incorrect.
-
-    For all N-FEE HK files of the Floreffe test campaign (obsid 1755 - 1896 / OD 20231027 - 20231117), this functions
-    does the following:
-
-        * Make a copy of the original N-FEE HK files (incl. "old" in their filename)
-        * In the original files: Apply the correct CCD temperature calibration in the columns for the calibrated CCD
-          temperatures (in the cold)
-
-    These changes will be applied to the relevant folders in the /obs and /daily sub-folder of the given data folder.
-
-    Args:
-        - data_dir: Full path to the directory in which the data resides.  This is the folder with sub-folders /obs and
-                    /daily, in which the N-FEE HK files are stored.  Default is the content of the
-                    PLATO_DATA_STORAGE_LOCATION environment variable.
-    """
-
-    data_dir = data_dir or os.environ["PLATO_DATA_STORAGE_LOCATION"]
-
-    cal_filename = "yaml//../../common/n-fee/nfee_sensor_calibration_floreffe_v2.yaml"
-    sensor_info = _load_yaml(cal_filename).temperatures.CCD_PT1000
-
-    # Correct /obs folder -> https://github.com/IvS-KULeuven/plato-common-egse/issues/2773
-
-    correct_obsid_range(1755, 1896, sensor_info, "floreffe", data_dir, SITE_ID)
-
-    # Correct /daily folder -> https://github.com/IvS-KULeuven/plato-common-egse/issues/2773
-
-    correct_od_range(20231027, 20231117, sensor_info, data_dir, SITE_ID)