Package index • energyRt

Classes

Data structures of the key model components.

class-constraint summand-class experimental: An S4 class to represent a custom constraint.
storage-class: An S4 class to represent storage type of technological process.
subsidy-class: An S4 class to represent a commodity subsidy
tax-class: An S4 class to represent a commodity tax
get_process_class(): Get class of processes
supply-class: An S4 class to represent a supply of a commodity
class-calendar: An S4 class to represent sub-annual time resolution structure.
class-commodity: An S4 class to represent a commodity
class-config: An S4 class to represent default model configuration.
class-costs experimental: An S4 class to add costs to objective function
class-demand: An S4 class to declare a demand in the model
class-export: An S4 class to represent commodity export to the rest of the world.
class-horizon: An S4 class to represent model/scenario planning horizon with intervals (year-steps)
class-import: An S4 class to represent commodity import from the rest of the world.
class-model model: An S4 class to represent model
class-modInp: An S4 class to represent model input
class-modOut: An S4 class to store results of a solved scenario
class-parameter: An S4 class to specify the model set or parameter
class-repository: An S4 class to store the model objects.
class-scenario scenario: An S4 class to represent scenario, an interpolated and/or solved model.
class-settings: An S4 class to represent scenario settings
.upgrade_summand(): An S4 class to represent a summand in a constraint.
class-technology: An S4 class to represent technology
class-trade: An S4 class to represent inter-regional trade
class-variable: An S4 class to specify a model variable
class-weather: S4 class to represent weather factors

Building a model

Functions to create model components.

newACLine() experimental: Create an AC transmission line
newCalendar(): Generate a new calendar object from
newCommodity(): Create new commodity object
newConstraint() isConstraint() newConstraintS(): Create constraint object to add custom constraints to the model.
newCosts(): Create new costs object
newDCLink() experimental: Create a DC transmission link
newDemand() update(<demand>): Create new demand object
newExport(): Create new export object
newHorizon() update(<horizon>) setHorizon(<config>) update(<config>): Create a new object of class 'horizon'
newImport(): Create new export object
newModel() setHorizon(<model>) getHorizon(<model>): Create new model object
newRepository(): A constructor for the repository class
newScenario(): Generate a new scenario object
newSub(): Create a new subsidy object
newSupply(): Constructor for supply object.
newTax(): Create a new tax object
newTrade(): Create new trade object
newWeather(): Create new weather object
newStorage(): Create new storage object
newTechnology() update(<technology>): Create a new "technology" object.
make_timetable(): Create timetable of time-timeslices from given structure as a list
update(<export>) update(<weather>): Update export object
update(<supply>): Update supply object
update(<storage>) update(<trade>) update(<import>): Update trade object
update_parameter(): Update parameter in the scenario by adding data to it
add(<repository>) add(<model>): Add an object to the model's repository
convert(<character>) convert(<numeric>) add_to_convert(<character>,<character>,<numeric>): Convert units
load_registry() save_registry() add_to_registry() add(<ert_registry>) find_registry() refresh_registry(): Project registry of models, scenarios, and runs
asSupplyCurve() asImportCurve() asExportCurve() experimental: Stepped supply, export and import curves
lossTranches() experimental: Loss tranches for a transmission line

Technology specs

Portable technology specifications (YAML/JSON containers) and vintage tools.

process_from_spec() tech_from_spec(): Build a process object from a spec
process_to_spec() tech_to_spec(): Export a process object as a spec list
process_spec_code() tech_spec_code(): The constructor call equivalent to a process spec, as text
process_spec_issues() tech_spec_issues(): Validate a process spec and report issues
combine_vintages(): Combine per-vintage technology objects into one vintaged technology

Configuration and Settings

Model configuration and scenario settings

