Added comments to explain configuration parameters/or variables.

input_files/data_integr_config_file_LI.yaml

@@ -1,31 +1,69 @@
+# Path to the directory where raw data is stored
 input_file_directory: '//fs101/5505/Data'
-output_file_directory: 'output_files/'
 
-# Define 
+# Path to directory where raw data is copied and converted to HDF5 format for local analysis.
+output_file_directory: '../output_files/'
+
+# Project metadata for data lineage and provenance
 project:  'Photoenhanced uptake of NO2 driven by Fe(III)-carboxylate'
 contact: 'LuciaI'
 group_id: '5505'
 
+# Experiment description
 experiment: 'kinetic_flowtube_study' # 'beamtime', 'smog_chamber_study'   
 dataset_startdate: 
 dataset_enddate: 
 actris_level: '0'
 
-# 
+# Instrument folders containing raw data from the campaign
-instrument_datafolder: # analytical_methods: 
+instrument_datafolder: 
-  - 'Lopap'
+  - 'Lopap'           # Example instrument folder
   - 'Humidity_Sensors'
   - 'ICAD/HONO'
   - 'ICAD/NO2'
   - 'T200_NOx'
   - 'T360U_CO2'
 
-# Define data_integration mode as either 'collection' or 'single_experiment'
+# Data integration mode for HDF5 data ingestion
-integration_mode: 'single_experiment'
+integration_mode: 'collection' # Options: 'single_experiment', 'collection'
-# Specify datetimes (YYYY-MM-DD HH-MM-SS) at which experimental steps were created. 
+
+# Datetime markers for individual experiments
+# Use the format YYYY-MM-DD HH-MM-SS
 datetime_steps:
-    - '2022-11-22 00-00-00'
+  - '2022-02-11 00-00-00'
-    - '2022-01-31 00-00-00'
+  - '2022-03-14 00-00-00'
-    - '2023-06-22 00-00-00'
+  - '2022-03-18 00-00-00'
-    - '2023-06-29 00-00-00'
+  - '2022-03-25 00-00-00'
+  - '2022-03-29 00-00-00'
+  - '2022-04-11 00-00-00'
+  - '2022-04-29 00-00-00'
+  - '2022-05-16 00-00-00'
+  - '2022-05-30 00-00-00'
+  - '2022-06-10 00-00-00'
+  - '2022-06-14 00-00-00'
+  - '2022-06-15 00-00-00'
+  - '2022-07-15 00-00-00'
+  - '2022-11-18 00-00-00'
+  - '2022-11-22 00-00-00'
+  - '2022-12-01 00-00-00'
+  - '2022-12-02 00-00-00'
+  - '2023-05-05 00-00-00'
+  - '2023-05-09 00-00-00'
+  - '2023-05-11 00-00-00'
+  - '2023-05-16 00-00-00'
+  - '2023-05-23 00-00-00'
+  - '2023-05-25 00-00-00'
+  - '2023-05-30 00-00-00'
+  - '2023-05-31 00-00-00'
+  - '2023-06-01 00-00-00'
+  - '2023-06-06 00-00-00'
+  - '2023-06-09 00-00-00'
+  - '2023-06-13 00-00-00'
+  - '2023-06-16 00-00-00'
+  - '2023-06-20 00-00-00'
+  - '2023-06-22 00-00-00'
+  - '2023-06-27 00-00-00'
+  - '2023-06-28 00-00-00'
+  - '2023-06-29 00-00-00'
+
     

input_files/data_integr_config_file_NG.yaml

@@ -1,23 +1,32 @@
+# Path to the directory where raw data is stored
 input_file_directory: '//fs03/Iron_Sulphate'
+
+# Path to directory where raw data is copied and converted to HDF5 format for local analysis.
 output_file_directory: 'output_files/'
 
+# Project metadata for data lineage and provenance
 project: 'Fe SOA project' 
 contact: 'NatashaG'
 group_id: '5505'
 
+# Experiment description
 experiment: 'smog_chamber_study' # beamtime, smog_chamber, lab_experiment  
 dataset_startdate: 
 dataset_enddate: 
 actris_level: '0'
 
-instrument_datafolder: # analytical_methods: 
+# Instrument folders containing raw data from the campaign
-  - 'gas'
+instrument_datafolder:
+  - 'gas'             # Example instrument folder
   - 'smps'
   - 'htof'
   - 'ptr'
   - 'ams'
 
-integration_mode: 'single_experiment'
+# Data integration mode for HDF5 data ingestion
-# Specify datetimes (YYYY-MM-DD HH-MM-SS) at which experimental steps were created. 
+integration_mode: 'single_experiment' # Options: 'single_experiment', 'collection'
+
+# Datetime markers for individual experiments
+# Use the format YYYY-MM-DD HH-MM-SS
 datetime_steps:
   - '2022-07-26 00-00-00'

input_files/data_integr_config_file_TBR.yaml

@@ -1,17 +1,24 @@
+# Path to the directory where raw data is stored
 input_file_directory: '//fs101/5505/People/Juan/TypicalBeamTime'
+
+# Path to directory where raw data is copied and converted to HDF5 format for local analysis.
 output_file_directory: 'output_files/'
 
+# Project metadata for data lineage and provenance
 project: 'Beamtime May 2024, Ice Napp'  
 contact: 'ThorstenBR'
 group_id: '5505'
 
+# Experiment description
 experiment: 'beamtime' # beamtime, smog_chamber, lab_experiment 
 dataset_startdate: '2023-09-22'
 dataset_enddate: '2023-09-25'
 actris_level: '0'
 
+institution : "PSI"
+filename_format : "institution,experiment,contact"
 
-
+# Instrument folders containing raw data from the campaign
 instrument_datafolder: 
   - 'NEXAFS'
   - 'Notes'
@@ -20,6 +27,9 @@ instrument_datafolder:
   - 'RGA'
   - 'SES'
 
-integration_mode: 'collection'
+# Data integration mode for HDF5 data ingestion
-# Specify datetimes (YYYY-MM-DD HH-MM-SS) at which experimental steps were created. 
+integration_mode: 'collection' # Options: 'single_experiment', 'collection'
+
+# Datetime markers for individual experiments
+# Use the format YYYY-MM-DD HH-MM-SS
 datetime_steps: []