Merge pull request #4 from ModiaSim/dev

MartinOtter · web-flow · commit 791cc9884bc2 · 2022-07-07T13:19:11.000+02:00
Improvements
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,40 @@
+name: Run tests
+
+env:
+  JULIA_NUM_THREADS: 4
+on:
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.7.3'
+        os:
+          - ubuntu-latest
+          - windows-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "SignalTables"
 uuid = "3201582d-3078-4276-ba5d-0a1254d79d7c"
 authors = ["Martin.Otter@dlr.de <Martin.Otter@dlr.de>"]
-version = "0.3.4"
+version = "0.3.5"
 
 [deps]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
diff --git a/docs/resources/images/sigTable-line-plots - Kopie.png b/docs/resources/images/sigTable-line-plots - Kopie.png
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -187,6 +187,16 @@ are different to the Python 2.x version.
 
 ## Release Notes
 
+### Version 0.3.5
+
+- @usingPlotPackage(): If SilentNoPlot selected, use "using SignalTables.SilentNoPlot" instead of "import SignalTables.SilentNoPlot: plot ..:".
+- writeSignalTable(..): Arrays get an additional key `layout = "column-major"` to clearly define that storage is in column-major order.
+  Furthermore, if a signal has an *alias* key, then the *values* or *value* array is not stored on file.
+
+**Bug fixes**
+
+- writeSignalTable(..): If arrays or numbers have Unitful units, these units are stripped off and provided via key `unit` as a string.
+
 ### Version 0.3.4
 
 - Bug fix in usePreviousPlotPackage()
diff --git a/examples/fileIO/CSV_ReadFromFile.jl b/examples/fileIO/CSV_ReadFromFile.jl
@@ -0,0 +1,15 @@
+module CSV_ReadFromFile
+
+using  SignalTables
+import CSV
+
+file = joinpath(SignalTables.path, "examples", "fileIO", "Rotational_First.csv")
+println("\n... Read csv file \"$file\"")
+sigTable = CSV.File(file)
+
+println("\n... Show csv file as signal table")
+showInfo(sigTable)
+
+println("\ntime[1:10] = ", getSignal(sigTable, "time")[:values][1:10])
+
+end
diff --git a/examples/fileIO/JSON_WriteToFile.jl b/examples/fileIO/JSON_WriteToFile.jl
@@ -1,16 +1,9 @@
 module JSON_WriteToFile
 
-using  SignalTables
-import JSON
+using SignalTables
 
 sigTable = getSignalTableExample("VariousTypes")
-
-open("VariousTypes_prettyPrint.json", "w") do io
-    JSON.print(io, sigTable, 2)
-end
-
-open("VariousTypes_compact.json", "w") do io
-    JSON.print(io, sigTable)
-end
+writeSignalTable("VariousTypes_prettyPrint.json", sigTable; indent=2, log=true)
+writeSignalTable("VariousTypes_compact.json"    , sigTable)
 
 end
diff --git a/examples/fileIO/JSON_WriteToString.jl b/examples/fileIO/JSON_WriteToString.jl
@@ -1,11 +1,8 @@
 module JSON_WriteToString
 
-using  SignalTables
-import JSON
+using SignalTables
 
-sigTable = getSignalTableExample("VariousTypes")
-str = JSON.json(sigTable)
-
-println("VariousType string = \n", str)
+str = signalTableToJSON( getSignalTableExample("VariousTypes") )
+println(str)
 
 end
diff --git a/examples/fileIO/Rotational_First.csv b/examples/fileIO/Rotational_First.csv
diff --git a/examples/fileIO/_include_all.jl b/examples/fileIO/_include_all.jl
@@ -0,0 +1,4 @@
+
+include("JSON_WriteToFile.jl")
+include("JSON_WriteToString.jl")
+
diff --git a/src/ExampleSignalTables.jl b/src/ExampleSignalTables.jl
@@ -129,7 +129,7 @@ elseif signalTableName == "VariousTypes"
     "time"        => Var(values= t, unit="s", independent=true),
     "load.r"      => Var(values= [sin.(t) cos.(t) sin.(t)], unit="m"),
     "motor.angle" => Var(values= sin.(t), unit="rad", state=true, der="motor.w"),
-    "motor.w"     => Var(values= cos.(t), unit="rad/s"),
+    "motor.w"     => Var(values= cos.(t), unit="rad/s", state=true, start=1.0u"rad/s"),
     "motor.w_ref" => Var(values= 0.9*[sin.(t) cos.(t)], unit = ["rad", "1/s"],
                                  info="Reference angle and speed"),
     "wm"          => Var(alias = "motor.w"),
diff --git a/src/NoPlot.jl b/src/NoPlot.jl
@@ -3,6 +3,8 @@
 
 module NoPlot
 
