pychemstation 0.4.7.dev1__py3-none-any.whl

hein_analytical_control/devices/Agilent/chromatogram.py

@@ -0,0 +1,129 @@
+"""Module for HPLC chromatogram data loading and manipulating"""
+
+import os
+import logging
+import time
+
+import numpy as np
+
+from .chemstation import CHFile
+
+from ...analysis import AbstractSpectrum
+
+# Chemstation data path
+DATA_DIR = r"C:\Chem32\1\Data"
+
+
+# standard filenames for spectral data
+CHANNELS = {"A": "01", "B": "02", "C": "03", "D": "04"}
+
+ACQUISITION_PARAMETERS = "acq.txt"
+
+# format used in acquisition parameters
+TIME_FORMAT = "%Y-%m-%d-%H-%M-%S"
+
+
+class AgilentHPLCChromatogram(AbstractSpectrum):
+    """Class for HPLC spectrum (chromatogram) loading and handling."""
+
+    AXIS_MAPPING = {"x": "min", "y": "mAu"}
+
+    INTERNAL_PROPERTIES = {
+        "baseline",
+        "parameters",
+        "data_path",
+    }
+
+    # set of properties to be saved
+    PUBLIC_PROPERTIES = {
+        "x",
+        "y",
+        "peaks",
+        "timestamp",
+    }
+
+    def __init__(self, path=None, autosaving=False):
+
+        if path is not None:
+            os.makedirs(path, exist_ok=True)
+            self.path = path
+        else:
+            self.path = os.path.join(".", "hplc_data")
+            os.makedirs(self.path, exist_ok=True)
+
+        self.logger = logging.getLogger("AgilentHPLCChromatogram")
+
+        super().__init__(path=path, autosaving=autosaving)
+
+    def load_spectrum(self, data_path, channel="A"):
+        """Loads the spectra from the given folder.
+
+        Args:
+            data_path (str): Path where HPLC data has been saved.
+        """
+
+        # to avoid dropping parameters when called in parent class
+        if self.x is not None:
+            if self.autosaving:
+                self.save_data(filename=f"{data_path}_{channel}")
+                self._dump()
+
+        # get raw data
+        x, y = self.extract_rawdata(data_path, channel)
+
+        # get timestamp
+        tstr = data_path.split(".")[0].split("_")[-1]
+        timestamp = time.mktime(time.strptime(tstr, TIME_FORMAT))
+
+        # loading all data
+        super().load_spectrum(x, y, timestamp)
+
+    ### PUBLIC METHODS TO LOAD RAW DATA ###
+
+    def extract_rawdata(self, experiment_dir: str, channel: str):
+        """
+        Reads raw data from Chemstation .CH files.
+
+        Args:
+            experiment_dir: .D directory with the .CH files
+
+        Returns:
+            np.array(times), np.array(values)   Raw chromatogram data
+        """
+        filename = os.path.join(experiment_dir, f"DAD1{channel}")
+        npz_file = filename + ".npz"
+
+        if os.path.exists(npz_file):
+            # already processed
+            data = np.load(npz_file)
+            return data["times"], data["values"]
+        else:
+            self.logger.debug("NPZ file not found. First time loading data.")
+            ch_file = filename + ".ch"
+            data = CHFile(ch_file)
+            np.savez_compressed(npz_file, times=data.times, values=data.values)
+            return np.array(data.times), np.array(data.values)
+
+    def extract_peakarea(self, experiment_dir: str):
+        """
+        Reads processed data from Chemstation report files.
+
+        Args:
+            experiment_dir: .D directory with the report files
+        """
+        # filename = os.path.join(experiment_dir, f"REPORT{CHANNELS[channel]}.csv")
+        # TODO parse file properly
+        # data = np.genfromtxt(filename, delimiter=',')
+        # return data
+        pass
+
+    def default_processing(self):
+        """
+        Processes the chromatogram in place.
+        """
+        # trim first 5 min and last 3 min of run
+        self.trim(5, 25)
+        # parameters found to work best for chromatogram data
+        self.correct_baseline(lmbd=1e5, p=0.0001, n_iter=10)
+        # get all peaks in processed chromatogram
+        self.find_peaks()

hein_analytical_control/devices/Agilent/hplc.py

