Merge pull request #123 from e2nIEE/feature/fix_pages

updated gh-pages push action.

Author: vogt31337

.github/workflows/documentation.yml

@@ -16,7 +16,13 @@ jobs:
       - name: Install Dependencies
         run: julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: Build and Deploy
+        run: julia --project=docs docs/make.jl
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-        run: julia --project=docs docs/make.jl
+          # DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+      - name: Upload to gh-pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build
+          publish_branch: gh-pages

docs/src/develop.md

@@ -80,7 +80,7 @@ Base.find_package("PandaModels")
 In develop-mode you need to add the following dependencies:
 
 optimization environment:
-* [JuMP.jl](https://github.com/JuliaOpt/JuMP.jl)
+* [JuMP.jl](https://github.com/jump-dev/JuMP.jl)
 
 infrastructure-based packages:
 * [InfrastructureModels.jl](https://github.com/lanl-ansi/InfrastructureModels.jl)
@@ -124,7 +124,7 @@ Pkg.resolve()
 
 #### Gurobi Installation:
 
-To use [Gurobi](https://www.gurobi.com/), download and install from [Gurobi Download Center](https://www.gurobi.com/downloads/), then get the license, activate it and add its path to the local PATH environment variables by following the steps from [Gurobi License Center](https://www.gurobi.com/downloads/licenses/).
+To use [Gurobi](https://www.gurobi.com/), download and install from [Gurobi Download Center](https://www.gurobi.com/downloads/), then get the license, activate it and add its path to the local PATH environment variables by following the steps from [Gurobi License Center](https://portal.gurobi.com/iam/licenses/list).
 
 !!! note "Linux Users"
     for `linux` users: open `.bashrc` file with , e.g., `nano .bashrc` in your home folder and add:

docs/src/index.md

@@ -10,16 +10,14 @@ CurrentModule = PandaModels
 
 As the figure below illustrates,  with the help of **PandaModels**, **pandapower** and **PowerModels.jl** are connected in a functional way. The pandapower-PowerModels (PM-PP) converter enables conversion from the **pandapower** format to the **PowerModels** format. After the optimization in **PowerModels**, the PP-PM converter transforms the optimization results back to the original **pandapower** grid model, which can be used for further analysis. In addition to the existing **PowerModels** optimization models, **pandamodels** enables adding custom optimization models. Presently, reactive power optimizations can be down with **pandamodels** to maintain voltage setpoints, maintain reactive power setpoints, and minimize active power losses.
 
-![Alt text](/pic/schema_pandamodels.jpg?raw=true "Optional Title")
-
 ## Installation
 
 ### Install Julia
-If you are not yet using Julia, install it. Note that you need a version that is supported PowerModels, PyCall and pyjulia for the interface to work. Currently, [Julia 1.5](https://julialang.org/downloads/)  is the most recent stable version of Julia that supports all these packages.
+If you are not yet using Julia, install it. Note that you need a version that is supported PowerModels, PyCall and pyjulia for the interface to work. Currently, [Julia 1.10](https://julialang.org/downloads/)  is the most recent stable version of Julia that supports all these packages.
 
-You don't necessarily need a Julia IDE if you are using PowerModels through pandapower, but it might help for debugging to install an IDE such as [Juno](http://docs.junolab.org/latest/man/installation). Also, [PyCharm](https://www.jetbrains.com/pycharm/) has a Julia Plugin.
+You don't necessarily need a Julia IDE if you are using PowerModels through pandapower, but it might help for debugging to install an IDE such as [Juno](https://docs.junolab.org/latest/man/installation/). Also, [PyCharm](https://www.jetbrains.com/pycharm/) has a Julia Plugin.
 
-Add the Julia binary folder (e.g. /Julia-1.5.0/bin) to the [system variable PATH](https://www.computerhope.com/issues/ch000549.htm) Providing the path is correct, you can now enter the `Julia` prompt by executing:
+Add the Julia binary folder (e.g. /Julia-1.10.0/bin) to the system variable PATH providing the path is correct, you can now enter the `Julia` prompt by executing:
 
 ```bash
 $ julia
@@ -66,6 +64,6 @@ Otherwise, the package will be automatically installed in pandapower environment
 
 ## Acknowledgements
 
-This package has been developed as part of the De­part­ment of En­er­gy Ma­nage­ment and Power Sys­tem Ope­ra­ti­on [(e²n)](https://www.uni-kassel.de/eecs/en/faculties/energy-management-and-power-system-operation/home), University of Kassel and Fraunhofer Institute for Energy Economics and Energy System Technology [(IEE)](https://www.iee.fraunhofer.de/en.html).
+This package has been developed as part of the De­part­ment of En­er­gy Ma­nage­ment and Power Sys­tem Ope­ra­ti­on [(e²n)](https://www.uni-kassel.de/eecs/en/sections/sustainable-electrical-energy-systems/home.html), University of Kassel and Fraunhofer Institute for Energy Economics and Energy System Technology [(IEE)](https://www.iee.fraunhofer.de/en.html).
 
 The developers thank [Carleton Coffrin](https://www.coffrin.com/), the primary developer of [PowerModels.jl](https://lanl-ansi.github.io/PowerModels.jl/stable/), for his support.

docs/src/model.md

@@ -19,4 +19,4 @@ Finally, you need to add `run_pandamodels_<your_model>` function into export lis
 
 ## Application of New optimization Model in pandapower
 
-Please check [here](https://github.com/e2nIEE/pandapower/blob/develop/tutorials/new_optimization_model_pandamodels.ipynb) to find out how call the new model in pandapower.
+Please check [here](https://github.com/e2nIEE/pandapower/blob/develop/tutorials/run_powermodels_custom.jl) to find out how call the new model in pandapower.

docs/src/quickguide.md

@@ -54,4 +54,4 @@ net = nw.example_simple()
 pp.runpm_ac_opf(net)
 ```
 
-for more  details about the settings please see [here](https://pandapower.readthedocs.io/en/latest/opf/pandamodels.html#usage), also the detailed tutorial is available in [Tutorials](@ref).
+for more  details about the settings please see [here](https://pandapower.readthedocs.io/en/latest/opf/pandamodels.html#usage).

test/call_pandamodels.jl

@@ -17,7 +17,7 @@
 
         @test isapprox(result["objective_lb"], -Inf)
         @test isapprox(result["objective"], 0.000453688; atol = 1e-8)
-        @test result["solve_time"] > 0.0
+        @test result["solve_time"] >= 0.0
 
     end
 
@@ -36,7 +36,7 @@
             end
         end
         @test isapprox(result["objective_lb"], -Inf)
-        @test result["solve_time"] > 0.0
+        @test result["solve_time"] >= 0.0
     end
 
     @testset "case_pflex: cigre mv" begin
@@ -54,7 +54,7 @@
             end
         end
         @test isapprox(result["objective_lb"], -Inf)
-        @test result["solve_time"] > 0.0
+        @test result["solve_time"] >= 0.0
     end
 
     @testset "case_multi_qflex: cigre mv" begin
@@ -83,7 +83,7 @@
         #     end
         # end
 
-        @test result["solve_time"] > 0.0
+        @test result["solve_time"] >= 0.0
     end
 
     @testset "case_ploss: cigre mv" begin
@@ -100,7 +100,7 @@
                         for (i, content) in params[:target_branch]) < 0.07
 
         @test isapprox(result["objective_lb"], -Inf)
-        @test result["solve_time"] > 0.0
+        @test result["solve_time"] >= 0.0
     end