Merge pull request #3 from railtoolkit/dev-martin

Dev martin

CHANGELOG.md

@@ -19,7 +19,7 @@ Refactor the modular structure:
 * Extract the modules Export and AdditionalOutput from TrainRunCalc
 * Divide the module Operationsmodes and add its functions to TrainRunCalc and EnergySaving
 * Add the remaining functions of the module types to EnergySaving
-* Divide the module MovingPhases into Behavior and DrivingDynamics
+* Divide the module MovingPhases into Behavior and Formulary
 * Rename the module Preparation to Characteristics
 
 
@@ -70,7 +70,7 @@ Add an attribute to DataPoint to record the corresponding driving behavior
 
 Refactor some of the mutable structs from types.jl as Dictionaries
 * Remove the mutable structs Train, Path, PathSection, Settings and MovingSection
-* Create Dictionaries for train, path an settings in Input.jl
+* Create Dictionaries for train, path an settings in Validate.jl
 * Create a Dictionary for the whole moving section in Preperation.jl and a function for copying the moving section in OperationModes.jl
 * Change the type of existing Dictionary keys from String to Symbol
 

README.md

@@ -34,7 +34,7 @@ running_path_directory = "data/paths/path_1_10km_nConst_vConst.yaml"
 settings_directory = "data/settings.yaml"
 (train, running_path, settings) = importYamlFiles(train_directory, running_path_directory, setting_directory)
 
-train_run = calculateDrivingDynamics(train, running_path, settings)
+train_run = trainRun(train, running_path, settings)
 ```
 
 ------------

examples/ExtendedWorkingExample.jl

@@ -28,7 +28,7 @@ for path in allPaths
    for train in allTrains
        # println("train: ", train[:name])
        for settings in allSettings
-           resultsDict = calculateDrivingDynamics(train, path, settings)
+           resultsDict = trainRun(train, path, settings)
            if haskey(settings, :typeOfOutput) && settings[:typeOfOutput] == "CSV"
                exportToCsv(resultsDict, settings)
                sleep(2)

examples/MinimalWorkingExample.jl

@@ -13,7 +13,7 @@ running_path_directory = "data/paths/path_1_10km_nConst_vConst.yaml"
 setting_directory = "data/settings/settings_distanceStep_massPoint_runningTime.yaml"
 (train, running_path, settings) = importYamlFiles(train_directory, running_path_directory, setting_directory)
 
-runtime = calculateDrivingDynamics(train, running_path, settings)
+runtime = trainRun(train, running_path, settings)
 
 exportToCsv(runtime, settings)
 println("The V 90 with 10 ore wagons needs $runtime seconds for 10 km with no gradient.")

src/Behavior.jl

@@ -7,14 +7,14 @@
 
 module Behavior
 
-include("./DrivingDynamics.jl")
+include("./Formulary.jl")
-using .DrivingDynamics
+using .Formulary
 
 export addBreakFreeSection!, addClearingSection!, addAcceleratingSection!, addCruisingSection!, addDiminishingSection!, addCoastingSection!, addBrakingSection!, addStandstill!,
 # addBrakingSectionInOneStep! is not used in the current version of the tool
 calculateForces!, createDataPoint,
 
-# export functions from DrivingDynamics
+# export functions from Formulary
 calcBrakingDistance, calcBrakingStartVelocity, calc_Δs_with_Δt
 
 

src/EnergySaving.jl

@@ -10,7 +10,7 @@
 
 # TODO: calculation time for passenger trains on path1 is very long and should be reduced
 # TODO from 2022/01/18: Test if enum trainType is working correctly in function calculateRecoveryTime or if only the else-pathis taken
-# TODO from 2022/01/19: Are here calculations that should be transferred to DrivingDynamics.jl?
+# TODO from 2022/01/19: Are here calculations that should be transferred to Formulary.jl?
 # TODO from 2022/01/22: use always copyCharacteristicSection and don't do it manually like "csModified=Dict(:id => csOriginal[:id], ..." three times
 # TODO from 2022/03/18: stateFlags need to be added to functions that add behavior sections
 # TODO from 2022/03/21: consider previous speed limits during the coasting section in case F_R < 0.0 and the train is getting faster

src/Formulary.jl

@@ -5,7 +5,7 @@
 # __copyright__     = "2022"
 # __license__       = "ISC"
 
-module DrivingDynamics
+module Formulary
 
 #########################
 ## literature the driving dynamics equations are based on:
@@ -253,4 +253,4 @@ function calcBrakingAcceleration(v_start::Real, v_end::Real, s_braking::Real)
     return a_braking
 end #function calcBrakingAcceleration
 
-end #module DrivingDynamics
+end #module Formulary

src/TrainRun.jl

@@ -30,7 +30,7 @@ using .AdditionalOutput
 using .EnergySaving
 
 # main function
-export calculateDrivingDynamics,
+export trainRun,
 
 # import functions
 importYamlFiles, importFromYaml,

src/TrainRunCalc.jl

@@ -8,20 +8,20 @@
 module TrainRunCalc
 
 # include modules of TrainRunCalc
-include("./Input.jl")
+include("./Validate.jl")
 include("./Characteristics.jl")
 include("./Behavior.jl")
 include("./Output.jl")
 
 
 # use modules of TrainRunCalc
-using .Input
+using .Validate
 using .Characteristics
 using .Behavior
 using .Output
 
 # export main function
-export calculateDrivingDynamics
+export trainRun
 
 approximationLevel = 6  # value for approximation to intersections and precisely calculated digits
     # TODO:  define it here and give it to each function? (Behavior, ...)
@@ -29,17 +29,17 @@ approximationLevel = 6  # value for approximation to intersections and precisely
 # Calculate the driving dynamics of a train run on a path with special settings with information from the corresponding YAML files with the file paths `trainDirectory`, `pathDirectory`, `settingsDirectory`.
 
 """
-    calculateDrivingDynamics(train::Dict, path::Dict, settings::Dict)
+    trainRun(train::Dict, path::Dict, settings::Dict)
 
 Calculate the driving dynamics of a train run on a path with special settings with information from the corresponding dictionaries `train`, `path`, `settings`.
 
 # Examples
 ```julia-repl