@@ -0,0 +1,436 @@
+"""
+Module to provide API for the remote control of the Agilent HPLC systems.
+
+HPLCController sends commands to Chemstation software via a command file.
+Answers are received via reply file. On the Chemstation side, a custom
+Macro monitors the command file, executes commands and writes to the reply file.
+Each command is given a number (cmd_no) to keep track of which commands have
+been processed.
+
+Authors: Alexander Hammer, Hessam Mehr, Lucy Hao
+"""
+
+import logging
+import os
+import time
+from typing import Union
+
+import polling
+from xsdata.formats.dataclass.parsers import XmlParser
+
+from .chromatogram import AgilentHPLCChromatogram, TIME_FORMAT
+from .hplc_param_types import Command, HPLCAvailStatus, HPLCMethodParams, HPLCRunningStatus, HPLCErrorStatus, Param, \
+    str_to_status, PType, MethodTimetable, Entry, RegisterFlag
+from ...generated import PumpMethod, DadMethod
+
+# maximum command number
+MAX_CMD_NO = 255
+
+
+class HPLCController:
+    """
+    Class to control Agilent HPLC systems via Chemstation Macros.
+    """
+
+    def __init__(
+            self,
+            comm_dir: str,
+            data_dir: str,
+            method_dir: str,
+            cmd_file: str = "cmd",
+            reply_file: str = "reply",
+    ):
+        """Initialize HPLC controller. The `hplc_talk.mac` macro file must be loaded in the Chemstation software.
+        `comm_dir` must match the file path in the macro file.
+        
+        :param comm_dir: Name of directory for communication, where ChemStation will read and write from. Can be any existing directory.
+        :param data_dir: Name of directory that ChemStation saves run data. Must be accessible by ChemStation.
+        :param cmd_file: Name of command file
+        :param reply_file: Name of reply file
+        :raises FileNotFoundError: If either `data_dir`, `method_dir` or `comm_dir` is not a valid directory.
+        """
+        if os.path.isdir(comm_dir):
+            self.cmd_file = os.path.join(comm_dir, cmd_file)
+            self.reply_file = os.path.join(comm_dir, reply_file)
+            self.cmd_no = 0
+        else:
+            raise FileNotFoundError(f"comm_dir: {comm_dir} not found.")
+        self._most_recent_hplc_status = None
+
+        if os.path.isdir(data_dir):
+            self.data_dir = data_dir
+        else:
+            raise FileNotFoundError(f"data_dir: {data_dir} not found.")
+
+        if os.path.isdir(method_dir):
+            self.method_dir = method_dir
+        else:
+            raise FileNotFoundError(f"method_dir: {method_dir} not found.")
+
+        self.spectra = {
+            "A": AgilentHPLCChromatogram(self.data_dir),
+            "B": AgilentHPLCChromatogram(self.data_dir),
+            "C": AgilentHPLCChromatogram(self.data_dir),
+            "D": AgilentHPLCChromatogram(self.data_dir),
+        }
+
+        self.data_files: list[str] = []
+
+        # Create files for Chemstation to communicate with Python
+        open(self.cmd_file, "a").close()
+        open(self.reply_file, "a").close()
+
+        self.logger = logging.getLogger("hplc_logger")
+        self.logger.addHandler(logging.NullHandler())
+
+        self.reset_cmd_counter()
+
+        self.logger.info("HPLC Controller initialized.")
+
+    def _set_status(self):
+        """Updates current status of HPLC machine"""
+        self._most_recent_hplc_status = self.status()[0]
+
+    def _check_data_status(self) -> bool:
+        """Checks if HPLC machine is in an available state, meaning a state that data is not being written.
+
+        :return: whether the HPLC machine is in a safe state to retrieve data back."""
+        old_status = self._most_recent_hplc_status
+        self._set_status()
+        file_exists = os.path.exists(self.data_files[-1]) if len(self.data_files) > 0 else False
+        done_writing_data = isinstance(self._most_recent_hplc_status,
+                                       HPLCAvailStatus) and old_status != self._most_recent_hplc_status and file_exists
+        return done_writing_data
+
+    def check_hplc_ready_with_data(self) -> bool:
+        """Checks if ChemStation has finished writing data and can be read back.
+
+        :param method: if you are running a method and want to read back data, the timeout period will be adjusted to be longer than the method's runtime
+
+        :return: Return True if data can be read back, else False.
+        """
+        self._set_status()
+
+        timeout = 10 * 60
+        hplc_run_done = polling.poll(
+            lambda: self._check_data_status(),
+            timeout=timeout,
+            step=30
+        )
+
+        return hplc_run_done
+
+    def _send(self, cmd: str, cmd_no: int, num_attempts=5) -> None:
+        """Low-level execution primitive. Sends a command string to HPLC.
+
+        :param cmd: string to be sent to HPLC
+        :param cmd_no: Command number
+        :param num_attempts: Number of attempts to send the command before raising exception.
+        :raises IOError: Could not write to command file.
+        """
+        err = None
+        for _ in range(num_attempts):
+            time.sleep(1)
+            try:
+                with open(self.cmd_file, "w", encoding="utf8") as cmd_file:
+                    cmd_file.write(f"{cmd_no} {cmd}")
+            except IOError as e:
+                err = e
+                self.logger.warning("Failed to send command; trying again.")
+                continue
+            else:
+                self.logger.info("Sent command #%d: %s.", cmd_no, cmd)
+                return
+        else:
+            raise IOError(f"Failed to send command #{cmd_no}: {cmd}.") from err
+
+    def _receive(self, cmd_no: int, num_attempts=100) -> str:
+        """Low-level execution primitive. Recives a response from HPLC.
+
+        :param cmd_no: Command number
+        :param num_attempts: Number of retries to open reply file
+        :raises IOError: Could not read reply file.
+        :return: ChemStation response 
+        """
+        err = None
+        for _ in range(num_attempts):
+            time.sleep(1)
+
+            try:
+                with open(self.reply_file, "r", encoding="utf_16") as reply_file:
+                    response = reply_file.read()
+            except OSError as e:
+                err = e
+                self.logger.warning("Failed to read from reply file; trying again.")
+                continue
+
+            try:
+                first_line = response.splitlines()[0]
+                response_no = int(first_line.split()[0])
+            except IndexError as e:
+                err = e
+                self.logger.warning("Malformed response %s; trying again.", response)
+                continue
+
+            # check that response corresponds to sent command
+            if response_no == cmd_no:
+                self.logger.info("Reply: \n%s", response)
+                return response
+            else:
+                self.logger.warning(
+                    "Response #: %d != command #: %d; trying again.",
+                    response_no,
+                    cmd_no,
+                )
+                continue
+        else:
+            raise IOError(f"Failed to receive reply to command #{cmd_no}.") from err
+
+    def send(self, cmd: Union[Command, str]):
+        """Sends a command to Chemstation.
+
+        :param cmd: Command to be sent to HPLC
+        """
+        if self.cmd_no == MAX_CMD_NO:
+            self.reset_cmd_counter()
+
+        cmd_to_send: str = cmd.value if isinstance(cmd, Command) else cmd
+        self.cmd_no += 1
+        self._send(cmd_to_send, self.cmd_no)
+
+    def receive(self) -> str:
+        """Returns messages received in reply file.
+
+        :return: ChemStation response 
+        """
+        return self._receive(self.cmd_no)
+
+    def reset_cmd_counter(self):
+        """Resets the command counter."""
+        self._send(Command.RESET_COUNTER_CMD.value, cmd_no=MAX_CMD_NO + 1)
+        self._receive(cmd_no=MAX_CMD_NO + 1)
+        self.cmd_no = 0
+
+        self.logger.debug("Reset command counter")
+
+    def sleep(self, seconds: int):
+        """Tells the HPLC to wait for a specified number of seconds.
+
+        :param seconds: number of seconds to wait
+        """
+        self.send(Command.SLEEP_CMD.value.format(seconds=seconds))
+        self.logger.debug("Sleep command sent.")
+
+    def standby(self):
+        """Switches all modules in standby mode. All lamps and pumps are switched off."""
+        self.send(Command.STANDBY_CMD)
+        self.logger.debug("Standby command sent.")
+
+    def preprun(self):
+        """ Prepares all modules for run. All lamps and pumps are switched on."""
+        self.send(Command.PREPRUN_CMD)
+        self.logger.debug("PrepRun command sent.")
+
+    def status(self) -> list[Union[HPLCRunningStatus, HPLCAvailStatus, HPLCErrorStatus]]:
+        """Get device status(es).
+
+        :return: list of ChemStation's current status
+        """
+        self.send(Command.GET_STATUS_CMD)
+        time.sleep(1)
+
+        try:
+            parsed_response = self.receive().splitlines()[1].split()[1:]
+        except IOError:
+            return [HPLCErrorStatus.NORESPONSE]
+        except IndexError:
+            return [HPLCErrorStatus.MALFORMED]
+        recieved_status = [str_to_status(res) for res in parsed_response]
+        self._most_recent_hplc_status = recieved_status[0]
+        return recieved_status
+
+    def stop_macro(self):
+        """Stops Macro execution. Connection will be lost."""
+        self.send(Command.STOP_MACRO_CMD)
+
+    def update_method(self):
+        pass
+
+    def edit_method_timetable(self):
+        pass
+
+    def _update_method_timetable(self):
+        pass
+
+    def _update_method_param(self, method_param: Param):
+        """Change a method parameter.
+
+        :param method_param: a parameter to update for currently loaded method
+        """
+
+        setting_command = "SetObjHdrVal" if method_param.ptype == PType.NUM else "SetObjHdrText"
+        if isinstance(method_param.chemstation_key, list):
+            for register in method_param.chemstation_key:
+                self.send(
+                    f'{setting_command} RCPMP1Method[1], {register}, {method_param.val}'
+                )
+        else:
+            self.send(
+                f'{setting_command} RCPMP1Method[1], {method_param.chemstation_key}, {method_param.val}'
+            )
+        time.sleep(2)
+
+    def desired_method_already_loaded(self, method_name: str) -> bool:
+        """Checks if a given method is already loaded into Chemstation. Method name does not need the ".M" extension.
+
+        :param method_name: a Chemstation method
+        :return: True if method is already loaded
+        """
+        self.send(Command.GET_METHOD_CMD)
+        parsed_response = self.receive().splitlines()[1].split()[1:][0]
+        return method_name in parsed_response
+
+    def switch_method(self, method_name: str):
+        """Allows the user to switch between pre-programmed methods. No need to append '.M'
+        to the end of the method name. For example. for the method named 'General-Poroshell.M',
+        only 'General-Poroshell' is needed.
+
+        :param method_name: any available method in Chemstation method directory
+        :raise IndexError: Response did not have expected format. Try again.
+        :raise AssertionError: The desired method is not selected. Try again.
+        """
+        self.send(
+            Command.SWITCH_METHOD_CMD.value.format(method_dir=self.method_dir, method_name=method_name)
+        )
+
+        time.sleep(2)
+        self.send(Command.GET_METHOD_CMD)
+        time.sleep(2)
+        # check that method switched
+        for _ in range(10):
+            try:
+                parsed_response = self.receive().splitlines()[1].split()[1:][0]
+                break
+            except IndexError:
+                self.logger.debug("Malformed response. Trying again.")
+                continue
+
+        assert parsed_response == f"{method_name}.M", "Switching Methods failed."
+
+    def load_method_details(self, method_name: str) -> MethodTimetable:
+        """Retrieve method details of an existing method. Don't need to append ".M" to the end. This assumes the
+        organic modifier is in Channel B and that Channel A contains the aq layer. Additionally, assumes
+         only two solvents are being used.
+
+        :param method_name: name of method to load details of
+        :raises FileNotFoundError: Method does not exist
+        :return: method details
+        """
+        method_path = os.path.join(self.method_dir, "AgilentPumpDriver1.RapidControl.MethodXML.xml")
+        dad_path = os.path.join(self.method_dir, "Agilent1200erDadDriver1.RapidControl.MethodXML.xml")
+
+        if os.path.exists(os.path.join(self.method_dir, f"{method_name}.M")):
+            parser = XmlParser()
+            method = parser.parse(method_path, PumpMethod)
+            dad = parser.parse(dad_path, DadMethod)
+
+            organic_modifier = None
+            aq_modifier = None
+
+            if len(method.solvent_composition.solvent_element) == 2:
+                for solvent in method.solvent_composition.solvent_element:
+                    if solvent.channel == "Channel_A":
+                        aq_modifier = solvent
+                    elif solvent.channel == "Channel_B":
+                        organic_modifier = solvent
+
+            return MethodTimetable(
+                first_row=HPLCMethodParams(
+                    organic_modifier=Param(val=organic_modifier.percentage,
+                                           chemstation_key=RegisterFlag.SOLVENT_B_COMPOSITION,
+                                           ptype=PType.NUM),
+                    flow=Param(val=method.flow,
+                               chemstation_key=RegisterFlag.FLOW,
+                               ptype=PType.NUM),
+                    maximum_run_time=Param(val=method,
+                                           chemstation_key=RegisterFlag.MAX_TIME,
+                                           ptype=PType.NUM),
+                    temperature=Param(val=None,
+                                      chemstation_key=[RegisterFlag.COLUMN_OVEN_TEMP1,
+                                                       RegisterFlag.COLUMN_OVEN_TEMP2],
+                                      ptype=PType.NUM),
+                    inj_vol=Param(val=None,
+                                  chemstation_key=None,
+                                  ptype=PType.NUM),
+                    equ_time=Param(val=None,
+                                   chemstation_key=None,
+                                   ptype=PType.NUM)),
+                subsequent_rows=[
+                    Entry(
+                        start_time=tte.time,
+                        organic_modifer=tte.percent_b,
+                        flow=method.flow
+                    ) for tte in method.timetable.timetable_entry
+                ],
+                dad_wavelengthes=dad.signals.signal,
+                organic_modifier=organic_modifier,
+                modifier_a=aq_modifier
+            )
+        else:
+            raise FileNotFoundError
+
+    def lamp_on(self):
+        """Turns the UV lamp on."""
+        self.send(Command.LAMP_ON_CMD)
+
+    def lamp_off(self):
+        """Turns the UV lamp off."""
+        self.send(Command.LAMP_OFF_CMD)
+
+    def pump_on(self):
+        """Turns on the pump on."""
+        self.send(Command.PUMP_ON_CMD)
+
+    def pump_off(self):
+        """Turns the pump off."""
+        self.send(Command.PUMP_OFF_CMD)
+
+    def start_method(self):
+        """Starts and executes currently loaded method to run according to Run Time Checklist. Device must be ready."""
+        self.send(Command.START_METHOD_CMD)
+
+    def run_method(self, experiment_name: str):
+        """This is the preferred method to trigger a run.
+        Starts the currently selected method, storing data
+        under the <data_dir>/<experiment_name>.D folder.
+        The should <experiment_name> end with a timestamp in the '%Y-%m-%d-%H-%M' format.
+        Device must be ready.
+
+        :param experiment_name: Name of the experiment
+        """
+        timestamp = time.strftime(TIME_FORMAT)
+
+        self.send(
+            Command.RUN_METHOD_CMD.value.format(
+                data_dir=self.data_dir, experiment_name=experiment_name, timestamp=timestamp
+            )
+        )
+
+        folder_name = f"{experiment_name}_{timestamp}.D"
+        self.data_files.append(os.path.join(self.data_dir, folder_name))
+        self.logger.info("Started HPLC run:  %s.", folder_name)
+
+    def stop_method(self):
+        """Stops the run. A dialog window will pop up and manual intervention may be required."""
+        self.send(Command.STOP_METHOD_CMD)
+
+    def get_spectrum(self):
+        """ Load last chromatogram for any channel in spectra dictionary."""
+        last_file = self.data_files[-1] if len(self.data_files) > 0 else None
+
+        if last_file is None:
+            raise IndexError
+
+        for channel, spec in self.spectra.items():
+            spec.load_spectrum(data_path=last_file, channel=channel)
+            self.logger.info("%s chromatogram loaded.", channel)

