|
|
@@ -16,19 +16,27 @@ Windows/Linux platform.
|
|
|
|
|
|
In order to setup the framework, you need follow these steps:
|
|
|
|
|
|
-1. Install Eclipse IDE for RCP and RAP Developers
|
|
|
+1. Install Eclipse IDE for RCP and RAP Developers.
|
|
|
Version: Photon Release (4.8.0)
|
|
|
-1. Install Xtend (Version 2.16)
|
|
|
- Using Install new software in Help tab of eclipse
|
|
|
-1. Install Xcore (Version 1.6)
|
|
|
- Using Install new software in Help tab of eclipse
|
|
|
-1. [Optional] Install Maven (Version 3.6)
|
|
|
+1. Install Xtend (Version 2.16 or 2.17).
|
|
|
+ Using Install new software in Help tab of eclipse.
|
|
|
+1. Install Xcore (Version 1.6).
|
|
|
+ Using Install new software in Help tab of eclipse.
|
|
|
+ Xcore will be part of the Xtend.
|
|
|
+ The Xtend repository should be available in the "Work with" dropdown.
|
|
|
+ Either enter "Xcore" in the filter field or locate "Modeling → EMF - Eclipse Modeling Framework Xcore SDK" in the content and check mark it.
|
|
|
+1. Install Maven (Version 3.6), or m2e (Version 1.5)
|
|
|
|
|
|
### Building and Testing
|
|
|
|
|
|
-The build can be done in both Eclipse and Maven.
|
|
|
-Likewise, tests are run using either Eclipse (Junit 4) or Maven.
|
|
|
-We recommend running the Eclipse plugin tests.
|
|
|
+The build can be done in both Eclipse and Maven.
|
|
|
+Start with build project with Maven.
|
|
|
+For this purpose run following command in the project root folder:
|
|
|
+```
|
|
|
+mvn install
|
|
|
+```
|
|
|
+Then you have to test application in Eclipse environment with JUnit.
|
|
|
+We recommend running the Eclipse JUnit plug-in tests as well.
|
|
|
|
|
|
Maven command:
|
|
|
|
|
|
@@ -38,11 +46,13 @@ mvn install
|
|
|
|
|
|
### Exporting an Application
|
|
|
|
|
|
-The binaries are exported as an Eclipse RCP Application.
|
|
|
The file `HintCO.product` contains all the information.
|
|
|
+Click on Exporting and Eclipse product.
|
|
|
+The binaries are exported as an Eclipse RCP Application.
|
|
|
|
|
|
## Running the Application
|
|
|
|
|
|
+Copy FMUs and XMI file in the exported directory.
|
|
|
To get help on the API:
|
|
|
```
|
|
|
hintco -h
|
|
|
@@ -54,6 +64,7 @@ hintco -s .\watertanks.xmi -o output -n 1
|
|
|
```
|
|
|
Where `.\watertanks.xmi` can be found in `examples`, and `output` is where the results will be generated.
|
|
|
The fmus are assumed to be in a `resources` folder, in the same directory as the binary `hintco`.
|
|
|
+We recommend using `eclipsec.exe` by copying it from Eclipse IDE for RCP and RAP Developers folder and paste it in the export directory.
|
|
|
|
|
|
An helper script under `scripts` is provided, to create pdfs for the plots produced:
|
|
|
```
|
|
|
@@ -71,3 +82,20 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
|
|
|
## License
|
|
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details
|
|
|
+
|
|
|
+## Paper
|
|
|
+
|
|
|
+If you use the HintCO, please cite our paper.
|
|
|
+
|
|
|
+HintCO – Hint-Based Configuration of Co-Simulations.
|
|
|
+Cláudio Gomes, Bentley James Oakes, Mehrdad Moradi, Alejandro Torres Gámiz, Juan Carlos Mendo, Stefan Dutré, Joachim Denil, Hans Vangheluwe. SIMULTECH 2019.
|
|
|
+```
|
|
|
+@inproceedings{Gomes2019,
|
|
|
+ address = {{Prague, Czech Republic}},
|
|
|
+ title = {{{HintCO}} - {{Hint}}-{{Based Configuration}} of {{Co}}-{{Simulations}}},
|
|
|
+ booktitle = {International {{Conference}} on {{Simulation}} and {{Modeling Methodologies}}, {{Technologies}} and {{Applications}}},
|
|
|
+ author = {Gomes, Cl{\'a}udio and Oakes, Bentley James and Moradi, Mehrdad and Gamiz, Alejandro Torres and Mendo, Juan Carlos and Dutre, Stefan and Denil, Joachim and Vangheluwe, Hans},
|
|
|
+ year = {2019},
|
|
|
+ pages = {accepted},
|
|
|
+}
|
|
|
+```
|
Claudio Gomes