OpenIPSL v3.1.0 (2026-02-25)

This release version 3.1.0 of OpenIPSL is led by an Industrial-Grade Model Expansion. The release significantly expands the availability of new models and examples, with broad additions across synchronous machine dynamics, governors, excitation and stabilizer systems, and WECC-type renewable energy source models (Wind, PV and BESS), while also improving compatibility and quality checks.

Highlights

Primary highlight: Industrial-Grade Model Expansion:

• Industrial-Grade Model Expansion: substantial additions and hardening of production-ready dynamic models and associated examples.
• Comprehensive model catalog growth: expanded synchronous machine, governor, excitation systems, and WECC renewable models for large-scale stability studies.
• WECC renewables energy source models (RES): WECC generic renewable models, including REGC, REEC, and REPC components for Wind/PV/BESS integration studies. Pre-defined templates with hierarchical modeling for BESS, PV and Wind.
• Expanded Microgrid and Voltage Source Models: new and updated IEEE/University Campus microgrid examples and voltage-behind-impedance source variants.
• Generic Variable Speed Drive Model: new model for variable speed drive systems with their power electronics and controller modules.
• Model quality and robustness improvements: targeted updates to key dynamic models and release checks.
• New Addition to Tutorial Examples: new example showing the integration of power flow records from GridCal/VeraGrid.

New component additions:

Key additions highlighted for this release include:

• New machine models: CIM5, CIM6, GENTPJ.
• Renewable Energy (WECC generic models): Renewable Energy Generator/Converter (REGC) models REGC_A; Renewable Energy Electric Controller (REEC) models REEC_A, REEC_B, and REEC_C; Renewable Energy Plant Controller (REPC) models REPC_A.
• Governing systems (thermal, gas, and hydro): DEGOV, IEEEG2, WEHGOV, WPIDHY, and WSIEG1.
• Excitation systems and compensators: AC7B, AC8B, DC4B, ESDC1A, ESDC2A, ESURRY, EXBAS, EXNI, SCRX, and IEEEVC.

Changes in detail

🚀 Features

• feat: Update HYGOV.mo by @lvanfretti in #309
• feat: Adding New Test Models for PSAT Solar PV by @lvanfretti in #322
• feat: Ideal Voltage Source by @lvanfretti in #320
• feat: Ideal Current Source Model by @lvanfretti in #319
• feat: Add advanced Example 4 (which uses GridCal) to tutorials by @maguilerac in #324
• feat: Graphical enhancements of line model and IEEE14 example by @ceraolo in #336
• feat: Adding Data package containing typical data sets of powerplant components. by @maguilerac in #329
• feat: WECC-Based Renewable Models by @fachif in #327
• feat: Updates to the PV all-in-one model by @fachif in #345
• feat: New Voltage Behind Impedance Models for the implementation of GFC by @lvanfretti in #349
• feat: Adding input option to voltage source behind an impedance model by @lvanfretti in #352
• feat: Updated Tutorial - Example 4 by @maguilerac in #351
• feat: New PSSE models (COMP, ES, TG, UEL, Machines) by @GiuseppeLaera in #347
• feat: Adding PowerFactory implementation of distributed solar PVD1 by @tinrabuzin in #267
• feat: New IEEE Microgrid and new components by @fachif in #343
• feat: University Campus Microgrid by @fachif in #341
• feat: Added Experiment Annotations and Modified ULTC Example by @lvanfretti in #376

🐛 Bug Fixes

• fix: 'abs' function not properly converted to MSL 4.0.0 by @dietmarw in #302
• fix: Remove cyclical dependency on function input by @dietmarw in #333
• fix: remove bogus libraries AC7B and DC4B from the uses annotation by @adrpo in #354
• fix: Fixes the variability of function variables by @dietmarw in #356
• fix: Update Reals IEE2ST, REECA1, REECB1, REECCU1, and REPCA1 by @gkhalley in #366
• fix: Typo on PV and Wind Template Parameters by @lvanfretti in #385

📚 Documentation

• docs: Fix typo by @tbeu in #312
• docs: Adding publications from AMConf 2022 by @lvanfretti in #321
• docs: Update CITATION.cff by @lvanfretti in #330
• docs: Document RampTrackingFilter, PSS2A and PSS2B model implementation details by @lvanfretti in #374
• doc: Enhance README with tutorial links for OpenIPSL by @lvanfretti in #389
• doc: Create Release Notes for v3.1.0 by @dietmarw in #381

⚡ Performance Improvements

