Skip to content

Commit 514cd58

Browse files
author
Levi Jamt
authored
changing titles #68 (#71)
* changing titles #68 * lower case
1 parent 46589b2 commit 514cd58

12 files changed

+30
-34
lines changed

cosim-cli.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: "cosim"
3+
title: "Command line interface"
44
permalink: /cosim
55
has_toc: false
66
nav_order: 2
@@ -13,8 +13,8 @@ nav_order: 2
1313
</b>
1414
</div>
1515

16-
# cosim
17-
`cosim` is a command-line interface (CLI) to libcosim for the cases where a graphical user interface is not available or needed. It facilitates for running co-simulations of systems configured with SSP or MSMI.
16+
# Command line interface
17+
`cosim` is a command line interface (CLI) to libcosim for the cases where a graphical user interface is not available or needed. It facilitates for running co-simulations of systems configured with SSP or MSMI.
1818
It has three primary use cases:
1919

2020
- Running simulations from other programs or scripts

cosim-demo-app/cosim-demo-app.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: "cosim demo app"
3+
title: "Demo application"
44
has_children: true
55
permalink: /cosim-demo-app/cosim-demo-app
66
has_toc: false
@@ -14,9 +14,9 @@ nav_order: 3
1414
</b>
1515
</div>
1616

17-
# cosim demo app
17+
# Demo application
1818

19-
Load a configuration, control the simulation or explore in a easy way some of the features included in libcosim. The demo application was developed to showcase how the library can be used in an application and to provide a graphical user interface to manage co-simulations.
19+
Load a configuration, control the simulation or explore in a easy way some of the features included in `libcosim`. The `cosim demo app` was developed to showcase how the library can be used in an application and to provide a graphical user interface to manage co-simulations.
2020

2121
There are options for real time execution or simulation in free mode (as fast as the hardware allows). During simulation, the user can observe simulation variables, manipulate these and visualise the results in charts.
2222
A scenario management feature allows change of the simulation variables automatically based on a scenario file. It is also possible to log to file the simulation variable values of all models.

cosim-demo-app/user-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: default
33
title: "User guide"
44
permalink: /cosim-demo-app/user-guide
55
has_toc: false
6-
parent: "cosim demo app"
6+
parent: "Demo application"
77
---
88

99
# User guide

cosim4j.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: "java wrapper"
3+
title: "Java wrapper"
44
permalink: /cosim4j
55
has_toc: false
66
nav_order: 4
@@ -12,12 +12,12 @@ nav_order: 4
1212
</b>
1313
</div>
1414

15-
# Java Wrapper
16-
The Java wrapper - _cosim4j_ - enables Java applications to make use of _libcosim_.
17-
It uses the Java Native Interface (JNI) to efficiently interact with _libcosim_.
15+
# Java wrapper
16+
The Java wrapper `cosim4j` enables Java applications to make use of `libcosim`.
17+
It uses the Java Native Interface (JNI) to efficiently interact with `libcosim`.
1818
To make it accessible, all native dependencies for Linux and Windows have been pre-built and are bundled with the library.
1919

20-
A highly convenient and powerful feature found in _cosim4j_
20+
A highly convenient and powerful feature found in `cosim4j`
2121
is the ability to write inline FMI 2.0 compatible models
2222
using Java, i.e., models can be written as regular Java
2323
code that can be added directly to the simulation without first

demo-cases.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: "Demo Cases"
3+
title: "Example configurations"
44
has_children: true
55
permalink: /demo-cases
66
nav_order: 5
@@ -13,12 +13,8 @@ has_toc: false
1313
</b>
1414
</div>
1515

