You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/src/deprecated.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# deprecated Functions
2
2
3
-
this doc page is necessary as all exported functions must be documented in the manual with documenter configred to check for missing documentation, therefor this hidden page exists
3
+
this doc page is necessary as all exported functions must be documented in the manual with documenter configured to check for missing documentation, therefor this hidden page exists
Copy file name to clipboardexpand all lines: docs/src/features.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ For a more detailed overview, please see the `?FMUExecutionConfig`.
18
18
### Logging FMI-calls
19
19
To log all FMI-calls that happen (including "hidden" calls e.g. if you are using `simulate`) you can enable debugging for *FMICore.jl* using `ENV["JULIA_DEBUG"] = "FMICore"`. This will log any `fmi2xxx`- and `fmi3xxx`-call, including the given parameters and return value. This can be *a lot* of calls, so you may want to redirect your REPL output to file.
20
20
### Printing internal FMU messages
21
-
Many FMUs support for printing debugging messages. To force message printing, you can use the keyword `logginOn=true` either ...
21
+
Many FMUs support for printing debugging messages. To force message printing, you can use the keyword `loggingOn=true` either ...
22
22
- in the call `fmiInstantiate`, for example `fmiInstantiate(myFMU; loggingOn=true)` or
23
23
- as part of the `executionConfig`, for example `myFMU.executionConfig.loggingOn=true`
24
24
You can further control which message types - like `OK`, `Warning`, `Discard`, `Error`, `Fatal`, `Pending` - should be logged by using the keywords `logStatus{TYPE}=true` as part of `fmiInstantiate` or (soon) the execution configuration. By default, all are activated.
@@ -63,7 +63,7 @@ Of course, you have to use the same piece of memory (to write your return values
63
63
**Views:** You can use [array-views](https://docs.julialang.org/en/v1/base/arrays/#Views-(SubArrays-and-other-view-types)) instead of array-slices as input for in-place-functions, which further reduces memory allocations.
64
64
65
65
## AD-Ecosystem (differentiation over FMUs)
66
-
Sensitivites over FMUs are fully integrated into *FMI.jl*, *FMIImport.jl* and *FMIFlux.jl*. Supported are *ForwardDiff.jl* together with all AD-frameworks, that use the interface of *ChainRules.jl* like e.g. *Zygote.jl* and *ReverseDiff.jl*. As a result, you can use implicite solvers or you can use FMUs as part of machine learning applications.
66
+
Sensitivites over FMUs are fully integrated into *FMI.jl*, *FMIImport.jl* and *FMIFlux.jl*. Supported are *ForwardDiff.jl* together with all AD-frameworks, that use the interface of *ChainRules.jl* like e.g. *Zygote.jl* and *ReverseDiff.jl*. As a result, you can use implicit solvers or you can use FMUs as part of machine learning applications.
67
67
68
68
## Watch your progress
69
69
When simulating FMUs with *FMI.jl*, a progress meter is shown per default. You can control the appearance via the keyword argument `showProgress` for `simulate`, `simulateME`, `simulateCS` and `simulateSE`.
Copy file name to clipboardexpand all lines: docs/src/fmi-tool-info.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ FMI3 is for now only beta supported and information will be deployed together wi
7
7
## FMI-2.0
8
8
*FMI.jl* and *FMIImport.jl* are validated by simulating **all valid** FMI2-FMUs from the official [FMI-Cross-Check](https://github.com/modelica/fmi-cross-check) in ME- as well as in CS-Mode, excluding the tools *AMESim*, *Test-FMUs*, *SimulationX* and *Silver*.
9
9
For more information see [our automated GitHub-Action](https://github.com/ThummeTo/FMI.jl/tree/main/cross_checks). The results files - as defined by the FMI Cross Check - can be found in [the forked repository](https://github.com/ThummeTo/fmi-cross-check/tree/master) inside of the corresponding sub folders.
10
-
There are different branches for different OS-configurations avalibale.
10
+
There are different branches for different OS-configurations available.
11
11
12
12
# FMU Export Compatibility information (*FMIExport.jl*)
13
13
Detailed export information and automatically generated FMUs will be deployed soon in the repository.
Copy file name to clipboardexpand all lines: docs/src/fmi2_lowlevel_modeldescription_functions.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Working with the FMI model description
2
2
3
-
The FMI model description provides all human readable information on the model. The following fuctions can be used to obtain all information provided by the model descripton, wich in turn can be extrated from the fmu.
3
+
The FMI model description provides all human readable information on the model. The following functions can be used to obtain all information provided by the model description, which in turn can be extracted from the fmu.
Copy file name to clipboardexpand all lines: docs/src/fmi3_lowlevel_modeldescription_functions.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Working with the FMI model description
2
2
3
-
The FMI model description provides all human readable information on the model. The following fuctions can be used to obtain all information provided by the model descripton, wich in turn can be extrated from the fmu.
3
+
The FMI model description provides all human readable information on the model. The following functions can be used to obtain all information provided by the model description, which in turn can be extracted from the fmu.
0 commit comments