diff --git a/documentation/images/dymola/01_loadopenipsl.png b/documentation/images/dymola/01_loadopenipsl.png new file mode 100644 index 0000000..f674633 Binary files /dev/null and b/documentation/images/dymola/01_loadopenipsl.png differ diff --git a/documentation/images/dymola/02_loadpackage.png b/documentation/images/dymola/02_loadpackage.png new file mode 100644 index 0000000..baebf0a Binary files /dev/null and b/documentation/images/dymola/02_loadpackage.png differ diff --git a/documentation/images/dymola/03_check.png b/documentation/images/dymola/03_check.png new file mode 100644 index 0000000..0300301 Binary files /dev/null and b/documentation/images/dymola/03_check.png differ diff --git a/documentation/images/dymola/04_log.png b/documentation/images/dymola/04_log.png new file mode 100644 index 0000000..8cdb8cf Binary files /dev/null and b/documentation/images/dymola/04_log.png differ diff --git a/documentation/images/dymola/05_simulationmodel.png b/documentation/images/dymola/05_simulationmodel.png new file mode 100644 index 0000000..ee9b4f8 Binary files /dev/null and b/documentation/images/dymola/05_simulationmodel.png differ diff --git a/documentation/images/dymola/06_simulate.png b/documentation/images/dymola/06_simulate.png new file mode 100644 index 0000000..c121902 Binary files /dev/null and b/documentation/images/dymola/06_simulate.png differ diff --git a/documentation/images/dymola/07_simoutput.png b/documentation/images/dymola/07_simoutput.png new file mode 100644 index 0000000..8694b1d Binary files /dev/null and b/documentation/images/dymola/07_simoutput.png differ diff --git a/documentation/t.tree b/documentation/t.tree index 7b3c840..39a47eb 100644 --- a/documentation/t.tree +++ b/documentation/t.tree @@ -10,6 +10,7 @@ + \ No newline at end of file diff --git a/documentation/topics/Open-and-Simulate-in-Dymola.md b/documentation/topics/Open-and-Simulate-in-Dymola.md new file mode 100644 index 0000000..6e8f797 --- /dev/null +++ b/documentation/topics/Open-and-Simulate-in-Dymola.md @@ -0,0 +1,60 @@ +# Open and Simulate in Dymola + +The output files from the translation are located in the <>output' folder can be opened in any Modelica IDE. [Dymola](https://dymola.com/) will be used for this example. + + +## Before you start + +Make sure that: +- You have cloned the [repository](https://github.com/alSETLab/XSLTConferencePaper/). +- Install [Dymola](https://discover.3ds.com/free-trial-version-of-dymola-for-windows). To complete the steps below successfully you will need to have a license, you can get one [here](https://www.claytex.com/about-us/contact-us/). +- Download the OpenIPSL library version 3.0.1 from this [link](https://github.com/OpenIPSL/OpenIPSL/releases/tag/v3.0.1). Uncrompress the .zip file and place it in a folder where you have read/write rights, e.g., ./Documents/Dymola/ + +## Load and ``Check'' the Model + +Before simulating a Modelica model, it is necessary to determine if the model is sytactically and sematically valid. This is carried out below for a test model. + +1. Open Dymola + + ```bash + Start -> All apps -> Dymola 2024x + ``` + +2. Load the OpenIPSL library + + ```bash + File -> Open -> Load... + ``` + ![Dymola Load](../images/dymola/01_loadopenipsl.png) + + Browse to the location where you have saved OpenIPSL. Selecte the package.mo, from ./YourFolderWithOpenIPSL/OpenIPSL/package.mo file and click on Open. + + ![Dymola Load Package](../images/dymola/02_loadpackage.png) + + +3. Load the ieee14.mo file + ```bash + File -> Open -> Load... + Find 'ieee14.mo' in the 'XSLTConferencePaper/output' folder. + ``` + +4. Locate the ieee14_package under the 'Projects Browser' of Dymola. Tip it over and double-click 'ieee14'. + ![Projects Browser](../images/dymola/03_check.png) + +5. Click on the 'Graphics' tab of Dymola, then click the 'Check' button, which should show the message below: + + ![Check](../images/dymola/04_log.png) + +## Simulate +Having passed the check, you can now attempt to simulate the model. + +1. Navigate to the 'Projects Browser' of Dymola, right click on the ieee14 model and select 'Simulation Model' + ![Simulation Model](../images/dymola/05_simulationmodel.png) + +2. Click on the 'Simulation' tab of Dymola, and click on the 'Simulate' icon. + ![Simulation Model](../images/dymola/06_simulate.png) + +3. After the simulation is completed, select a few simulation outputs as shown below. Note that the fault applied results in an unstable system! + ![Simulation Result](../images/dymola/07_simoutput.png) + +Have fun playing around with the model! \ No newline at end of file