16-
# Demo Cases
17-
16+
# Example configurations
17+
Demonstration cases including simulation models and configuration with OSP-IS and SSP:
1818
- [DPShip](./cosim-demo-app/DPShip)
1919
- [Quarter-Truck](./cosim-demo-app/Quarter-Truck)
20-
- [House](./cosim-demo-app/House)
21-
22-
23-
## Demo simulation models
24-
The above demo models can be downloaded from [here](https://github.com/open-simulation-platform/cse-demos).
20+
- [House](./cosim-demo-app/House)

downloads.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can use this page to download:
1414
- [cosim (command line interface)](https://github.com/open-simulation-platform/cse-cli/releases)
1515
- [cosim demo app](https://github.com/open-simulation-platform/cosim-demo-app/releases)
1616
- [cosim4j (java wrapper)](https://github.com/open-simulation-platform/cosim4j/releases)
17-
- [demo simulation models](https://github.com/open-simulation-platform/cse-demos/releases)
17+
- [demo simulation models](https://github.com/open-simulation-platform/demo-cases/releases)
1818
- [OSP validator](https://github.com/open-simulation-platform/msmi-validator/releases)
1919
- [kopl - windows](https://mooropt2.marintek.sintef.no/nexus/content/repositories/thirdparty/no/sintef/ocean/kopl/kopl/1.0.0/kopl-1.0.0-win32.x86_64.zip)
2020
- [kopl - linux (experimental)](https://mooropt2.marintek.sintef.no/nexus/content/repositories/thirdparty/no/sintef/ocean/kopl/kopl/1.0.0/kopl-1.0.0-linux.gtk.x86_64.zip)

kopl.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: default
3-
title: "Kopl configurator"
3+
title: "Configuration tool"
44
permalink: /kopl
55
has_toc: false
66
nav_order: 7
77
---
88

9-
# Kopl configurator
10-
Kopl is a configurator to help set up and run a simulation. It can also be used to validate the model using the [MSMI validator](./model-interface-validator).
11-
Kopl is not an open source software but can be freely used without any restrictions.
9+
# Configuration tool
10+
`Kopl` is a configurator to help set up and run a simulation. It can also be used to validate the model using the [MSMI validator](./model-interface-validator).
11+
`Kopl` is not an open source software but can be freely used without any restrictions.
1212

1313
<figure>
1414
<img src="/assets/img/Kopl.png">
@@ -22,8 +22,8 @@ Kopl is not an open source software but can be freely used without any restricti
2222

2323
# How to get started
2424

25-
* Get the appropriate version of Kopl [here](./downloads).
26-
* Unzip somewhere on disk and double click the kopl executable
25+
* Get the appropriate version of `Kopl` [here](./downloads).
26+
* Unzip somewhere on disk and double click the `Kopl` executable
2727
* Choose a location for the workspace (working folder) or just hit OK to use the default workspace
2828
* Right click the navigator area to create a new CoSimulation Task. Give it a name or leave the default
2929
* Create a new configuration which represents a simulation. Right click -> New configuration.
@@ -49,7 +49,7 @@ Just start dragging from an output or input slot and drop when hovering over the
4949

5050
<figure>
5151
<img src="/assets/img/Kopl-variablegroups.png">
52-
<figcaption>Definition of nested variable groups </figcaption>
52+
<figcaption class="caption" >Definition of nested variable groups</figcaption>
5353
</figure>
5454

5555
# MSMI validation

libcosim/configuration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: default
33
title: "Simulation configuration"
44
permalink: /libcosim/configuration
55
has_toc: false
6-
parent: "libcosim"
6+
parent: "Co-simulation C/C++ libraries"
77
nav_order: 1
88
---
99
# Simulation configuration

libcosim/fmuproxy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: default
33
title: "Distributed co-simulation"
44
permalink: /libcosim/fmuproxy
55
has_toc: false
6-
parent: "libcosim"
6+
parent: "Co-simulation C/C++ libraries"
77
nav_order: 4
88
---
99
# Distributed co-simulation

libcosim/libcosim.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: "libcosim"
3+
title: "Co-simulation C/C++ libraries"
44
permalink: /libcosim
55
has_children: true
66
has_toc: false
@@ -16,7 +16,7 @@ nav_order: 1
1616
</b>
1717
</div>
1818

19-
# libcosim
19+
# OSP co-simulation C/C++ libraries
2020
The OSP co-simulation C/C++ libraries that orchestrates the co-simulation of models that conform to the Functional Mock-up Interface (FMI).
2121
`libcosim` is the C++ API and `libcosimc` is a C wrapper for a subset of `libcosim`.
2222

libcosim/logging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: default
33
title: "Results logging"
44
permalink: /libcosim/logging
55
has_toc: false
6-
parent: "libcosim"
6+
parent: "Co-simulation C/C++ libraries"
77
nav_order: 3
88
---
99
# Results logging

libcosim/scenario.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: default
33
title: "Scenario"
44
permalink: /libcosim/scenario
55
has_toc: false
6-
parent: "libcosim"
6+
parent: "Co-simulation C/C++ libraries"
77
nav_order: 2
88
---
99
# Scenario

0 commit comments

Comments
 (0)