+export plot, showFigure, saveFigure, closeFigure, closeAllFigures
+
 include("AbstractPlotInterface.jl")
 
 plot(signalTable, names::AbstractMatrix; heading::AbstractString="", grid::Bool=true, xAxis="time",
diff --git a/src/PlotPackageDefinition.jl b/src/PlotPackageDefinition.jl
@@ -19,7 +19,7 @@ macro usingPlotPackage()
         elseif PlotPackage == "NoPlot"
             @goto USE_NO_PLOT
         elseif PlotPackage == "SilentNoPlot"
-            expr = :( import SignalTables.SilentNoPlot: plot, showFigure, saveFigure, closeFigure, closeAllFigures )
+            expr = :( using SignalTables.SilentNoPlot )
             return esc( expr )
         else
             PlotPackage = Symbol("SignalTablesInterface_" * PlotPackage)
@@ -36,7 +36,7 @@ macro usingPlotPackage()
         elseif PlotPackage == "NoPlot"
             @goto USE_NO_PLOT
         elseif PlotPackage == "SilentNoPlot"
-            expr = :( import SignalTables.SilentNoPlot: plot, showFigure, saveFigure, closeFigure, closeAllFigures )
+            expr = :( using SignalTables.SilentNoPlot  )
             return esc( expr )
         else
             PlotPackage = Symbol("SignalTablesInterface_" * PlotPackage)
@@ -51,7 +51,7 @@ macro usingPlotPackage()
     end
 
     @label USE_NO_PLOT
-    expr = :( using SignalTables.SilentNoPlot: plot, showFigure, saveFigure, closeFigure, closeAllFigures )
+    expr = :( using SignalTables.SilentNoPlot )
     println("$expr")
     return esc( expr )
 end
diff --git a/src/SignalTableFunctions.jl b/src/SignalTableFunctions.jl
@@ -684,6 +684,11 @@ function encodeSignalTable(signalTable; signalNames=nothing)
         end
         for name in signalNames
             signal = getSignal(signalTable, name)
+            if haskey(signal, :alias)
+                signal = copy(signal)
+                delete!(signal, :values)
+                delete!(signal, :value)
+            end
             encodedSignal = encodeSignalTableElement(name, signal)
             if !isnothing(encodedSignal)
                 jdict[name] = encodedSignal
@@ -726,22 +731,43 @@ function encodeSignalTableElement(path, element)
         end
         
     elseif typeof(element) <: AbstractArray && (elementBaseType(eltype(element)) <: Number || elementBaseType(eltype(element)) <: String)
-        if ndims(element) == 1 && string(elementBaseType(eltype(element))) in TypesWithoutEncoding 
+        if ndims(element) == 1 && string(eltype(element)) in TypesWithoutEncoding 
             return element
         end
-        jdict = OrderedDict{String,Any}("_class" => "Array", 
-                                        "eltype" => string(eltype(element)), 
-                                        "size"   => Int[i for i in size(element)],
-                                        "values" => reshape(element, length(element)))
+        elunit = unitAsParseableString(element)
+        if elunit == "" 
+            jdict = OrderedDict{String,Any}("_class" => "Array", 
+                                            "eltype" => string(eltype(element)), 
+                                            "size"   => Int[i for i in size(element)],
+                                            "layout" => "column-major",
+                                            "values" => reshape(element, length(element)))
+        else
+            element = ustrip.(element)
+            jdict = OrderedDict{String,Any}("_class" => "Array", 
+                                            "unit"   => elunit,
+                                            "eltype" => string(eltype(element)), 
+                                            "size"   => Int[i for i in size(element)],
+                                            "layout" => "column-major",
+                                            "values" => reshape(element, length(element)))        
+        end
         return jdict
 
     elseif string(typeof(element)) in TypesWithoutEncoding
         return element
 
     elseif typeof(element) <: Number
-        jdict = OrderedDict{String,Any}("_class" => "Number", 
-                                        "type"   => typeof(element), 
-                                        "value"  => element)
+        elunit = unitAsParseableString(element)    
+        if elunit == ""
+            jdict = OrderedDict{String,Any}("_class" => "Number", 
+                                            "type"   => typeof(element), 
+                                            "value"  => element)
+        else
+            element = ustrip.(element)
+            jdict = OrderedDict{String,Any}("_class" => "Number", 
+                                            "unit"   => elunit,
+                                            "type"   => typeof(element), 
+                                            "value"  => element)        
+        end
         return jdict
                                         
     else
diff --git a/src/SignalTables.jl b/src/SignalTables.jl
@@ -1,8 +1,8 @@
 module SignalTables
 
 const path = dirname(dirname(@__FILE__))
-const version = "0.3.2" 
-const version_SignalTable_JSON = "0.3.1"   # version tag to be stored in JSON files
+const version = "0.3.5" 
+const version_SignalTable_JSON = "0.3.5"   # version tag to be stored in JSON files
 
 using  OrderedCollections
 using  Unitful
diff --git a/src/SilentNoPlot.jl b/src/SilentNoPlot.jl
@@ -3,6 +3,8 @@
 
 module SilentNoPlot
 
+export plot, showFigure, saveFigure, closeFigure, closeAllFigures
+
 include("AbstractPlotInterface.jl")
 
 plot(signalTable, names::AbstractMatrix; heading::AbstractString="", grid::Bool=true, xAxis="time",
diff --git a/test/include_all.jl b/test/include_all.jl
@@ -5,6 +5,7 @@ include("SignalTableFunctions/test_DataFrames.jl")
 include("SignalTableFunctions/test_json.jl")
 
 include("../examples/plots/_include_all.jl")
+include("../examples/fileIO/_include_all.jl")
 
 #=
 include("LinePlots/test_06_OneScalarMeasurementSignal.jl")

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
++
 +include("JSON_WriteToFile.jl")
 +include("JSON_WriteToString.jl")
++