some docs clean up

NLaws · Dec 16, 2024 · a050d6f · a050d6f
1 parent 48de600
commit a050d6f
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 11 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -20,8 +20,8 @@ Building a `BranchFlowModel` requires three things:
 3. the type of model to be built, i.e. one of the [`BranchFlowModel.ModelType`](@ref)
 ```@docs
 BranchFlowModel.ModelType
-build_bfm!
 ```
+To build a model see [build_bfm!](@ref)
 
 # Variables
 

diff --git a/docs/src/math.md b/docs/src/math.md
@@ -22,9 +22,8 @@ w_i \ell_{ij} = P_{ij}^2 + Q_{ij}^2 \forall (i,j) \in \mathcal{E} \\
 # Three Phase BranchFlowModel
 ```@docs
 constrain_KVL(m, net::Network{MultiPhase})
-BranchFlowModel.add_bfm_variables
 ```
-
+See also [`add_bfm_variables`](@ref)
 
 ```math
 \begin{aligned}

diff --git a/docs/src/methods.md b/docs/src/methods.md
@@ -10,14 +10,11 @@ build_bfm!
 constrain_power_balance
 constrain_KVL
 check_rank_one
-check_soc_inequalities
-get_load_bal_shadow_prices
 reduce_tree!
 trim_tree!
 set_inputs!
 get_diffs
 solve_metagraph!
-metagraph_voltages
 check_statuses
 remove_bus!
 ```
diff --git a/src/BranchFlowModel.jl b/src/BranchFlowModel.jl
@@ -45,17 +45,19 @@ export
     # end new methods TODO distinguish all exports by module
 
     build_bfm!,
+    add_bfm_variables,
+    add_linear_variables,
     add_variables,
     add_sdp_variables,
     constrain_power_balance,
     constrain_substation_voltage,
     constrain_KVL,
+    constrain_bfm_nlp,
     # recover_voltage_current,  # TODO validate this method
     init_inputs!,
     set_inputs!,
     get_diffs,
     solve_metagraph!,
-    metagraph_voltages,
     check_statuses,
     remove_bus!,
 

diff --git a/src/model_single_phase.jl b/src/model_single_phase.jl
@@ -82,6 +82,13 @@ function build_bfm!(m::JuMP.AbstractModel, net::Network{SinglePhase}, ::Val{Line
 end
 
 
+"""
+    add_linear_variables(m, net::Network{SinglePhase})
+
+Add variables for the single-phase, linear model:
+- `Pij` and `Qij` for all `edges(net)`
+- `p0` and `q0` slack bus power
+"""
 function add_linear_variables(m, net::Network{SinglePhase})
     es = collect(edges(net))
 

diff --git a/test/test_nlp.jl b/test/test_nlp.jl
@@ -15,7 +15,7 @@
 
 
     m = Model(Ipopt.Optimizer)
-    set_optimizer_attribute(m, "print_level", 0)
+    # set_optimizer_attribute(m, "print_level", 0)
 
     build_bfm!(m, net, Unrelaxed)
 
@@ -75,12 +75,9 @@
 
     dss_voltages = dss_voltages_pu()
 
-    errors = []
     for b in keys(vs)
         for (i, phsv) in enumerate(filter(v -> v != 0, vs[b]))
             @test abs(phsv - dss_voltages[b][i]) < 1e-3
-            push!(errors, phsv - dss_voltages[b][i])
-            # println("$b - $i  $(phsv - dss_voltages[b][i])")
         end
     end