Arvedes/issue20 (#24)

Author: arvedes

README.md

@@ -32,21 +32,27 @@ Additional devices may be included in a flexible manner.
 
 ## Usage
 
-multilog is configured using the file *config.yml* in the main directory. A template [*config_template.yml*](./config_template.yml), including all supported measurement devices, is provided in this repository; please create a copy of this file and adjust it to your needs. Further details are given below.
+multilog is configured by default using the file *config.yml* in the main directory. Outputs are written to the working directory. A template [*config_template.yml*](./config_template.yml), including all supported measurement devices, is provided in this repository; please create a copy of this file and adjust it to your needs. Further details are given below.
 
 To run multilog execute the python file [*multilog.py*](./multilog.py):
 
 ```shell
 python3 ./multilog.py
 ```
 
+Alternatively, multilog can be started with the optional command line arguments `-c` and `-o` to give an individual config file and output directory.
+
+```shell
+python3 ./multilog.py -c ./my_config_file.yml -o ../my_output_dir
+```
+
 If everything is configured correctly, the GUI window opens up. Sampling is started immediately for verification purposes, but the measurements are not recorded yet. Once the *Start* button is clicked, the directory "measdata_*date*_#*XX*" is created and samplings are saved to this directory in csv format. A separate file (or folder for images) is created for each measurement device.
 
 multilog is built for continuous sampling. In case of problems, check the log file for errors and warnings!
 
 ## Configuration
 
-multilog is configured using the file *config.yml* in the main directory. A template [*config_template.yml*](./config_template.yml) including all supported measurement devices is provided in this repository; please create a copy of this file and adjust it to your needs.
+multilog is configured using the file *config.yml* in the main directory or a user-defined config-file provided using the `-c` argument. A template [*config_template.yml*](./config_template.yml) including all supported measurement devices is provided in this repository; please create a copy of this file and adjust it to your needs.
 
 ### Main settings
 

multilog.py

@@ -1,6 +1,33 @@
 """Execute this to start multilog!"""
 
+from argparse import ArgumentParser
+
 from multilog.main import main
+from multilog import __version__
+
 
 if __name__ == "__main__":
-    main()
+    parser = ArgumentParser(
+        prog="multilog",
+        description="Measurement data recording and visualization using various devices.",
+    )
+    parser.add_argument(
+        "-c",
+        "--config",
+        help="multilog configuration file [optional, default='./config.yml']",
+        default="./config.yml",
+    )
+    parser.add_argument(
+        "-o",
+        "--out_dir",
+        help="directory where to put the output [optional, default='.']",
+        default=".",
+    )
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=f"{parser.prog} version {__version__}",
+    )
+    args = parser.parse_args()
+    main(args.config, args.out_dir)

multilog/main.py

@@ -87,17 +87,24 @@ class Controller(QObject):
     signal_update_camera = pyqtSignal()  # sample and update view
     signal_sample_camera = pyqtSignal(dict)  # sample, update view and save
 
-    def __init__(self) -> None:
-        """Initialize and run multilog."""
+    def __init__(self, config, output_dir) -> None:
+        """Initialize and run multilog.
+
+        Args:
+            config (str): File path of configuration file.
+            output_dir (str): Directory where to put the output.
+        """
         super().__init__()
 
         # load configuration, setup logging
-        with open("./config.yml", encoding="utf-8") as f:
+        with open(config, encoding="utf-8") as f:
             self.config = yaml.safe_load(f)
         logging.basicConfig(**self.config["logging"])
         logging.info("initializing multilog")
         logging.info(f"configuration: {self.config}")
 
+        self.output_dir = output_dir
+
         # do that after logging has been configured to log possible errors
         from .devices.daq6510 import Daq6510
         from .devices.basler_camera import BaslerCamera
@@ -280,7 +287,7 @@ def init_output_files(self):
         for i in range(100):
             if i == 99:
                 raise ValueError("Too high directory count.")
-            self.directory = f"./measdata_{date}_#{i+1:02}"
+            self.directory = f"{self.output_dir}/measdata_{date}_#{i+1:02}"
             if not os.path.exists(self.directory):
                 os.makedirs(self.directory)
                 break
@@ -358,6 +365,11 @@ def sample_camera(self):
         self.signal_sample_camera.emit({"time_abs": time_abs, "time_rel": time_rel})
 
 
-def main():
-    """Execute this function to run multilog."""
-    ctrl = Controller()
+def main(config, output_dir):
+    """Execute this function to run multilog.
+
+    Args:
+        config (str): File path of configuration file.
+        output_dir (str): Directory where to put the output.
+    """
+    ctrl = Controller(config, output_dir)