Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 0da16df

Browse files
MartinOtterMartinOtter
committed
Documentation improved
1 parent 6f2d329 commit 0da16df

File tree

5 files changed

+208
-106
lines changed

5 files changed

+208
-106
lines changed

‎Project.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "ModiaResult"
22
uuid = "16a87621-1533-42f6-8e19-4a825980cec2"
33
authors = ["[email protected] <[email protected]>"]
4-
version = "0.3.7"
4+
version = "0.3.8"
55

66
[deps]
77
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"

‎README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,28 @@ generate the following plot:
7070
![SegmentedSignalsPlot](docs/resources/images/segmented-signals-plot.png)
7171

7272

73+
# Abstract Result Interface
74+
75+
For every result data structure a few access functions have to be defined
76+
(for details see Abstract Interface](https://modiasim.github.io/ModiaResult.jl/stable/AbstractInterface.html)).
77+
Most importantly:
78+
79+
80+
```
81+
(timeSignal, signal, signalType) = ModiaResult.rawSignal(result, name)
82+
```
83+
84+
Given the result data structure `result` and a variable `name::AbstractString`,
85+
return the result values of the independent variable (= `timeSignal`), the
86+
corresponding result values of the variable (= `signal`) and the type
87+
of the signal. The following figure sketches the returned `timeSignal` and `signal` data structures:
88+
89+
![SignalDefinition](docs/resources/images/signal-definition.png)
90+
91+
Other signal types might be mapped to this basic signal type by introducing views.
92+
93+
94+
7395
## Main developer
7496

7597
[Martin Otter](https://rmc.dlr.de/sr/en/staff/martin.otter/),

‎docs/src/index.md‎

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ CurrentModule = ModiaResult
55
```
66

77
Package [ModiaResult](https://github.com/ModiaSim/ModiaResult.jl) defines
8-
an abstract interface for **simulation results** and provides overloaded methods for:
8+
an abstract interface for **simulation results** with a potentially segmented
9+
time axis (on different segments of the time axis, different variables might be defined)
10+
and provides overloaded methods for:
911

1012
- Dictionaries with String keys,
1113

@@ -33,6 +35,51 @@ More details:
3335
- [Internal](Internal.html)
3436

3537

38+
## Example
39+
40+
Assume that the result data structure is available, then the following commands
41+
42+
43+
```julia
44+
import ModiaResult
45+
46+
# Define plotting software globally
47+
ModiaResult.activate("PyPlot") # or ENV["MODIA_PLOT"] = "PyPlot"
48+
49+
# Execute "using ModiaPlot_<globally defined plot package>"
50+
ModiaResult.@usingModiaPlot # = "using ModiaPlot_PyPlot"
51+
52+
# Generate line plots
53+
plot(result, [("sigA", "sigB", "sigC"), "r[2:3]"])
54+
```
55+
56+
generate the following plot:
57+
58+
![SegmentedSignalsPlot](../resources/images/segmented-signals-plot.png)
59+
60+
61+
## Abstract Result Interface
62+
63+
For every result data structure a few access functions have to be defined
64+
(for details see [Abstract Interface](AbstractInterface.html)).
65+
Most importantly:
66+
67+
68+
```
69+
(timeSignal, signal, signalType) = ModiaResult.rawSignal(result, name)
70+
```
71+
72+
Given the result data structure `result` and a variable `name::AbstractString`,
73+
return the result values of the independent variable (= `timeSignal`), the
74+
corresponding result values of the variable (= `signal`) and the type
75+
of the signal `signalType::`[`SignalType`](@ref)).
76+
The following figure sketches the returned `timeSignal` and `signal` data structures:
77+
78+
![SignalDefinition](../resources/images/signal-definition.png)
79+
80+
Other signal types might be mapped to this basic signal type by introducing views.
81+
82+
3683
## Installation
3784

3885
All packages are registered and are installed with:
@@ -91,6 +138,29 @@ are different to the Python 2.x version.
91138

92139
## Release Notes
93140

141+
### Version 0.3.8
142+
143+
- Better handling if some input arguments are `nothing`.
144+
- Bug corrected when accessing a vector element, such as `mvec[2]`.
145+
- Documentation slightly improved.
146+
147+
148+
### Version 0.3.7
149+
150+
- Replaced Point2f0 by Makie_Point2f that needs to be defined according to the newest Makie version.
151+
152+
153+
### Version 0.3.6
154+
155+
- Adapt to MonteCarloMeasurements, version >= 1.0 (e.g. pmean(..) instead of mean(..))
156+
- Remove test_71_Tables_Rotational_First.jl from runtests.jl, because "using CSV"
157+
(in order that CSV.jl does not have to be added to the Project.toml file)
158+
159+
160+
### Version 0.3.5
161+
162+
- Project.toml: Added version 1 of MonteCarloMeasurements.
163+
94164

95165
### Version 0.3.4
96166

0 commit comments

Comments
 (0)