Merge pull request #232 from JuliaEnergy/hw/openipsl

OpenIPSL models

Author: hexaeder

.github/workflows/CI.yml

@@ -16,7 +16,6 @@ jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
-    timeout-minutes: 60
     permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
       actions: write
       contents: read
@@ -70,7 +69,7 @@ jobs:
           key: ${{ steps.julia-cache.outputs.cache-key }}
 
   docs:
-    name: Documentation
+    name: Documentation-v1.11
     runs-on: ubuntu-latest
     permissions:
       actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created
@@ -81,7 +80,7 @@ jobs:
       - uses: actions/checkout@v5
       - uses: julia-actions/setup-julia@v2
         with:
-          version: '1'
+          version: '1.11'
       - name: Load Julia packages from cache
         id: julia-cache
         uses: julia-actions/cache@v2

.gitignore

@@ -6,3 +6,4 @@
 .vscode
 devenv
 testenv
+*_extended.csv.gz

CHANGELOG.md

@@ -1,5 +1,10 @@
 # PowerDynamices.jl Changelog
 
+## Version 4.3.0 Changelog
+- [#232](https://github.com/JuliaDynamics/PowerDynamics.jl/pull/232): Added lots of new models based on the great OpenIPSL Library.
+  Those models are validated against OpenIPSL by reproducing their component test-harness and comparing trajectories of internal
+  states.
+
 ## Version 4.2.0 Changelog
 - [#230](https://github.com/JuliaDynamics/PowerDynamics.jl/pull/230): 
   - deprecate `Bus(...)` → `compile_bus(...)` and `Line(...)` → `compile_line(...)`

LICENSE

@@ -13,6 +13,12 @@ MIT License
 
 Copyright (c) 2024 Hans Würfel <git@wuerfel.io> and contributors
 
+This project includes derivative works from OpenIPSL:
+- OpenIPSL Copyright (c) 2016-2022 Luigi Vanfretti, ALSETLab, and contributors
+- OpenIPSL licensed under BSD 3-Clause License
+- OpenIPSL source: https://github.com/OpenIPSL/OpenIPSL
+- Specific derived components are clearly marked in source files
+
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights

Project.toml

@@ -33,7 +33,7 @@ LinearAlgebra = "1.10.0"
 MacroTools = "0.5.16"
 ModelingToolkit = "10"
 ModelingToolkitStandardLibrary = "2.11.0"
-NetworkDynamics = "0.10.6"
+NetworkDynamics = "0.10.9"
 NonlinearSolve = "4"
 OrderedCollections = "1.6.3"
 Reexport = "1.2.2"

docs/make.jl

@@ -71,6 +71,7 @@ kwargs = (;
         "🔗 NetworkDynamics.jl Docs" => "networkdynamics_forward.md",
     ],
     draft=haskey(ENV, "DOCUMENTER_DRAFT"),
+    linkcheck_ignore = [r"^\.\./assets/OpenIPSL_valid/.*\.png$"],  # Match ../assets/OpenIPSL_valid/*.png
     warnonly=[:missing_docs, :docs_block],
 )
 kwargs_warnonly = (; kwargs..., warnonly=true)

docs/src/API.md

@@ -94,3 +94,8 @@ delete_pfinitconstraints!
 delete_pfinitformulas!
 copy_pf_parameters
 ```
+
+## Utils
+```@docs
+refine_timeseries
+```

docs/src/Library.md

@@ -20,24 +20,42 @@ VariableFrequencySlack
 
 ### Synchronous Machine Models
 ```@docs
+PSSE_GENCLS
+PSSE_GENROU
+PSSE_GENROE
+PSSE_GENSAL
+PSSE_GENSAE
 SauerPaiMachine
 Swing
 ClassicalMachine
 ```
 
 ## Control Systems
 
-### Automatic Voltage Regulators (AVRs)
+### Exciters & AVRs
 ```@docs
+PSSE_EXST1
+PSSE_ESST4B
+PSSE_ESST1A
+PSSE_SCRX
+PSSE_IEEET1
 AVRFixed
 AVRTypeI
 ```
 
 ### Governors and Turbines
 ```@docs
+PSSE_IEEEG1
+PSSE_HYGOV
 GovFixed
 TurbineGovTypeI
 TGOV1
+PSSE_GGOV1_EXPERIMENTAL
+```
+
+### Power System Stabilizers (PSS)
+```@docs
+PSSE_IEEEST
 ```
 
 ## Load Models
@@ -48,6 +66,7 @@ PQLoad
 VoltageDependentLoad
 ConstantYLoad
 ZIPLoad
+PSSE_Load
 ```
 
 ## Line Models