Skip to content

Commit 6f7c6ab

Browse files
committed
Add message for non-standard parameters.
1 parent c30b944 commit 6f7c6ab

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/main/init_parameters.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Returns a `param` dict with the model parameters. These are independent of the g
3131
- `optimizer = Ipopt.Optimizer`: Optimizer to be used
3232
- `optimizer_attr::Dict`: Dict of attributes passed to the optimizer (e.g. `Dict(:tol => 1e-5)`)
3333
- `model_attr::Dict`: Dict of tuples (length 2) passed to the model (e.g. `Dict(:backend => (MOI.AutomaticDifferentiationBackend(), MathOptSymbolicAD.DefaultBackend()))` to use Symbolic AD)
34-
- `model::Function`: For custom models => a function that taks an optimizer and an 'auxdata' structure as created by create_auxdata() as input and returns a fully parameterized JuMP model
35-
- `recover_allocation::Function`: For custom models => a function that takes a solution and 'auxdata' structure as input and returns the allocation variables. In particular, it should return a dict with symbol keys returning at least objects :welfare => scalar welfare measure, :Pjn => prices, :PCj => aggregate condumption, and :Qjkn => flows.
34+
- `model::Function`: For custom models => a function that taks an optimizer and an 'auxdata' structure as created by `create_auxdata()` as input and returns a fully parameterized JuMP model
35+
- `recover_allocation::Function`: For custom models => a function that takes a solved JuMP model and 'auxdata' structure as input and returns the allocation variables. In particular, it should return a dict with symbol keys returning at least objects :welfare => scalar welfare measure, :Pjn => prices, :PCj => aggregate consumption, and :Qjkn => flows.
3636
3737
# Examples
3838
```julia
@@ -48,6 +48,7 @@ function init_parameters(; alpha = 0.5, beta = 1, gamma = 1, K = 1, sigma = 5, r
4848

4949
if !isempty(kwargs)
5050
for (key, value) in kwargs
51+
println("Non-standard parameter '$(key)' added")
5152
param[key] = value
5253
end
5354
end

0 commit comments

Comments
 (0)