vfWorks 0.0.1__py3-none-any.whl

vfworks/DSLs/specificationModel/parser/parser.py

@@ -0,0 +1,24 @@
+#***************************************************************************************
+# * Copyright (C) 2024-present Bert Van Acker (UAntwerpen) <Bert.VanAcker@uantwerpen.be>
+# *
+# * This file is part of the vfWorks project.
+# *
+# * vfWorks can not be copied and/or distributed without the express
+# * permission of Bert Van Acker
+# **************************************************************************************
+import os
+
+from textx import metamodel_from_file
+
+class Specification_parser(object):
+    def __init__(self, specificationModel):
+        self._specificationModel = specificationModel
+
+        currentDir = os.path.dirname(os.path.abspath(__file__))
+        metamodelPath = os.path.join(currentDir,'..','grammar/specificationModel.tx')
+        self._specificationModel_metamodel = metamodel_from_file(metamodelPath)
+
+    def parse(self):
+        specificationModel = self._specificationModel_metamodel.model_from_file(self._specificationModel)
+        return specificationModel
+

vfworks/__init__.py

@@ -0,0 +1,23 @@
+#***************************************************************************************
+# * Copyright (C) 2024-present Bert Van Acker (UAntwerpen) <Bert.VanAcker@uantwerpen.be>
+# *
+# * This file is part of the vfWorks project.
+# *
+# * vfWorks can not be copied and/or distributed without the express
+# * permission of Bert Van Acker
+# **************************************************************************************
+
+VERSION = (0, 0, "1")
+__version__ = ".".join([str(s) for s in VERSION])
+
+__title__ = "vfWorks"
+__description__ = (
+    "vfWorks - your gateway to valid model (re-)use."
+)
+__url__ = "https://vfworks.readthedocs.io/en/latest/index.html"
+
+__author__ = "Jan Gladiné & Bert Van Acker"
+__email__ = "Jan.Gladine@uantwerpen.be"
+
+__license__ = "Apache License 2.0"
+__copyright__ = "Copyright 2024"

vfworks/__main__.py

@@ -0,0 +1,19 @@
+#***************************************************************************************
+# * Copyright (C) 2024-present Bert Van Acker (UAntwerpen) <Bert.VanAcker@uantwerpen.be>
+# *
+# * This file is part of the vfWorks project.
+# *
+# * vfWorks can not be copied and/or distributed without the express
+# * permission of Bert Van Acker
+# **************************************************************************************
+
+import click
+
+from vfworks.commands.version import versionCmds
+
+
+cli=click.CommandCollection(sources=[versionCmds],help="vfWorks command line tool")
+
+
+if __name__ == '__main__':
+    cli()

vfworks/clientLibraries/vfclpy/data_digest/digest.py

