diff --git a/docs/devdeploy.jl b/docs/devdeploy.jl index 10d4f06..0e66fed 100644 --- a/docs/devdeploy.jl +++ b/docs/devdeploy.jl @@ -8,7 +8,7 @@ e.g. ```julia [~/.julia/dev/BranchFlowModel/docs] (BranchFlowModel) pkg> activate . -(BranchFlowModel) pkg> dev BranchFlowModel +(BranchFlowModel) pkg> dev ../../BranchFlowModel julia> include("devdeploy.jl") [ Info: Precompiling BranchFlowModel [73c867df-75f8-459f-abd8-059b58de1e18] ... diff --git a/docs/make.jl b/docs/make.jl index 75ca165..d58410b 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -14,6 +14,7 @@ makedocs( "Decomposition" => "decomposition.md", "Math" => "math.md" ], + warnonly = true, # TODO rm this and fix all the docs ) # Documenter can also automatically deploy documentation to gh-pages. diff --git a/docs/src/decomposition.md b/docs/src/decomposition.md index d865e10..0667eff 100644 --- a/docs/src/decomposition.md +++ b/docs/src/decomposition.md @@ -1,5 +1,5 @@ Methods to decompose and solve the `SinglePhase` Branch Flow Model are provided based on the work in -[[1]](@ref). These methods are most advantageous when solving the non-linear (unrelaxed) power flow +[[2]](@ref). These methods are most advantageous when solving the non-linear (unrelaxed) power flow equations and are only valid(?) in radial networks. ```@docs @@ -13,5 +13,5 @@ split_inputs build_metagraph ``` -### [1] +### [2] Sadnan, Rabayet, and Anamika Dubey. "Distributed optimization using reduced network equivalents for radial power distribution systems." IEEE Transactions on Power Systems 36.4 (2021): 3645-3656. \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index a636e2c..3a338cc 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -91,5 +91,5 @@ See the [JuMP documentation](https://jump.dev/JuMP.jl/stable/manual/constraints/ # Results ```@docs -Results(m::AbstractModel, p::Inputs{SinglePhase}) +Results(m::JuMP.AbstractModel, p::Inputs{SinglePhase}; digits=8) ``` diff --git a/docs/src/methods.md b/docs/src/methods.md index 08ee7f5..6d2d59a 100644 --- a/docs/src/methods.md +++ b/docs/src/methods.md @@ -63,5 +63,5 @@ has_vreg combine_parallel_lines! remove_bus! paths_between -Results(m::JuMP.AbstractModel, p::Inputs{BranchFlowModel.SinglePhase}) +Results(m::JuMP.AbstractModel, p::Inputs{SinglePhase}; digits=8) ``` \ No newline at end of file diff --git a/src/results.jl b/src/results.jl index e2a15c6..f889098 100644 --- a/src/results.jl +++ b/src/results.jl @@ -15,7 +15,7 @@ end """ - Results(m::AbstractModel, p::Inputs{SinglePhase}; digits=8) + Results(m::JuMP.AbstractModel, p::Inputs{SinglePhase}; digits=8) return a `Results` struct with fieldnames: @@ -27,7 +27,7 @@ return a `Results` struct with fieldnames: reactive_sending_end_powers """ -function Results(m::AbstractModel, p::Inputs{SinglePhase}; digits=8) +function Results(m::JuMP.AbstractModel, p::Inputs{SinglePhase}; digits=8) vs = get_variable_values(:vsqrd, m, p, digits=digits) Pj = get_variable_values(:Pj, m, p, digits=digits)