Merge pull request #110 from OpenSourceAWE/rm-initial-requirement

Author: 1-Bart-1

src/settings.jl

@@ -13,6 +13,9 @@
 
 Flat struct, defining the settings of the Simulator and the Viewer.
 
+Use [`load_settings`](@ref) to reload the global module singleton, or
+[`Settings(project)`](@ref) to create a fresh, independent instance.
+
 $(TYPEDFIELDS)
 """
 @with_kw mutable struct Settings @deftype Float64
@@ -355,13 +358,20 @@ StructTypes.StructType(::Type{Settings}) = StructTypes.Mutable()
 PROJECT::String = "system.yaml"
 
 """
-    Settings(project)
+    Settings(project; relax=false)
+
+Create a fresh [`Settings`](@ref) instance, loading from the given
+project file. Unlike [`load_settings`](@ref), this does **not** modify
+the global module settings; it returns an independent struct.
 
-Constructor for the [`Settings`](@ref) struct, loading settings from the given project file.
+## Parameters
+- `project`: The name of the project file to load.
+- `relax`: If true, missing sections in the settings file are
+  skipped instead of raising an error.
 """
-function Settings(project)
+function Settings(project; relax=false)
     set = Settings()
-    return se(set, project)
+    return se(set, project; relax)
 end
 const SETTINGS = Settings()
 const _SE_DICTS = IdDict{Settings, Dict{String, Any}}()
@@ -396,13 +406,18 @@ end
 """
     load_settings(project=PROJECT; relax=false)
 
-Load the project with the given file name.
+Reload the global module [`Settings`](@ref) from the given project
+file. Returns the updated global settings singleton. To obtain an
+independent settings instance instead, use the
+[`Settings(project)`](@ref) constructor.
 
 The project must include the path and the suffix .yaml .
 
 ## Parameters
-- `project`: The name of the project file to load, defaults to the project that was loaded before.
-- `relax`: If true, no section needs to be present in the settings.yaml file.
+- `project`: The name of the project file to load, defaults to
+  the project that was loaded before.
+- `relax`: If true, missing sections in the settings file are
+  skipped instead of raising an error.
 """
 function load_settings(project=PROJECT; relax=false)
     SETTINGS.segments=0
@@ -536,7 +551,7 @@ function se(settings::Settings, project=PROJECT; relax=false)
         dict = YAML.load_file(joinpath(DATA_PATH[1], sim_settings_path))
         _SE_DICTS[settings] = dict
         # update the settings struct from the dictionary
-        required_sections = ["system", "initial", "solver", "kite", "tether", "environment"]
+        required_sections = ["system", "solver", "kite", "tether", "environment"]
         if relax
             for section in required_sections
                 if section in keys(dict)
@@ -546,7 +561,7 @@ function se(settings::Settings, project=PROJECT; relax=false)
         else
             update_settings(dict, required_sections, settings)
         end
-        for section in ["steering", "depower", "kps4", "kps5", "bridle", "winch", "kcu"]
+        for section in ["initial", "steering", "depower", "kps4", "kps5", "bridle", "winch", "kcu"]
             if section in keys(dict)
                 update_settings(dict, [section], settings)
             end

test/test-settings.jl

@@ -59,4 +59,46 @@ using KiteUtils, Test
     @test se_dict()["environment"]["z0"] == se().z0
     set3 = update_settings()
     @test set3 == se()
+
+    # Settings(project) returns a fresh instance, not the global one
+    fresh = Settings("system.yaml")
+    @test fresh.sim_settings == "settings.yaml"
+    @test fresh !== se()
+
+    # Settings(project) supports the relax kwarg
+    fresh_relax = Settings("system_cabauw.yaml"; relax=true)
+    @test fresh_relax.v_wind == 9.51
+    @test fresh_relax !== se()
+
+    # "initial" section is optional (no error when missing)
+    settings_yaml = joinpath(get_data_path(), "settings.yaml")
+    lines = readlines(settings_yaml)
+    # Create a settings file without the "initial" section
+    no_initial = joinpath(tempdir(), "settings_no_initial.yaml")
+    sys_no_initial = joinpath(tempdir(), "system_no_initial.yaml")
+    in_initial = false
+    open(no_initial, "w") do io
+        for line in lines
+            if match(r"^initial:", line) !== nothing
+                in_initial = true
+                continue
+            end
+            if in_initial && (startswith(line, "  ") || isempty(line))
+                continue
+            end
+            in_initial = false
+            println(io, line)
+        end
+    end
+    open(sys_no_initial, "w") do io
+        println(io, "system:")
+        println(io, "    sim_settings: \"settings_no_initial.yaml\"")
+    end
+    old_path = get_data_path()
+    set_data_path(tempdir())
+    set_no_init = Settings("system_no_initial.yaml")
+    @test set_no_init.sim_settings == "settings_no_initial.yaml"
+    # initial fields keep their defaults (elevations defaults to [70])
+    @test set_no_init.elevation == 70.0
+    set_data_path(old_path)
 end