@@ -0,0 +1,152 @@
+#***************************************************************************************
+# * Copyright (C) 2024-present Bert Van Acker (UAntwerpen) <Bert.VanAcker@uantwerpen.be>
+# *
+# * This file is part of the vfWorks project.
+# *
+# * vfWorks can not be copied and/or distributed without the express
+# * permission of Bert Van Acker
+# **************************************************************************************
+import yaml
+import os
+from os import mkdir
+from os.path import exists, dirname, join, isfile
+import logging
+from vfworks.clientLibraries.vfclpy.data_platform import *
+from vfworks.metamodels.experiment import *
+from vfworks.utils.auxiliary import *
+
+class remoteExperiments(object):
+    def __init__(self, config,VFName,verbose=False):
+        self.config = self.load_config(config)
+        self.logger = self.initialize_logger()
+        self.data_platform = self._initialize_data_platform()  # Initialize knowledge within the component
+
+        probe_config = VFName
+        self.base_key = f"{VFName}:Experiments"
+
+        #----------------INSTANTIATE EXPERIMENTS---------------------
+        self.experiments = []
+
+
+    def load_config(self, config_file):
+        with open(config_file, 'r') as file:
+            return yaml.safe_load(file)
+
+    def initialize_logger(self):
+        """Initialize the logger (same as before)."""
+        log_config = self.config.get("logging", {})
+        logger = logging.getLogger(self.__class__.__name__)
+        log_level = log_config.get("level", "INFO").upper()
+        logger.setLevel(getattr(logging, log_level, logging.INFO))
+
+        log_format = log_config.get("format", "%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+        log_file = log_config.get("file", None)
+
+        formatter = logging.Formatter(log_format)
+
+        if log_file:
+            file_handler = logging.FileHandler(log_file)
+            file_handler.setFormatter(formatter)
+            logger.addHandler(file_handler)
+        else:
+            console_handler = logging.StreamHandler()
+            console_handler.setFormatter(formatter)
+            logger.addHandler(console_handler)
+
+        return logger
+
+    def _initialize_data_platform(self):
+        """Initialize the data plaform object based on the config."""
+        #self.logger.info(f"Initializing the data platform.")
+        return DataPlatform(config=self.config['dp_config'])
+
+    def loadExperiments(self, measerementStorage = "full",timestamped=False):             # full => both in the datapoints and csv | csv => store only csv file
+        timestamp = None
+        experimentIDs = self._getExperimentIDs()
+
+        for experiment in experimentIDs:
+            # instantiate an empty experiment
+            label = self.data_platform.read(self.base_key + ":" + experiment + ":label")
+            exp = Experiment(name=experiment, description="tbd", label=label)
+            # fetch all conditions
+            conditionIDs = self._getConditionIDs(experimentID=experiment)
+            for condition in conditionIDs:
+                key = self.base_key + ":" + experiment + ":Conditions:" + condition
+                value = self.data_platform.read(key)
+                exp.addCondition(ExperimentCondition(name=condition, value=value))
+            measurementIDs = self._getMeasurementIDs(experimentID=experiment)
+            for measurement in measurementIDs:
+                key = self.base_key + ":" + experiment + ":Measurements:" + measurement
+                dataPoints=self.data_platform.read_list(key,all=True)
+                if measurement!= "timestamp":
+                    reference = "Experiments/" + experiment +"/"+ measurement+".csv"
+                    if measerementStorage=="full":
+                        exp.addMeasurement(Measurement(name=measurement,dataPoints=dataPoints,reference=reference))
+                    else:
+                        exp.addMeasurement(Measurement(name=measurement, dataPoints=[], reference=reference))
+                else:
+                    key = self.base_key + ":" + experiment + ":Measurements:" + measurement
+                    timestamp = self.data_platform.read_list(key, all=True)
+
+            for measurement in measurementIDs:
+                key = self.base_key + ":" + experiment + ":Measurements:" + measurement
+                dataPoints = self.data_platform.read_list(key, all=True)
+                #CREATE FOLDER IF NON EXISTING
+                path = "Experiments/" + experiment
+                if not exists(path):
+                    mkdir(path)
+
+                reference = path + "/" + measurement + ".csv"
+                if timestamped:
+                    save_lists_to_csv(reference, timestamp, dataPoints,headers=['timestamp', measurement])
+                else:
+                    save_lists_to_csv(reference, dataPoints, headers=[measurement])
+            #TODO: STORE THE MEASUREMENTS AS FILES AND REFERENCE!
+            self.experiments.append(exp)
+            self.logger.info(msg="experiment added to the VF frame, GUID {"+exp.GUID+"}")
+        return self.experiments
+
+
+    def _getExperimentIDs(self):
+        """Get the experiment from the vfWorks backend"""
+        unique_values = set()
+        keys = self.data_platform.getKeys(self.base_key+":*")
+        for key in keys:
+            try:
+                value = key.split('Experiments:')[1].split(":")[0]
+                unique_values.add(value)
+            except IndexError:
+                print(f"Skipping key due to formatting issue: {key}")
+
+
+        return  list(unique_values)
+
+    def _getConditionIDs(self, experimentID):
+        """Get the experiment from the vfWorks backend"""
+        unique_values = set()
+        keys = self.data_platform.getKeys(self.base_key+":"+experimentID+":Conditions:*")
+        for key in keys:
+            try:
+                value = key.split('Conditions:')[1]
+                unique_values.add(value)
+            except IndexError:
+                print(f"Skipping key due to formatting issue: {key}")
+        return  list(unique_values)
+
+    def _getMeasurementIDs(self, experimentID):
+        """Get the experiment from the vfWorks backend"""
+        unique_values = set()
+        keys = self.data_platform.getKeys(self.base_key+":"+experimentID+":Measurements:*")
+        for key in keys:
+            try:
+                value = key.split('Measurements:')[1]
+                unique_values.add(value)
+            except IndexError:
+                print(f"Skipping key due to formatting issue: {key}")
+        return  list(unique_values)
+
+
+
+
+
+

vfworks/clientLibraries/vfclpy/data_forwarders/experiment.py

@@ -0,0 +1,108 @@
+#***************************************************************************************
+# * Copyright (C) 2024-present Bert Van Acker (UAntwerpen) <Bert.VanAcker@uantwerpen.be>
+# *
+# * This file is part of the vfWorks project.
+# *
+# * vfWorks can not be copied and/or distributed without the express
+# * permission of Bert Van Acker
+# **************************************************************************************
+import yaml
+import struct
+import logging
+from vfworks.clientLibraries.vfclpy.data_platform import *
+
+class Experiment(object):
+    def __init__(self, config, ID="EXP_001", label="nominal", verbose=False):
+        self.ID = ID
+        self.config = self.load_config(config)
+        self.logger = self.initialize_logger()
+        self.data_platform = self._initialize_data_platform()  # Initialize knowledge within the component
+
+        probe_config = self.config.get("validityframe", {})
+        self.base_key = f"{probe_config.get('name', 'base')}:Experiments"
+        self.experiment_key = self.base_key+":"+ID
+        self.conditions_key = self.experiment_key+":"+"Conditions"
+        self.measurements_key = self.experiment_key + ":" + "Measurements"
+
+        # set experiment label
+        self.addLabel(label=label)
+
+    def load_config(self, config_file):
+        with open(config_file, 'r') as file:
+            return yaml.safe_load(file)
+
+    def initialize_logger(self):
+        """Initialize the logger (same as before)."""
+        log_config = self.config.get("logging", {})
+        logger = logging.getLogger(self.__class__.__name__)
+        log_level = log_config.get("level", "INFO").upper()
+        logger.setLevel(getattr(logging, log_level, logging.INFO))
+
+        log_format = log_config.get("format", "%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+        log_file = log_config.get("file", None)
+
+        formatter = logging.Formatter(log_format)
+
+        if log_file:
+            file_handler = logging.FileHandler(log_file)
+            file_handler.setFormatter(formatter)
+            logger.addHandler(file_handler)
+        else:
+            console_handler = logging.StreamHandler()
+            console_handler.setFormatter(formatter)
+            logger.addHandler(console_handler)
+
+        return logger
+
+    def _initialize_data_platform(self):
+        """Initialize the data plaform object based on the config."""
+        self.logger.info(f"Initializing the data platform.")
+        return DataPlatform(config=self.config['dp_config'])
+
+    #-------------------------EXTERNAL FUNCTIONS-------------------------------------
+    def addCondition(self,condition,value):
+        """Add a condition to the experiment description"""
+        _condition_key = self.conditions_key + ":" + condition
+        try:
+            self.data_platform.write(_condition_key, value)
+            self.logger.info("Condition <" + condition + "> with value " + str(value) + " written to vfWorks backend!")
+        except:
+            self.logger.warning("Condition <" + condition + "> with value " + str(value)+ " failed to write to vfWorks backend!")
+
+    def addLabel(self,label="nominal"):
+        _label_key = self.experiment_key + ":" + "label"
+        try:
+            self.data_platform.write(_label_key, label)
+            self.logger.info("Label <" + label + "> written to vfWorks backend!")
+        except:
+            self.logger.warning("Label <" + label + "> failed to write to vfWorks backend!")
+
+    def addMeasurement(self,key,value,batch=True,clean=True, vector=False):
+        _measurement_key = self.measurements_key + ":" + key
+        if clean:
+            self.data_platform.delete(_measurement_key)
+        if batch:
+            if vector:
+                self.data_platform.write(_measurement_key, value)
+            else:
+                value.reverse()
+                for point in value:
+                    self.data_platform.write_storage(_measurement_key, point)       #TODO: add batch writer to data_platform!
+        else:
+            self.data_platform.write_storage(_measurement_key, value)
+
+    def getMeasurement(self,key):
+        _measurement_key = self.measurements_key + ":" + key
+        try:
+            values = self.data_platform.read_list(key=_measurement_key,all=True)
+            # TODO: HACKED byte to float - THIS NEEDS TO BE MORE GENERIC!
+            for i in range(0,len(values),1):
+                values[i] = float(values[i])
+
+            self.logger.info("Reading values for measurement <" + key + "> from vfWorks backend!")
+            return values
+        except:
+            self.logger.warning("Failed to read values for measurement <" + key + "> from vfWorks backend!")
+
+
+

vfworks/clientLibraries/vfclpy/data_platform.py

@@ -0,0 +1,110 @@
+import redis
+import json
+
+class DataPlatform(object):
+    def __init__(self, config):
+        """
+        Initialize the data platform object.
+        :param config: Configuration for data platform storage (local or global)
+        """
+        self.config = config
+        self.storage_type = config.get('storage_type', 'local')  # 'local' or 'global'
+
+        if self.storage_type == 'global':
+            self.redis_client = redis.StrictRedis(
+                host=config['redis_host'], 
+                port=config['redis_port'],
+                charset="utf-8",
+                decode_responses = True,
+                db=config.get('redis_db', 0)
+            )
+        else:
+            self.local_store = {}
+
+    def write(self, key, value):
+        """
+        Store a key-value pair in the data platform. If the value is a dictionary, it will be serialized.
+        :param key: The key for storing the data
+        :param value: The value to store (can be a dict, str, int, etc.)
+        """
+        if isinstance(value, dict):
+            value = json.dumps(value)  # Serialize the dictionary to a JSON string
+        else:
+            value = str(value)
+        if self.storage_type == 'global':
+            self.redis_client.set(key, value)
+            # signal new data
+            self.redis_client.publish('MONITOR_NEW_DATA', key)
+        else:
+            self.local_store[key] = value
+
+    def write_storage(self, key, value):
+        """
+        Store a key-value pair in the data platform. If the value is a dictionary, it will be serialized.
+        :param key: The key for storing the data
+        :param value: The value to store (can be a dict, str, int, etc.)
+        """
+        if isinstance(value, list):
+            value = json.dumps(value)
+        if isinstance(value, dict):
+            value = json.dumps(value)  # Serialize the dictionary to a JSON string
+        if self.storage_type == 'global':
+            self.redis_client.lpush(key,value)
+            #signal new data
+            self.redis_client.publish('MONITOR_NEW_DATA',key)
+        else:
+            self.local_store[key] = value
+    def read(self, key, queueSize = 1):
+        """
+        Retrieve a value from the data platform. If the value is JSON, it will be deserialized to a Python object.
+        :param key: The key for retrieving the data
+        :return: The value associated with the key or None if not found
+        """
+        if self.storage_type == 'global':
+            value = self.redis_client.get(key)
+            if value is not None:
+                #value = value.decode('utf-8')  # Convert bytes to string       #TODO: CHECK IF WE CAN ALWAYS USE AUTO-DECODE OR WE NEED TO MANUALLY DECODE
+                try:
+                    value = json.loads(value)  # Try to deserialize the value if it's a JSON string
+                except json.JSONDecodeError:
+                    pass  # If it's not JSON, return it as a string
+            return value
+        else:
+            return self.local_store.get(key, None)
+
+    def read_list(self, key, queueSize = 1, all=False):
+        if self.storage_type == 'global':
+            if all:
+                list = self.redis_client.lrange(key, 0, -1)
+            else:
+                list = self.redis_client.lrange(key, 0, queueSize)
+
+            return list
+        else:
+            return self.local_store.get(key, None)
+
+    def delete(self, key):
+        """
+        Delete a key-value pair from the data platform.
+        :param key: The key to delete
+        """
+        if self.storage_type == 'global':
+            self.redis_client.delete(key)
+        else:
+            if key in self.local_store:
+                del self.local_store[key]
+
+    def exists(self, key):
+        """
+        Check if a key exists in the data platform.
+        :param key: The key to check
+        :return: True if the key exists, False otherwise
+        """
+        if self.storage_type == 'global':
+            return self.redis_client.exists(key)
+        else:
+            return key in self.local_store
+
+
+    def getKeys(self,pattern):
+        return self.redis_client.keys(pattern)

vfworks/clientLibraries/vfclpy/probe.py

@@ -0,0 +1,66 @@
+#***************************************************************************************
+# * Copyright (C) 2024-present Bert Van Acker (UAntwerpen) <Bert.VanAcker@uantwerpen.be>
+# *
+# * This file is part of the vfWorks project.
+# *
+# * vfWorks can not be copied and/or distributed without the express
+# * permission of Bert Van Acker
+# **************************************************************************************
+import yaml
+import logging
+from vfworks.clientLibraries.vfclpy.data_platform import *
+class Probe(object):
+    def __init__(self, config, storage=False, verbose=False):
+        self.config = self.load_config(config)
+        self.logger = self.initialize_logger()
+        self.data_platform = self.initialize_data_platform()  # Initialize knowledge within the component
+
+        probe_config = self.config.get("validityframe", {})
+        self.probe_key = f"{probe_config.get('name', 'base')}:properties"
+        self._storage = storage
+
+
+    def load_config(self, config_file):
+        with open(config_file, 'r') as file:
+            return yaml.safe_load(file)
+
+    def initialize_logger(self):
+        """Initialize the logger (same as before)."""
+        log_config = self.config.get("logging", {})
+        logger = logging.getLogger(self.__class__.__name__)
+        log_level = log_config.get("level", "INFO").upper()
+        logger.setLevel(getattr(logging, log_level, logging.INFO))
+
+        log_format = log_config.get("format", "%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+        log_file = log_config.get("file", None)
+
+        formatter = logging.Formatter(log_format)
+
+        if log_file:
+            file_handler = logging.FileHandler(log_file)
+            file_handler.setFormatter(formatter)
+            logger.addHandler(file_handler)
+        else:
+            console_handler = logging.StreamHandler()
+            console_handler.setFormatter(formatter)
+            logger.addHandler(console_handler)
+
+        return logger
+
+
+    def initialize_data_platform(self):
+        """Initialize the data plaform object based on the config."""
+        self.logger.info(f"Initializing the data platform.")
+        return DataPlatform(config=self.config['dp_config'])
+
+    def write(self, key, message = True):
+        """Write data on the data platform."""
+        if self.data_platform:
+            _probe_key = self.probe_key+":"+key
+            self.logger.info("Probing property (ID:"+key+") with value "+ str(message))
+            if not self._storage:
+                self.data_platform.write(_probe_key, message)
+            else:
+                self.data_platform.write_storage(_probe_key, message)
+        else:
+            self.logger.warning("Probe is not set for writing")

vfworks/commands/version.py

@@ -0,0 +1,23 @@
+#***************************************************************************************
+# * Copyright (C) 2024-present Bert Van Acker (UAntwerpen) <Bert.VanAcker@uantwerpen.be>
+# *
+# * This file is part of the vfWorks project.
+# *
+# * vfWorks can not be copied and/or distributed without the express
+# * permission of Bert Van Acker
+# **************************************************************************************
+
+import click
+from vfworks import __version__
+
+
+@click.group()
+@click.pass_context
+def versionCmds():
+    pass
+
+@versionCmds.command()
+def version():
+    """Display the current version."""
+    version = __version__
+    click.echo("vfWorks v"+version)

vfworks/logging/logger.py

@@ -0,0 +1,93 @@
+#***************************************************************************************
+# * Copyright (C) 2024-present Bert Van Acker (UAntwerpen) <Bert.VanAcker@uantwerpen.be>
+# *
+# * This file is part of the vfWorks project.
+# *
+# * vfWorks can not be copied and/or distributed without the express
+# * permission of Bert Van Acker
+# **************************************************************************************
+import os
+import logging
+
+def setup_logger(name, log_file, level=logging.INFO):
+    """Setup of multiple loggers"""
+    formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
+    handler = logging.FileHandler(log_file)
+    handler.setFormatter(formatter)
+    logger = logging.getLogger(name)
+    logger.setLevel(level)
+    logger.addHandler(handler)
+
+    return logger
+
+class Logger(object):
+    def __init__(self,name="customLogger",path=None,verbose=False):
+        """Initialize a Logger component.
+
+                Parameters
+                ----------
+                name : string
+                    name of the property components
+
+                verbose : bool
+                    component verbose execution
+
+                See Also
+                --------
+                ..
+
+                Examples
+                --------
+                >> logger = Logger(verbose=False)
+
+                """
+
+        # --- logger configuration ---
+        self._name = name
+        self._verbose = verbose
+
+        #set logging file
+        if path is None:
+            systemLog = os.getcwd()+"/Resources/sys.log"
+        else:
+            systemLog = path+"/Resources/sys.log"
+
+        #setup logger
+        self._syslogger=setup_logger(name="systemLog",log_file=systemLog,level=logging.INFO)
+        #self.syslog(msg="Logger configured", level="INFO")
+
+    @property
+    def name(self):
+        """The name property (read-only)."""
+        return self._name
+
+    def syslog(self,msg="tbd",level="INFO"):
+        """Perform a system log entry.
+
+            Parameters
+            ----------
+            msg : string
+                message to be logged
+
+            type : string
+                Level of the logging
+
+
+            See Also
+            --------
+            ..
+
+            Examples
+            --------
+            >> logger.syslog(msg="this is a examples log message",level="INFO")
+
+            """
+        # verbose printing
+        if self._verbose: print(msg)
+        # logging
+        if level == 'INFO':
+            self._syslogger.info(msg)
+        elif level == 'DEBUG':
+            self._syslogger.debug(msg)
+        elif level == 'ERROR':
+            self._syslogger.error(msg)