• perf: Avoid equality on Real variables in SE Non-electrical function by @gkhalley in #313
• perf: Avoid equality on Real variables by @tbeu in #310
• perf: Invalid == on Reals NegCurLogic by @gkhalley in #326
• perf: Invalid == on Reals IEEEST by @gkhalley in #325
• perf: Changes to ULTC and correct syntax fixes for OCT by @hubertus65 in #265
• perf: Division by zero protection block and function added by @lvanfretti in #348
• perf: Parameter evaluation for simpler initial equation systems by @maltelenz in #369
• perf: Adding "--daeMode", "DAEsolver=true" and related changes by @lvanfretti in #375

♻️ Code Refactoring

• refactor: Converts internal variable to connector by @dietmarw in #332

🔨 Build System & CI

• ci: Fix regex to optionally ignore quoted strings when checking for deprecated Text.lineColor annotation by @tbeu in #339
• ci: Enable deprecation checks in CI by @beutlich in #382

🔧 Chores & Maintenance

• chore: Replaces deprecated lineColor with textColor by @dietmarw in #380

New Contributors

• @gkhalley made their first contribution in #313
• @hubertus65 made their first contribution in #265
• @ceraolo made their first contribution in #336
• @fachif made their first contribution in #327
• @GiuseppeLaera made their first contribution in #347
• @adrpo made their first contribution in #354
• @maltelenz made their first contribution in #369
• @beutlich made their first contribution in #382

Full Changelog: v3.0.0...v3.1.0

OpenIPSL v3.0.1

What's Changed

Bugfix release which is backwards compatible with version 3.0.0 of OpenIPSL.

Changes in detail

• Fixes missed 'abs' -> abs rename after MSL 4.0.0 conversion by @dietmarw in #303

Full Changelog: v3.0.0...v3.0.1

OpenIPSL v3.0.0 (for MSL 4.0.0)

What's Changed

This new release version 3.0.0 of OpenIPSL is a non-backwards compatible release based on the Modelica Standard Library version 4.0.0.

It is feature identical with OpenIPSL version 2.0.0 (which still uses MSL 3.2.3).

A conversion script is provided for user libraries using OpenIPSL version 2.0.0 and older. (Note: Models that extended from any of the old Examples models will have to be converted manually by the user.)

Full Changelog: v2.0.0...v3.0.0

OpenIPSL v2.0.0 (for MSL 3.2.3)

What's Changed

This new release version 2.0.0 of OpenIPSL is a non-backwards compatible release based on the Modelica Standard Library version 3.2.3.
A conversion script is provided for user libraries using OpenIPSL version 1.5.0 and older. (Note: Models that extended from any of the old Examples models will have to be converted manually by the user.)

Highlights

• Changed the license to the 3-Clause BSD License.
• Use of SI or per-unit units only in quantities (i.e., no more customs scaled kilo or Mega units).
• The old Examples models have been moved under Tests.
• The old external Application Examples package has now been incorporated as Examples and is part of this library.

Changes in detail

This release consists of 39 closed issues and 61 merged pull requests:

