Update the explanation of the features (variable time resolution) (#348)

TulipaEnergy · Dec 11, 2023 · f5899c9 · f5899c9
1 parent 895220c
commit f5899c9
Show file tree

Hide file tree

Showing 8 changed files with 111 additions and 70 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -16,11 +16,11 @@ makedocs(;
     ),
     pages = [
         "Home" => "index.md",
-        "API" => "api.md",
-        "How to Use" => "how-to-use.md",
-        "Mathematical Formulation" => "mathematical-formulation.md",
         "Features" => "features.md",
+        "Mathematical Formulation" => "mathematical-formulation.md",
+        "How to Use" => "how-to-use.md",
         "Tutorial" => "tutorial.md",
+        "API" => "api.md",
         "Reference" => "reference.md",
     ],
 )

diff --git a/docs/src/features.md b/docs/src/features.md
diff --git a/docs/src/figs/variable-time-resolution-2.png b/docs/src/figs/variable-time-resolution-2.png
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -20,5 +20,5 @@ If you want to ask a question unsuitable for a bug report, start a discussion [h
 ## Contents
 
 ```@contents
-Pages = ["index.md","api.md","how-to-use.md","mathematical-formulation.md","tutorial.md","reference.md"]
+Pages = ["index.md","features.md","mathematical-formulation.md","how-to-use.md","tutorial.md","api.md","reference.md"]
 ```
diff --git a/docs/src/mathematical-formulation.md b/docs/src/mathematical-formulation.md
@@ -158,7 +158,7 @@ v^{flow}_{f,rp,k} \leq p^{profile}_{f,rp,k} \cdot \left(p^{init\_capacity}_{f} +
 
 ```math
 \begin{aligned}
-v^{flow}_{f,rp,k} \geq p^{profile}_{f,rp,k} \cdot \left(p^{init\_capacity}_{f} + p^{import\_capacity}_f \cdot v^{investment}_f \right)  \quad
+v^{flow}_{f,rp,k} \geq - p^{profile}_{f,rp,k} \cdot \left(p^{init\_capacity}_{f} + p^{import\_capacity}_f \cdot v^{investment}_f \right)  \quad
 \\ \\ \forall f \in \mathcal{F}_t, \forall rp \in \mathcal{RP},\forall k \in \mathcal{K}
 \end{aligned}
 ```

diff --git a/test/inputs/Variable Resolution/assets-partitions.csv b/test/inputs/Variable Resolution/assets-partitions.csv
@@ -1,5 +1,5 @@
 ,,,
 asset,rep_period_id,specification,partition
 H2,1,uniform,6
-wind,1,math,1x4+1x2
+wind,1,uniform,6
 phs,1,uniform,6
diff --git a/test/inputs/Variable Resolution/flows-partitions.csv b/test/inputs/Variable Resolution/flows-partitions.csv
@@ -1,7 +1,7 @@
 ,,,,
 from_asset,to_asset,rep_period_id,specification,partition
 H2,ccgt,1,uniform,6
-wind,balance,1,math,1x4+1x2
-wind,phs,1,math,1x4+1x2
-phs,balance,1,uniform,3
+wind,balance,1,math,1x2+1x4
+wind,phs,1,uniform,3
+phs,balance,1,math,1x4+1x2
 balance,demand,1,uniform,3
diff --git a/test/test-case-studies.jl b/test/test-case-studies.jl
@@ -13,7 +13,7 @@ end
 @testset "Tiny Variable Resolution Case Study" begin
     dir = joinpath(INPUT_FOLDER, "Variable Resolution")
     energy_problem = run_scenario(dir)
-    @test energy_problem.objective_value ≈ 28.43650 atol = 1e-5
+    @test energy_problem.objective_value ≈ 28.45872 atol = 1e-5
 end
 
 @testset "Infeasible Case Study" begin