class-config: An S4 class to represent default model configuration.
class-settings: An S4 class to represent scenario settings
compare_interp_settings(): Compare interpolation settings (size & build time) for a model
compare_solve_settings(): Compare interpolation settings AND solvers for a model
class-calendar: An S4 class to represent sub-annual time resolution structure.
newCalendar(): Generate a new calendar object from
autoplot(<calendar>): Visualize a Calendar object
setGeoscale(<config>) getGeoscale(<config>) setGeoscale(<model>) getGeoscale(<model>) setGeoscale(<scenario>) getGeoscale(<scenario>) getCalendar(<config>) getCalendar(<model>) getCalendar(<scenario>): Attach or read a model's geoscale
class-horizon: An S4 class to represent model/scenario planning horizon with intervals (year-steps)
newHorizon() update(<horizon>) setHorizon(<config>) update(<config>): Create a new object of class 'horizon'
autoplot(<horizon>): Visualize a Horizon object
calendars: Example calendars
horizons: Example planning horizons

Solving

interpolate_bounds(): Interpolate lower and upper bounds
interpolate_model(): Interpolate a model into a solver-ready scenario
interpolate_numpar(): Interpolate numerical parameter for missing years
interpolate_parameters(): Interpolate all year-indexed numeric/bounds parameters of a scenario
write_script() write_sc() write.sc(): Write scenario object as a Python, Julia, GAMS, or MathProg script with data files to a directory
write_technology_xlsx(): Write technology object(s) to an Excel workbook
set_log_file() get_log_file() read_log(): Read the operation log
read_solution() read(<scenario>): Read solution
read_procspec() read_techspec(): Read and validate a process spec
read_technology_xlsx(): Read technology object(s) from an Excel workbook
solve_mod() solve_scen() solve_model() solve_scenario(): Solve a model or an interpolated scenario
solve_myopic(): Solve a model sequentially (myopic foresight)
subset_model_regions(): Restrict a model to a region subset
with_solver_log(): Send the solver's progress log to a file
horizon_windows(): Split a horizon into sequential solve windows
solution_ledger(): Extract the carry-forward ledger from a solved scenario
apply_ledger(): Apply a carry ledger to a model
myopic_objective(): Globally discounted total cost of a myopic sequence
build_mappings(): Build mapping parameters for a scenario, in recipe (dependency) order
load_mapping_spec(): Load the mapping specification
mappings_by_recipe(): Group mapping specs by recipe, in evaluation order
trim_parameters_by_maps(): Trim numeric/bounds parameters to the domain of the maps that index them
validate_scenario_parameters(): Validate interpolated scenario parameters

Remote solver (NEOS)

neos_ping() neos_list_categories() neos_list_solvers() neos_get_template(): NEOS Server client (query the remote solver service)
neos_build_gams_text_job(): Build a NEOS GAMS job from a text-mode scenario directory (no input GDX)
neos_build_gams_xml(): Assemble a NEOS GAMS job document
neos_gams_inline(): Inline a GAMS model's $include files into one self-contained string
neos_submit_job() neos_job_status() neos_completion_code() neos_final_results() neos_get_output_file() neos_wait(): Submit and manage a NEOS job

Reporting

report(): Generate a summary report for an energyRt object
report_docx(): Generate a Word report for an energyRt object
report_output() report_setup() report_layout() report_esc() report_fmt_val() report_img() report_img_row() report_pagebreak() report_plot_png() report_sec() report_tbl() report_css() report_header(): Report template helpers
report_html(): Generate an HTML report for an energyRt object
report_pdf(): Generate a PDF report for an energyRt object
report_templates(): List the available report templates
report_tex(): Generate a LaTeX report for an energyRt object

Comparison

Compare scenarios’ solved results (or runs of one scenario), models’ declarations, and interpolated model inputs.

compare_inputs() print(<inputs_cmp>): Compare two scenarios' model inputs
compare_interp_settings(): Compare interpolation settings (size & build time) for a model
compare_models() print(<models_cmp>): Compare two models' contents
compare_scenarios() print(<scenarios_cmp>) autoplot(<scenarios_cmp>) plot(<scenarios_cmp>): Compare solved scenarios (or runs of one scenario)
compare_solve_settings(): Compare interpolation settings AND solvers for a model