hein_analytical_control/devices/Agilent/hplc_param_types.py

@@ -0,0 +1,141 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Union, Any
+
+from ...generated import SolventElement, Signal
+
+
+# Commands sent to the Chemstation Macro
+# See https://www.agilent.com/cs/library/usermanuals/Public/MACROS.PDF
+class Command(Enum):
+    def __str__(self):
+        return '%s' % self.value
+
+    RESET_COUNTER_CMD = "last_cmd_no = 0"
+    GET_STATUS_CMD = "response$ = AcqStatus$"
+    SLEEP_CMD = "Sleep {seconds}"
+    STANDBY_CMD = "Standby"
+    STOP_MACRO_CMD = "Stop"
+    PREPRUN_CMD = "PrepRun"
+    LAMP_ON_CMD = "LampAll ON"
+    LAMP_OFF_CMD = "LampAll OFF"
+    PUMP_ON_CMD = "PumpAll ON"
+    PUMP_OFF_CMD = "PumpAll OFF"
+    GET_METHOD_CMD = "response$ = _MethFile$"
+    SWITCH_METHOD_CMD = 'LoadMethod "{method_dir}", "{method_name}.M"'
+    START_METHOD_CMD = "StartMethod"
+    RUN_METHOD_CMD = 'RunMethod "{data_dir}",, "{experiment_name}_{timestamp}"'
+    STOP_METHOD_CMD = "StopMethod"
+    UPDATE_METHOD_CMD = 'UpdateMethod'
+
+
+class RegisterFlag(Enum):
+    def __str__(self):
+        return '%s' % self.value
+
+    SOLVENT_A_COMPOSITION = "PumpChannel_CompositionPercentage"
+    SOLVENT_B_COMPOSITION = "PumpChannel2_CompositionPercentage"
+    SOLVENT_C_COMPOSITION = "PumpChannel3_CompositionPercentage"
+    SOLVENT_D_COMPOSITION = "PumpChannel4_CompositionPercentage"
+    FLOW = "Flow"
+    MAX_TIME = "StopTime_Time"
+    COLUMN_OVEN_TEMP1 = "TemperatureControl_Temperature"
+    COLUMN_OVEN_TEMP2 = "TemperatureControl2_Temperature"
+    STOPTIME_MODE = "StopTime_Mode"
+    POSTIME_MODE = "PostTime_Mode"
+
+
+class MethodTableOperation(Enum):
+    def __str__(self):
+        return '%s' % self.value
+
+    DELETE_TABLE = 'DelTab RCPMP1Method[1], "Timetable"'
+    CREATE_TABLE = 'NewTab RCPMP1Method[1], "Timetable"'
+    NEW_ROW = 'InsTabRow RCPMP1Method[1], "Timetable"'
+    NEW_COLUMN = ""
+    DOWNLOAD_TABLE = ""
+
+
+class PType(Enum):
+    STR = "str"
+    NUM = "num"
+
+
+@dataclass
+class Param:
+    ptype: PType
+    val: Union[float, int, str, Any]
+    chemstation_key: Union[RegisterFlag, list[RegisterFlag]]
+
+
+@dataclass
+class HPLCMethodParams:
+    organic_modifier: Param
+    flow: Param
+    temperature: Param
+    inj_vol: Param
+    equ_time: Param
+    maximum_run_time: Param
+
+
+@dataclass
+class Entry:
+    start_time: float
+    organic_modifer: float
+    flow: float
+
+
+@dataclass
+class MethodTimetable:
+    first_row: HPLCMethodParams
+    subsequent_rows: list[Entry]
+    dad_wavelengthes: list[Signal]
+    organic_modifier: SolventElement
+    modifier_a: SolventElement
+
+
+class HPLCRunningStatus(Enum):
+    @classmethod
+    def has_member_key(cls, key):
+        return key in cls.__members__
+
+    INJECTING = "INJECTING"
+    PREPARING = "PREPARING"
+    RUN = "RUN"
+    NOTREADY = "NOTREADY"
+    POSTRUN = "POSTRUN"
+    RAWDATA = "RAWDATA"
+    INITIALIZING = "INITIALIZING"
+    NOMODULE = "NOMODULE"
+
+
+class HPLCAvailStatus(Enum):
+    @classmethod
+    def has_member_key(cls, key):
+        return key in cls.__members__
+
+    PRERUN = "PRERUN"
+    OFFLINE = "OFFLINE"
+    STANDBY = "STANDBY"
+
+
+class HPLCErrorStatus(Enum):
+
+    @classmethod
+    def has_member_key(cls, key):
+        return key in cls.__members__
+
+    ERROR = "ERROR"
+    BREAK = "BREAK"
+    NORESPONSE = "NORESPONSE"
+    MALFORMED = "MALFORMED"
+
+
+def str_to_status(status: str) -> Union[HPLCAvailStatus, HPLCErrorStatus, HPLCRunningStatus]:
+    if HPLCErrorStatus.has_member_key(status):
+        return HPLCErrorStatus[status]
+    if HPLCRunningStatus.has_member_key(status):
+        return HPLCRunningStatus[status]
+    if HPLCAvailStatus.has_member_key(status):
+        return HPLCAvailStatus[status]
+    raise KeyError(status)