diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 4e0a178..5f70f38 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -19,8 +19,8 @@ A clear and concise description of what you want to happen. A clear and concise description of any alternative solutions or features you have considered. #### Describe the backwards compatibility -How does the feature impact the backwards compatibility of the current major version of OSI Sensor Model Packaging? -If the suggested feature would be implemented would there be an issue with the previous versions of OSI Sensor Model Packaging? What part of OSI Sensor Model Packaging would break or improve by this feature? +How does the feature impact the backwards compatibility of the current major version of OSI Simulation Model Packaging? +If the suggested feature would be implemented would there be an issue with the previous versions of OSI Simulation Model Packaging? What part of OSI Simulation Model Packaging would break or improve by this feature? #### Additional context Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 99c3fa4..45c9134 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -16,7 +16,7 @@ Add @mentions of the person or team responsible for reviewing proposed changes. #### Check the checklist - [ ] I have performed a self-review of my own code. -- [ ] I have made corresponding changes to the [documentation](https://github.com/OpenSimulationInterface/osi-documentation) for osi-sensor-model-packaging. +- [ ] I have made corresponding changes to the [documentation](https://github.com/OpenSimulationInterface/osi-documentation) for osi-simulation-model-packaging. - [ ] My changes generate no new warnings. - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] New and existing unit tests / Github Actions pass locally with my changes. \ No newline at end of file diff --git a/README.md b/README.md index bc3bec1..f178bae 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ -# OSI Sensor Model Packaging +# OSI Simulation Model Packaging -[![ProtoBuf CI Builds](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/actions/workflows/protobuf.yml/badge.svg)](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/actions/workflows/protobuf.yml) +[![ProtoBuf CI Builds](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/actions/workflows/protobuf.yml/badge.svg)](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/actions/workflows/protobuf.yml) -OSI Sensor Model Packaging specifies ways in which models (like e.g. environmental effect models, sensor models and logical models) using the [Open Simulation Interface (OSI)][] are to be packaged for their use in simulation environments using FMI 2.0. -The specification can be found in the [doc/osi-sensor-model-packaging_spec.adoc](doc/osi-sensor-model-packaging_spec.adoc) document in this repository. +OSI Simulation Model Packaging specifies ways in which models (like e.g. environmental effect models, sensor models and logical models) using the [Open Simulation Interface (OSI)][] are to be packaged for their use in simulation environments using FMI 2.0. +The specification can be found in the [doc/osi-simulation-model-packaging_spec.adoc](doc/osi-simulation-model-packaging_spec.adoc) document in this repository. -For more detailed information see the [official documentation](https://opensimulationinterface.github.io/osi-documentation/#_osi_sensor_model_packaging). +For more detailed information see the [official documentation](https://opensimulationinterface.github.io/osi-documentation/#_osi_simulation_model_packaging). [Open Simulation Interface (OSI)]: https://github.com/OpenSimulationInterface/open-simulation-interface ## Usage -The examples in the directory [`examples`](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/tree/master/examples) of this repository can be built using CMake. They require that the open-simulation-interface submodule of the repository is populated. +The examples in the directory [`examples`](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/tree/master/examples) of this repository can be built using CMake. They require that the open-simulation-interface submodule of the repository is populated. -The [`OSMPDummySource`](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/tree/master/examples/OSMPDummySource) example can be used as a simplistic source of SensorView (including GroundTruth) data, that can be connected to the input of an OSMPDummySensor model, for simple testing and demonstration purposes. +The [`OSMPDummySource`](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/tree/master/examples/OSMPDummySource) example can be used as a simplistic source of SensorView (including GroundTruth) data, that can be connected to the input of an OSMPDummySensor model, for simple testing and demonstration purposes. -The [`OSMPCNetworkProxy`](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/tree/master/examples/OSMPCNetworkProxy) example demonstrates a simple C network proxy that can send and receive OSI data via TCP sockets. +The [`OSMPCNetworkProxy`](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/tree/master/examples/OSMPCNetworkProxy) example demonstrates a simple C network proxy that can send and receive OSI data via TCP sockets. -The [`OSMPDummySensor`](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/tree/master/examples/OSMPDummySensor) example can be used as a simple dummy sensor model, demonstrating the use of OSI for sensor models consuming SensorView data and generating SensorData output. +The [`OSMPDummySensor`](https://github.com/OpenSimulationInterface/osi-simulation-model-packaging/tree/master/examples/OSMPDummySensor) example can be used as a simple dummy sensor model, demonstrating the use of OSI for sensor models consuming SensorView data and generating SensorData output. ## Installation ##### Dependencies @@ -32,8 +32,8 @@ $ sudo apt-get install libprotobuf-dev protobuf-compiler ##### Build examples ```bash -$ git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git -$ cd osi-sensor-model-packaging +$ git clone https://github.com/OpenSimulationInterface/osi-simulation-model-packaging.git +$ cd osi-simulation-model-packaging $ git submodule update --init $ cd examples $ mkdir -p build diff --git a/doc/misc/example.adoc b/doc/misc/example.adoc index 65a4b1f..7ad5e33 100644 --- a/doc/misc/example.adoc +++ b/doc/misc/example.adoc @@ -8,7 +8,7 @@ The example describes a sensor model FMU with one input, one output, and no addi - + - + - + - + - + - + - + diff --git a/doc/misc/introduction.adoc b/doc/misc/introduction.adoc index acc4345..ad7043d 100644 --- a/doc/misc/introduction.adoc +++ b/doc/misc/introduction.adoc @@ -1,6 +1,6 @@ = Introduction -_OSI Sensor Model Packaging_ (OSMP) is a package layer specification for the _Open Simulation Interface_ (OSI). +_OSI Simulation Model Packaging_ (OSMP) is a package layer specification for the _Open Simulation Interface_ (OSI). It specifies how models that use OSI are packaged as _Functional Mock-up Units_ (FMUs) in accordance with the _Functional Mock-up Interface 2.0_ (FMI 2.0). This is version 1.2.0 of this specification. The version number is to be diff --git a/doc/osi-sensor-model-packaging_spec.adoc b/doc/osi-sensor-model-packaging_spec.adoc index 201cda0..fea4de6 100644 --- a/doc/osi-sensor-model-packaging_spec.adoc +++ b/doc/osi-sensor-model-packaging_spec.adoc @@ -15,7 +15,7 @@ include::{asciidoc-resources}/preamble.adoc[] endif::[] -= OSI Sensor Model Packaging += OSI Simulation Model Packaging include::./misc/introduction.adoc[leveloffset=+1] diff --git a/doc/setup/build_install_example.adoc b/doc/setup/build_install_example.adoc index de3aa23..e641f5e 100644 --- a/doc/setup/build_install_example.adoc +++ b/doc/setup/build_install_example.adoc @@ -22,13 +22,13 @@ Demonstrates a simple C network proxy that can send and receive OSI data via TCP . Clone the OSMP repository. + ---- -git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git +git clone https://github.com/OpenSimulationInterface/osi-simulation-model-packaging.git ---- + . Switch to the OSMP repository. + ---- -cd osi-sensor-model-packaging +cd osi-simulation-model-packaging ---- + . Update and initialize the OSI submodule. diff --git a/doc/spec/basic_conventions.adoc b/doc/spec/basic_conventions.adoc index 7cd646c..d956959 100644 --- a/doc/spec/basic_conventions.adoc +++ b/doc/spec/basic_conventions.adoc @@ -7,7 +7,7 @@ The following annotation shall be placed into the `` element [source,xml] ---- - + ---- The `@osi-version` attribute should contain the major, minor, and patch version number of the OSI specification that this model was compiled against. diff --git a/doc/spec/binary_variables.adoc b/doc/spec/binary_variables.adoc index 287b37e..c2245d1 100644 --- a/doc/spec/binary_variables.adoc +++ b/doc/spec/binary_variables.adoc @@ -35,7 +35,7 @@ The three actual variables shall contain an annotation of the following form in [source,xml] ---- - + ---- `` is the prefix as defined above, and `@role` is either `base.lo`, `base.hi`, or `size`, depending on the variable. diff --git a/examples/OSMPCNetworkProxy/modelDescription.in.xml b/examples/OSMPCNetworkProxy/modelDescription.in.xml index 61bb1cd..7948c14 100644 --- a/examples/OSMPCNetworkProxy/modelDescription.in.xml +++ b/examples/OSMPCNetworkProxy/modelDescription.in.xml @@ -24,43 +24,43 @@ - + - + - + - + - + - + - + diff --git a/examples/OSMPDummySensor/modelDescription.in.xml b/examples/OSMPDummySensor/modelDescription.in.xml index 4b52941..9f6f568 100644 --- a/examples/OSMPDummySensor/modelDescription.in.xml +++ b/examples/OSMPDummySensor/modelDescription.in.xml @@ -3,7 +3,7 @@ fmiVersion="2.0" modelName="OSMP Dummy Sensor FMU" guid="@FMUGUID@" - description="Demonstration C++ Sensor FMU for OSI Sensor Model Packaging" + description="Demonstration C++ Sensor FMU for OSI Simulation Model Packaging" author="PMSF" version="@OSMPVERSION@" generationTool="PMSF Manual FMU Framework" @@ -24,79 +24,79 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/examples/OSMPDummySource/modelDescription.in.xml b/examples/OSMPDummySource/modelDescription.in.xml index a7502ce..bb6bcb0 100644 --- a/examples/OSMPDummySource/modelDescription.in.xml +++ b/examples/OSMPDummySource/modelDescription.in.xml @@ -3,7 +3,7 @@ fmiVersion="2.0" modelName="OSMP Dummy Source FMU" guid="@FMUGUID@" - description="Demonstration C++ SensorView Source FMU for OSI Sensor Model Packaging" + description="Demonstration C++ SensorView Source FMU for OSI Simulation Model Packaging" author="PMSF" version="@OSMPVERSION@" generationTool="PMSF Manual FMU Framework" @@ -24,25 +24,25 @@ - + - + - + - + diff --git a/examples/README.md b/examples/README.md index c21ecdc..586f9b3 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,4 +1,4 @@ -OSI Sensor Model Packaging Examples +OSI Simulation Model Packaging Examples =================================== The examples in this directory can be built using CMake. diff --git a/osmp.xsd b/osmp.xsd index fbf8961..fed1571 100644 --- a/osmp.xsd +++ b/osmp.xsd @@ -1,7 +1,7 @@