Function reference

NEMO provides several functions intended for end users - these are documented below. There are also a number of internal functions in NEMO that are documented in the program's Julia code.

calculatescenario

See Calculating a scenario.

convertscenariounits

NemoMod.convertscenariounitsFunction
convertscenariounits(
    path::String; 
    energy_multiplier::Float64 = 1.0, 
    power_multiplier::Float64 = 1.0, 
    cost_multiplier::Float64 = 1.0, 
    emissions_multiplier::Float64 = 1.0, 
    quiet::Bool = false
)

Converts units of measure in the scenario database at path. Quantities denominated in energy units are multiplied by energy_multiplier, quantities denominated in power units are multiplied by power_multiplier, quantities denominated in cost units are multiplied by cost_multiplier, and quantities denominated in emissions units are multiplied by emissions_multiplier. The quiet argument suppresses non-essential status messages.

This function assumes that consistent energy and power units are used across regions, and it converts both parameter and variable tables. It also converts default values in the DefaultParams table.

source

createnemodb

NemoMod.createnemodbFunction
createnemodb(path::String;
defaultvals::Dict{String, Float64} = Dict{String, Float64}(),
foreignkeys::Bool = false)

Creates an empty NEMO scenario database in SQLite. If the specified database already exists, drops and recreates NEMO tables in the database.

Arguments

  • path::String: Full path to the scenario database, including the file name.
  • defaultvals::Dict{String, Float64} = Dict{String, Float64}(): Dictionary of parameter table names and default values for val column.
  • foreignkeys::Bool = false: Indicates whether to create foreign keys within the database.
source

dropdefaultviews

dropresulttables

NemoMod.dropresulttablesFunction
dropresulttables(db::SQLite.DB, quiet::Bool = true)

Drops all tables in db whose name begins with ""v"" or ""sqlite_stat"" (both case-sensitive). The quiet parameter determines whether most status messages are suppressed.

source

logmsg

NemoMod.logmsgFunction
logmsg(msg::String, suppress=false, dtm=now()::DateTime)

Prints a log message (msg) to STDOUT. The message is suppressed if suppress == true. dtm determines the date and time included in the printed message.

Examples

julia> using Dates

julia> logmsg("Test message", false, DateTime(2020))
2020-01-Jan 00:00:00.000 Test message
source

setparamdefault

NemoMod.setparamdefaultFunction
setparamdefault(db::SQLite.DB, table::String, val::Float64)

Sets the default value for a parameter table in a NEMO scenario database.

Arguments

  • db::SQLite.DB: Scenario database containing the parameter table.
  • table::String: Table name (case-sensitive).
  • val::Float64: Parameter value (must be a floating-point number).
source

find_infeasibilities

NemoMod.find_infeasibilitiesFunction
find_infeasibilities(m::JuMP.Model,
    silent_solver::Bool=false
)

Returns a Vector of constraint data for constraints in m that cause infeasibility. silent_solver suppresses output from the solver for m.

Arguments

  • m::JuMP.Model: Model to check for infeasibility. Should be a NEMO model created with calculatescenario.
  • silent_solver::Bool = false: Suppresses output from the solver for m.
source