• fix typo in DerivativeLag by @pierre-haessig in #156
• Update to new version of journal paper by @lvanfretti in #159
• This fixes the description string of the sub-transient time constants by @dietmarw in #163
• add ControlledBreaker model under Events sub-package by @BiswarupM in #169
• Update README.md by @lvanfretti in #171
• Fix error in Tutorial: by @MaximeBaudette in #161
• (doc) Small update in publication list by @MaximeBaudette in #158
• Updating the KundurSMIB package to make use of the Generator interface by @dietmarw in #175
• Rebased PlantModel branch (replaces PR #157) by @dietmarw in #177
• Fixes #172 by removing duplicate implementations (with conversion) by @dietmarw in #178
• Clean implementation of the two and three winding transformer by @dietmarw in #180
• N44 update by @marcelofcastro in #181
• Fix defaultComponentPrefixes annotation by @tbeu in #184
• This fixes #112 and beyond by now introducing proper SI unit types by @dietmarw in #183
• Fixes #174 by providing a non-zero start value for ii and ir by @dietmarw in #190
• Fixes #93 by removing superfluous shunt models by @dietmarw in #191
• Adding discrete ULTC (closes #189) by @dietmarw in #192
• Machine base power rating change by @ManuelNvro in #196
• Removing the infinite bus from the example by @dietmarw in #203
• Remove hard coded and doubly defined start values for w and delta by @dietmarw in #204
• Add new ThreePhase package by @MaximeBaudette in #198
• Fix exciters by @dietmarw in #209
• Fixing the machine models by @dietmarw in #211
• Fixing governor models by @dietmarw in #215
• Fix wind models by @dietmarw in #216
• Fixing PSS models by @dietmarw in #214
• Fix Banks models by @dietmarw in #213
• Fix exciter models by @dietmarw in #212
• Sorting the examples and excitation models alphabetical by @dietmarw in #222
• Remove SMIBpartial2 and instead update SMIBpartial by @dietmarw in #225
• Mark verified models via a distinctive icon by @dietmarw in #228
• Correct calculation of I_T in ESSTB4 by @dietmarw in #230
• Adds documentation of verification by @dietmarw in #218
• Fix Terminator dimension warning by @dietmarw in #231
• Include PSAT PSS and load models from FOSSEE1 branch by @dietmarw in #232
• Explains the PSAT AVR models mix up by @dietmarw in #233
• Fix the CI setup by @dietmarw in #224
• Fix HTML syntax errors and also add package icons. by @dietmarw in #235
• Better implementation of PSTransformer by @dietmarw in #236
• Sort classes in alphabetical order when appropriate by @dietmarw in #237
• Cleans up and proper place for base classes by @dietmarw in #239
• Fix gencls by @marcelofcastro in #240
• Add an initial speed deviation and remove superfluous initial equationns by @dietmarw in #241
• Cleans up the PSS and ES models by @dietmarw in #242
• Clean up description strings wrt to units by @dietmarw in #243
• Clean up/reimplement FACTS models by @dietmarw in #244
• Add references to PSSE control models. by @dietmarw in #249
• Rescue of CGMES models by @dietmarw in #238
• Updated and fix the conversion script. by @dietmarw in #251
• Introduce nominal values to help numerical solvers by @dietmarw in #252
• Fix GGOV1 by @marcelofcastro in #254
• Fixing the initialisation issues with GENCLS and other PSS gen models by @dietmarw in #258
• Fix units by @marcelofcastro in #257
• Update Documentation in User's Guide by @marcelofcastro in #259
• Moving the CI files where they belong. by @dietmarw in #261
• Corrected display units of reactive power by @sergio-dorado in #268
• Improves the layout and documentation of the Plant model by @dietmarw in #271
• Converts CI from Travis to GitHub actions by @dietmarw in #272
• Improves documentation of GENCLS and unlocks parameters by @dietmarw in #273
• Clean up of NonElectrical/Logical by @dietmarw in #275
• Replaces custom LV and HV gate definitions with MSL blocks by @dietmarw in #274
• Changed V attribute to v (lowercase) in class Bus by @sergio-dorado in #279
• Clean-up and reimplementation of PowerFactory solar models by @tinrabuzin in #266
• Changing License by @marcelofcastro in #281
• Update README.md by @lvanfretti in #284
• Update CITATION.cff by @lvanfretti in #283
• Moves and converts Application Examples and old Examples to Examples and Tests, respectively by @marcelofcastro in #286
• Update the User's Guide by @dietmarw in #287
• Add option to use PadeDelay instead of normal delay to be used for linearisation by @dietmarw in #288
• Improved user interface for delay block in Turbine govenor by @dietmarw in #290
• Increase tests' and examples' compatibility with OMEdit by @marcelofcastro in #291
• Fixing soft PMU implementation by @marcelofcastro in #293
• Adding description sentence to all models in the library by @marcelofcastro in #294
• File clean up in preparation of 2.0.0 release by @dietmarw in #295
• Adding the release notes by @dietmarw in #297

New Contributors

• @pierre-haessig made their first contribution in #156
• @BiswarupM made their first contribution in #169
• @ManuelNvro made their first contribution in #196
• @sergio-dorado made their first contribution in #268

Full Changelog: v1.5.0...v2.0.0

OpenIPSL v2.0.0-beta.1

First beta release of version 2.0.0

OpenIPSL v1.5.0

What's Changed

• Update tutorial package by @MaximeBaudette in #86
• Fix Bus Display variables by @MaximeBaudette in #87
• Adds the units MW and Mvar to the dynamic bus display. by @dietmarw in #90
• Implement the new power flow display and lots of other clean ups by @dietmarw in #91
• Fixes #96 Move displayFunction into existing Function package. by @dietmarw in #98
• Fix Bus that contained double parameters by @MaximeBaudette in #99
• Fixing the spelling of the standard "checkbox" annoation by @dietmarw in #100
• Reverting the fix of the checkbox by @dietmarw in #101
• Adding resynchronisation models by @tinrabuzin in #103
• Updates of PwPin references by @tinrabuzin in #106
• Clean up of base load icon by @dietmarw in #108
• Add default prefixes definition for SystemBase by @dietmarw in #109
• Fixing the PSAT machine connector annotations by @dietmarw in #110
• Mods to Documentation Info by @lvanfretti in #113
• Improve the PSSE loads by @dietmarw in #115
• Changes applied to the IEEET1 model to fix the translation error by @maguilerac in #117
• Updated tutorial documentation. I have divided the slide set in two, … by @lvanfretti in #120
• OMNotebook and Dymola Functions for Analysis by @lvanfretti in #121
• Adding Martin's fix to tutorial by @MaximeBaudette in #122
• Fix typos by @tbeu in #123
• Adding the Mostar model to Application Examples by @lvanfretti in #124
• Small fixes to Examples and to the PwVoltage sensor. by @janlav in #126
• Cleaning Library of old Copyright Statements by @MaximeBaudette in #128
• #127 Changes to pull request by @tbeu and the commit 179ea4d… by @janlav in #129
• Fix to issue #114 by @janlav in #130
• Modifying Copyright for Luigi by @MaximeBaudette in #131
• Update README.md by @lvanfretti in #132
• Update for release related to tutorial of NA-MUG in Stanford. by @lvanfretti in #135
• #118 revision to the PSAT OEL by @janlav in #133
• WT4G1 Initial Condition breaks Simulation by @lvanfretti in #134
• Fixing formatting of Readme file by @MaximeBaudette in #137
• First PR for Monotri by @MaximeBaudette in #139
• Adding examples from OpenIPSL used by RaPID by @lvanfretti in #125
• Moving the experiment information for PSSE tests by @MaximeBaudette in #140
• Adding load variation with noise injection by @MaximeBaudette in #141
• Add Soft PMU model by @MaximeBaudette in #142
• Fixing PSAT Machines, AVR I & II, and making everything compile. by @janlav in #143
• Fixes PSAT machines handling of bases and PSAT OEL by @janlav in #149
• Remove duplicate files by @MaximeBaudette in #151
• Fixes to PSAT AVR, Generators, Loads and OELs. by @janlav in #152
• Add docker file by @MaximeBaudette in #154
• Add MonoTri Library by @MaximeBaudette in #146

New Contributors

• @maguilerac made their first contribution in #117
• @janlav made their first contribution in #126

Full Changelog: v1.0.0...v1.5.0

Tutorial for CURENT ERC 2017 @ UTK

This release of OpenIPSL's "Tutorial" was prepared for a tutorial given at the CURENT ERC @ UTK , August 3rd, 2017: http://curent.utk.edu

Seminar

Prior to the Tutorial, a seminar was help, presenting OpeIPSL and the modeling principles used in the library. The second part of the seminar, showed the application of OpenIPSL in GridDyn, they can be found below, in Downloads.

Tutorial

• Webcast Youtube Video: https://www.youtube.com/watch?v=ARad3RZWLds&t=2681s
• The preparatory work that needs to be done prior to the tutorial can be found in this .pdf: 2017_08_ LVPT_OpenIPSLNAMUG_Prep.pdf
• The slides with the hands-on examples, explained step by step, can be found here: 2017_08_ LVPT_OpenIPSLNAMUG_HandsOn.pdf

Tutorial for NA-MUG 2017 @ Stanford

This release of OpenIPSL's "Tutorial" was prepared for a tutorial at the 2017 North America Modelica User's Group Meeting, August 3rd, 2017.

Please use this OpenModelica Notebook:
Example_1.onb.zip

The preparatory work that needs to be done prior to the tutorial can be found in this .pdf: 2017_08_ LVPT_OpenIPSLNAMUG_Prep.pdf

The slides with the hands-on examples, explained step by step, can be found here:
2017_08_ LVPT_OpenIPSLNAMUG_HandsOn.pdf

The presentation for the first part of the tutorial, explaining the modeling principles and approach in OpenIPSL can be found here: 2017_08_ LVPT_OpenIPSLNAMUG_Presentation.pdf

The presentation for the second part of the tutorial, showing the application of OpenIPSL in GridDyn, can be found here:
OpenIPSL usage in GridDyn.pdf

Tutorial for the 12th Modelica Conference @ Prague

This release of OpenIPSL's "Tutorial" was prepared for a tutorial at the 12th Modelica Conference in Prague on May 15th, 2017.

The preparatory work that needs to be done prior to the tutorial can be found in this .pdf: OpenIPSL_Tutorial_Prep.pdf

The slides with the hands-on examples, explained step by step, can be found here: OpenIPSL_HandsOn_Examples.pdf

The presentation for the first part of the tutorial, explaining the modeling principles and approach in OpenIPSL can be found here:
2017_01_ LVMB OpenModelica WS OpenIPSL_Presentation.pdf

OpenIPSL Tutorial @TAMU

This release of OpenIPSL's "Tutorial" was prepared for a Tutorial at Texas A&M University organised by Associate Prof. Le Xie on April 20th 2017.

The preparatory work prior to the tutorial can be found in this .pdf:
OpenIPSL_Tutorial_Prep.pdf

The slides with the hands-on examples, explained step by step, can be found here:
OpenIPSL_HandsOn_Examples.pdf

Download this .zip file with the updated files for the tutorial (2017-04-19):
_Tutorial.zip

The presentation for the first part of the tutorial will be made available here after the event.