Example datasets

Data bundled with the package for the examples and articles. calendars and horizons are listed under Configuration above.

vre_cf: Hourly wind and solar capacity factors, one site, one year
vre_storage_duration: Duration bands of a full-year battery, precomputed

Data manimulation

convert(<character>) convert(<numeric>) add_to_convert(<character>,<character>,<numeric>): Convert units
convert_data: Basic units conversion database for convert methods
commodity_properties(): Recognised commodity properties
commodity_property(): Physical property of a commodity
apply_to_scenario_data(): Apply function to scenario data
dataset_hash() save_dataset() load_dataset(): Content hash of a dataset payload
getData() get_data(): Extract data from energyRt objects
set_registry_file() get_registry_file() set_models_path() get_models_path() set_repositories_path() get_repositories_path() set_datasets_path() get_datasets_path() set_store_versioning() get_store_versioning(): Registry file and model store locations
seal_model() unseal_model() seal_repository() unseal_repository() seal_dataset() unseal_dataset() seal_scenario() unseal_scenario() mark_delete() unmark_delete() delete_marked(): Seal and unseal store entries; mark them for deletion
getObject(): Retrieve model objects from a repository, model or scenario
getScenario() getModel() getRepository() getDataset() open_project(): Access registered scenarios, models, repositories, and datasets by name
getMix(): Extract a tidy mix (generation, capacity, fuel) from a solved scenario
getVariants(): Process variants of a solved (or interpolated) scenario
storage_duration(): Split a storage level into duration bands
variantSummary(): Summarise a result variable across technology variants
en_replace_specials() en_has_specials() en_find_specials(): Find and replace special characters
findData(): Performs search for available data in scenario object.
findDuplicates(): Function to find duplicated values in interpolated scenario.
find_in_model(): Find where value(s) are stored across a model's objects
load_registry() save_registry() add_to_registry() add(<ert_registry>) find_registry() refresh_registry(): Project registry of models, scenarios, and runs
renameSets(): Rename data.frame columns of list of data.frames.
revalueSets(): Replace specified values with new values in factor or character columns of a data.frame.
model_size(): Size estimate of an interpolated scenario and the result of folding
size(): Size of an object
hour2HOUR(): Convert hours (integer) values to HOUR set 'hNN'
yday2YDAY(): Convert year-days to YDAY set 'dNNN'
tsl_formats tsl_sets dtm2tsl() tsl2dtm(): Common formats of time-timeslices.
tsl2year() tsl2yday() tsl2hour() tsl2month(): Mapping function between time-timeslices and day of the year
tsl_guess_format(): Guess format of time-timeslices
drop_na_cols(): Drop columns in a data.frame with all NA values
obj2mem(): Loads objects from disk to memory
isInMemory(): Is object stored in memory?
isOnDisk(): Is object stored on disk?
save_model() load_model(): Save a model to / load a model from the model store
save_repository() load_repository(): Save a repository to / load a repository from the repository store
save_scenario(): Save scenario object on disk in parquet format using arrow package.
load_mapping_spec(): Load the mapping specification
load_scenario() load_scenarios(): Load scenario (in progress)
model_hash() object_hash(): Content hash of a model
repository_hash(): Content hash of a repository
scenario_runs() scenario_run_info() drop_scenario_run(): List, inspect, and drop a scenario's runs
upgrade_scenario_layout(): Upgrade a scenario folder to the current on-disk layout
clear_levcost_cache(): Clear cached levcost results
utopia: UTOPIA reference maps
utopia_demand: UTOPIA electricity load shape
utopia_geoscale(): A geoscale for the UTOPIA reference model
utopia_modules: UTOPIA model modules
utopia_profile(): Synthetic input shapes on a calendar (deterministic)
utopia_profiles(): UTOPIA input profiles (deterministic)
utopia_stock: UTOPIA base-year capacity stock
utopia_weather: UTOPIA representative capacity-factor profiles