-julia> calculateDrivingDynamics(trainDict, pathDict, settingsDict)
+julia> trainRun(trainDict, pathDict, settingsDict)
 todo !!!
 ```
 """
-function calculateDrivingDynamics(trainInput::Dict, pathInput::Dict, settingsInput::Dict)
+function trainRun(trainInput::Dict, pathInput::Dict, settingsInput::Dict)
     # copy Input data for not changing them
     # TODO: or should they be changed? normally it would only make it "better" except for settings[:detailOfOutput] == "points of interest" && !haskey(path, :pointsOfInterest)
     train = copy(trainInput)
@@ -68,7 +68,7 @@ function calculateDrivingDynamics(trainInput::Dict, pathInput::Dict, settingsInp
     end #if
 
     return output
-end # function calculateDrivingDynamics
+end # function trainRun
 
 # calculate a train run focussing on using the minimum possible running time
 function calculateMinimumRunningTime!(movingSection::Dict, settings::Dict, train::Dict)

src/Validate.jl

@@ -6,7 +6,7 @@
 # __license__       = "ISC"
 
 # TODO: 2022-04-07: if EnergySaving should be used. The train type has do be defined and checked
-module Input
+module Validate
 
 export checkAndSetInput!
 
@@ -754,4 +754,4 @@ function informAboutUnusedKeys(allKeys::AbstractVector, usedKeys::Vector{Symbol}
     end
 end #function informAboutUnusedKeys
 
-end # module Input
+end # module Validate

test/runtests.jl

@@ -25,7 +25,7 @@ push!(allTrains, importYamlFile(:train, "data/trains/train_passenger_IC2.yaml"))
 for path in allPaths
   for train in allTrains
     for settings in allSettings
-      testDict=calculateDrivingDynamics(train, path, settings)
+      testDict=trainRun(train, path, settings)
       exportToCsv(testDict)
       sleep(2)
 

test/testEnums.jl

@@ -6,7 +6,7 @@
 # __license__       = "ISC"
 
 include("../src/types.jl")
-include("../src/Input.jl")
+include("../src/Validate.jl")
 
 using .Input
 using YAML, Test