Skip to content

Commit

Permalink
Correct docu
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinOtter committed Mar 1, 2024
1 parent e8cd9c5 commit 1754de7
Show file tree
Hide file tree
Showing 18 changed files with 14 additions and 18 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ plot(sigTable, [("sigC", "load.r[2:3]"), ("sigB", "sigD")]) # generate plots

generate the following plot:

![Plots of SigTable](https://modiasim.github.io/SignalTables.jl/resources/images/sigTable-line-plots.png)
![Plots of SigTable](https://modiasim.github.io/SignalTables.jl/docs/resources/images/sigTable-line-plots.png)

*Concrete implementations* of the [Abstract Signal Table Interface](https://modiasim.github.io/SignalTables.jl/stable/Internal/AbstractSignalTableInterface.html) are provided for:

Expand Down
6 changes: 3 additions & 3 deletions docs/src/Examples/FileIO.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ writeSignalTable("VariousTypes_compact.json" , sigTable)

results in the following files

- [VariousTypes_prettyPrint.json](../../resources/examples/fileIO/VariousTypes_prettyPrint.json).
- [VariousTypes_compact.json](../../resources/examples/fileIO/VariousTypes_compact.json).
- [VariousTypes_prettyPrint.json](../resources/examples/fileIO/VariousTypes_prettyPrint.json).
- [VariousTypes_compact.json](../resources/examples/fileIO/VariousTypes_compact.json).


## JSON - Write to String
Expand Down Expand Up @@ -56,7 +56,7 @@ save( File(format"JLD", "VariousTypes.jld"), sigTable)

results in the following file:

- [VariousTypes.jld](../../resources/examples/fileIO/VariousTypes.jld).
- [VariousTypes.jld](../resources/examples/fileIO/VariousTypes.jld).



Expand Down
16 changes: 8 additions & 8 deletions docs/src/Examples/Plots.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ results in:
phi (100,) Float64 Var
```

![OneScalarSignal](../../resources/examples/plots/OneScalarSignal.png)
![OneScalarSignal](../resources/examples/plots/OneScalarSignal.png)



Expand Down Expand Up @@ -61,7 +61,7 @@ results in:
phi "rad" (100,) Float64 Var
```

![OneScalarSignalWithUnit](../../resources/examples/plots/OneScalarSignalWithUnit.png)
![OneScalarSignalWithUnit](../resources/examples/plots/OneScalarSignalWithUnit.png)


## OneVectorSignalWithUnit
Expand Down Expand Up @@ -90,7 +90,7 @@ results in:
r "m" (100,3) Float64 Var
```

![OneVectorSignalWithUnit](../../resources/examples/plots/OneVectorSignalWithUnit.png)
![OneVectorSignalWithUnit](../resources/examples/plots/OneVectorSignalWithUnit.png)


## OneMatrixSignal
Expand Down Expand Up @@ -126,7 +126,7 @@ results in:
matrix (10,2,3) Float64 Var
```

![OneMatrixSignal](../../resources/examples/plots/OneMatrixSignal.png)
![OneMatrixSignal](../resources/examples/plots/OneMatrixSignal.png)


## OneMatrixSignalWithMatrixUnits
Expand Down Expand Up @@ -163,7 +163,7 @@ results in:
matrix ["m" "m/s" "m/s^2"; "rad" "rad/s" "rad/s^2"] (10,2,3) Float64 Var
```

![OneMatrixSignalWithMatrixUnits](../../resources/examples/plots/OneMatrixSignalWithMatrixUnits.png)
![OneMatrixSignalWithMatrixUnits](../resources/examples/plots/OneMatrixSignalWithMatrixUnits.png)


## ConstantSignals
Expand Down Expand Up @@ -208,7 +208,7 @@ results in:
matrix3 ["m" "m/s" "m/s^2"; "rad" "rad/s" "rad/s^2"] (2,3) Float64 Par alias="matrix1"
```

![ConstantSignals](../../resources/examples/plots/ConstantSignals.png)
![ConstantSignals](../resources/examples/plots/ConstantSignals.png)


# MissingValues
Expand Down Expand Up @@ -262,7 +262,7 @@ results in:
sigD "rad/s" (153,) Union{Missing,Float64} Var variability="clocked", info="Motor angular velocit…
```
![MissingValues](../../resources/examples/plots/MissingValues.png)
![MissingValues](../resources/examples/plots/MissingValues.png)
# VariousTypes
Expand Down Expand Up @@ -313,5 +313,5 @@ results in:
attributes Par info="This is a test signal table"
```
![VariousTypes](../../resources/examples/plots/VariousTypes.png)
![VariousTypes](../resources/examples/plots/VariousTypes.png)
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ attributes Map experiment=Map(st


The various Julia FileIO functions can be directly used to save a signal table
in various formats, e.g. JSON or HDF5 (see [FileIO Examples](@ref), [json file of sigTable above](../resources/examples/fileIO/VariousTypes_prettyPrint.json) ).
in various formats, e.g. JSON or HDF5 (see [FileIO Examples](@ref), [json file of sigTable above](./resources/examples/fileIO/VariousTypes_prettyPrint.json) ).

The commands

Expand All @@ -90,7 +90,7 @@ plot(sigTable, [("sigC", "load.r[2:3]"), ("sigB", "sigD")])

generate the following plot:

![Plots of SigTable](../resources/images/sigTable-line-plots.png)
![Plots of SigTable](./resources/images/sigTable-line-plots.png)


## Abstract Interfaces
Expand Down
File renamed without changes
4 changes: 0 additions & 4 deletions src/AbstractPlotInterface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,6 @@ plot(result, "w", xAxis="phi", figure=7)
result["phi"] = 0.5*result["phi"];
plot(result, "phi", prefix="Sim 2: ", reuse=true)
```
Example of a matrix of plots:
![Matrix of plots](../../resources/images/matrix-of-plots.png)
"""
plot(result, names::AbstractString; kwargs...) = plot(result, [names] ; kwargs...)
plot(result, names::Symbol ; kwargs...) = plot(result, [string(names)]; kwargs...)
Expand Down

0 comments on commit 1754de7

Please sign in to comment.