Visualisation

draw() draw.technology(): Draw a schematic representation of a process
autoplot(<commodity>): Visualize a Commodity object
autoplot(<tax>) autoplot(<subsidy>) autoplot(<constraint>): Plot a tax, subsidy or user constraint over years
autoplot(<supply>) autoplot(<import>) autoplot(<export>) autoplot(<technology>) autoplot(<storage>): Visualize a process object over years
autoplot(<scenario>): Plot mixes from a solved scenario
compare_scenarios() print(<scenarios_cmp>) autoplot(<scenarios_cmp>) plot(<scenarios_cmp>): Compare solved scenarios (or runs of one scenario)
autoplot(<calendar>): Visualize a Calendar object
plot_geoscale(): Draw a model's geoscale
plot_heatmap(): Heatmap of timeslice-indexed values over a calendar
autoplot(<horizon>): Visualize a Horizon object
plot_map(): Map model results by region
plot_share_frontier(): Plot feasible share-mix diagram for technology inputs/outputs
plot_trade_map() autoplot(<trade>): Map inter-regional trade routes
report_output() report_setup() report_layout() report_esc() report_fmt_val() report_img() report_img_row() report_pagebreak() report_plot_png() report_sec() report_tbl() report_css() report_header(): Report template helpers
en_config_show(): Show the effective energyRt configuration
set_progress_bar() show_progress_bar(): Switch on/off and select/customize progress bar
design(): Generate an R script that recreates an energyRt object
process_designer() tech_designer(): Launch the process designer
object_image(): Image or icon attached to a model object
ghost_options(): Geometry of the faded "ghost" vintages behind a drawn technology
theme_energyRt(): energyRt's default ggplot theme

Validation

check_geoscale_regions(): Check a geoscale against the model's declared regions
check_name(): Check validity of object's names used in sets
verify_solution(): Verify accounting identities of a solved scenario
clear_levcost_cache(): Clear cached levcost results
levcost(): Levelized cost of commodity production
levcost_by_variant(): Per-variant levelized cost tables
levcost_storage_(): Levelized cost of storage
levcost_trade_(): Levelized cost of transmission
set_reports_path() get_reports_path() set_levcost_cache_path() get_levcost_cache_path(): Report and levcost output locations
tech_share_frontier(): Extract feasible share ranges for grouped inputs/outputs

Exporting

compare_inputs() print(<inputs_cmp>): Compare two scenarios' model inputs
compare_models() print(<models_cmp>): Compare two models' contents
compare_scenarios() print(<scenarios_cmp>) autoplot(<scenarios_cmp>) plot(<scenarios_cmp>): Compare solved scenarios (or runs of one scenario)
print(): Print methods for the energyRt classes
summary(<model>) summary(<scenario>): Summarize a model or scenario

energyRt options and settings

get_arrow_format() set_arrow_format() get_arrow_compression() set_arrow_compression() get_arrow_compression_level() set_arrow_compression_level(): Arrow exchange-format options
get_default_solver() set_default_solver(): Default solver
set_option() get_option(): Get or set an energyRt option
set_log_file() get_log_file() read_log(): Read the operation log
get_neos_email() set_neos_email(): NEOS submission email
newHorizon() update(<horizon>) setHorizon(<config>) update(<config>): Create a new object of class 'horizon'
newModel() setHorizon(<model>) getHorizon(<model>): Create new model object
set_progress_bar() show_progress_bar(): Switch on/off and select/customize progress bar
set_registry_file() get_registry_file() set_models_path() get_models_path() set_repositories_path() get_repositories_path() set_datasets_path() get_datasets_path() set_store_versioning() get_store_versioning(): Registry file and model store locations
set_reports_path() get_reports_path() set_levcost_cache_path() get_levcost_cache_path(): Report and levcost output locations
set_scenarios_path() get_scenarios_path(): Set or get the directory with scenarios
setGeoscale(<config>) getGeoscale(<config>) setGeoscale(<model>) getGeoscale(<model>) setGeoscale(<scenario>) getGeoscale(<scenario>) getCalendar(<config>) getCalendar(<model>) getCalendar(<scenario>): Attach or read a model's geoscale
set_gams_path() get_gams_path() set_gdxlib_path() get_gdxlib_path() set_glpk_path() get_glpk_path() set_julia_path() get_julia_path() set_python_path() get_python_path(): Set GAMS and GDX library directory
set_solver_path() get_solver_path(): Set or get the path to a solver toolchain
energyRt-options: energyRt Options
en_config_path() en_config_read() en_config_write(): The energyRt configuration file
en_config_show(): Show the effective energyRt configuration
isVerbose() isDebug(): Verbosity and debug level

