rename path templates and introduce optional config section

halodrops.cfg

@@ -1,11 +1,6 @@
 [MANDATORY]
 data_directory = ./example_data
 
-[helper.paths.Flight.__init__]
-path_structure = {platform}/Level_0/{flight}
-
-[helper.paths.Platform.__init__]
-path_structure = {platform}/Level_0
-
-[processor.Sonde.add_path_structure]
-path_structure = {platform}/Level_0/{flight}
+[OPTIONAL]
+path_to_flight_ids = {platform}/Level_0
+path_to_l0_files = {platform}/Level_0/{flight_id}

src/halodrops/helper/__init__.py

@@ -94,8 +94,8 @@
 )
 
 
-platform_path_template = "{platform}/Level_0"
-flight_path_template = "{platform}/Level_0/{flight_id}"
+path_to_flight_ids = "{platform}/Level_0"
+path_to_l0_files = "{platform}/Level_0/{flight_id}"
 
 l2_flight_attributes_map = {
     "True Air Speed (m/s)": "true_air_speed_(ms-1)",

src/halodrops/helper/paths.py

@@ -6,7 +6,7 @@
 
 from halodrops.helper import rawreader as rr
 from halodrops.processor import Sonde
-from halodrops.helper import platform_path_template, flight_path_template
+from halodrops.helper import path_to_flight_ids, path_to_l0_files
 
 # create logger
 module_logger = logging.getLogger("halodrops.helper.paths")
@@ -25,7 +25,7 @@ def __init__(
         data_directory,
         platform_id,
         platform_directory_name=None,
-        path_structure=platform_path_template,
+        path_structure=path_to_flight_ids,
     ) -> None:
         self.platform_id = platform_id
         self.platform_directory_name = platform_directory_name
@@ -64,7 +64,7 @@ def __init__(
         data_directory,
         flight_id,
         platform_id,
-        path_structure=flight_path_template,
+        path_structure=path_to_l0_files,
     ):
         """Creates an instance of Paths object for a given flight
 
@@ -101,7 +101,7 @@ def __init__(
         flight_dir = os.path.join(
             self.data_directory,
             self.path_structure.format(
-                platform=self.platform_id, flight=self.flight_id
+                platform=self.platform_id, flight_id=self.flight_id
             ),
         )
         self.flight_idpath = flight_dir

src/halodrops/pipeline.py

@@ -1,5 +1,5 @@
 from .helper.paths import Platform, Flight
-from .helper.__init__ import platform_path_template, flight_path_template
+from .helper.__init__ import path_to_flight_ids, path_to_l0_files
 from .processor import Sonde
 import configparser
 import inspect
@@ -162,16 +162,16 @@ def get_platforms(config):
     """
     data_directory = config.get("MANDATORY", "data_directory")
     path_structure = config.get(
-        "MANDATORY", "platform_path_structure", fallback=platform_path_template
+        "OPTIONAL", "path_to_flight_ids", fallback=path_to_flight_ids
     )
-    if config.has_option("MANDATORY", "platforms"):
-        if not config.has_option("MANDATORY", "platform_directory_names"):
+    if config.has_option("OPTIONAL", "platforms"):
+        if not config.has_option("OPTIONAL", "platform_directory_names"):
             raise ValueError(
                 "platform_directory_names must be provided in the config file when platforms is specified"
             )
-        platforms = config.get("MANDATORY", "platforms").split(",")
+        platforms = config.get("OPTIONAL", "platforms").split(",")
         platform_directory_names = config.get(
-            "MANDATORY", "platform_directory_names"
+            "OPTIONAL", "platform_directory_names"
         ).split(",")
         platforms = dict(zip(platforms, platform_directory_names))
         for directory_name in platform_directory_names:
@@ -223,7 +223,7 @@ def create_and_populate_flight_object(
 
     platform_objects = get_platforms(config)
     path_structure = config.get(
-        "MANDATORY", "flight_path_structure", fallback=flight_path_template
+        "OPTIONAL", "path_to_l0_files", fallback=path_to_l0_files
     )
     output["platforms"] = platform_objects
     output["sondes"] = {}

tests/test_paths.py

@@ -5,7 +5,7 @@
 main_data_directory = "./example_data"
 platform_id = "HALO"
 flightdate = "20200119"
-path_structure = "{platform}/Level_0/{flight}"
+path_structure = "{platform}/Level_0/{flight_id}"
 platform_path_structure = "{platform}/Level_0"
 
 l1_path = os.path.join(main_data_directory, platform_id, "Level_1", flightdate)