utils

en_install_deps(): Install the energyRt dependency library layer
en_install_julia_pkgs(): Install Julia packages
en_install_python_deps(): Install Python/Pyomo dependencies
en_setup(): Set up energyRt after installation
en_check_glpk() en_check_julia() en_check_python() en_check_pyomo() en_check_gams() en_check_gdx() en_check_julia_pkgs() en_check_dependencies(): Detect external solver software and dependencies
en_check_packages(): Check R package and external-tool dependencies
collect_set_elements(): Search through model data for set elements
get_arrow_format() set_arrow_format() get_arrow_compression() set_arrow_compression() get_arrow_compression_level() set_arrow_compression_level(): Arrow exchange-format options
get_default_solver() set_default_solver(): Default solver
set_option() get_option(): Get or set an energyRt option
getData() get_data(): Extract data from energyRt objects
getUnits(<commodity>) getUnits(<technology>) get_units(): Get parameter units for energyRt class objects
get_default_value(): Return default value for one, several, or all parameters
get_process_aux(): Get auxiliary commodities for each process
get_process_class(): Get class of processes
get_process_comm(): Commodities associated with a processes
get_process_inputs(): Get inputs of processes
get_process_invest_window(): Start and end years for process by region
get_process_outputs(): Get output commodities for each process
get_process_region(): Get regions for each process
get_process_stored(): Stored commodities of each process
get_process_timeframe(): Get operational timeframe of processes
get_region(): Collect the regions an object operates in
get_slot_doc(): Retrieve slot details in rd-format
get_variable(): Get one solved variable from a scenario
get_weather(): Collect the weather objects an object refers to
set_log_file() get_log_file() read_log(): Read the operation log
get_neos_email() set_neos_email(): NEOS submission email
set_registry_file() get_registry_file() set_models_path() get_models_path() set_repositories_path() get_repositories_path() set_datasets_path() get_datasets_path() set_store_versioning() get_store_versioning(): Registry file and model store locations
set_reports_path() get_reports_path() set_levcost_cache_path() get_levcost_cache_path(): Report and levcost output locations
set_scenarios_path() get_scenarios_path(): Set or get the directory with scenarios
set_gams_path() get_gams_path() set_gdxlib_path() get_gdxlib_path() set_glpk_path() get_glpk_path() set_julia_path() get_julia_path() set_python_path() get_python_path(): Set GAMS and GDX library directory
set_solver_path() get_solver_path(): Set or get the path to a solver toolchain
complete_set(): Complete a data frame with missing set elements
expand_na_rows() expand_na_regions() expand_na_years() expand_sets(): Expand rows with NA values in set columns
countdown_timer(): Countdown timer to use in R scripts
is_any(): Check if an element of a set is "ANY*" or NA
is_geoscale(): Is this a geoscales::Geoscale?
map_comm_geoframe(): Balancing geo-level of commodities
map_comm_timeframe(): Operational timeframe of a commodities
named_list_to_df(): Convert a named list of vectors to a data frame