# energyRt [![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html) [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) > **A comprehensive, modular energy system modeling framework with an R > interface.** **energyRt** (*energy* system modeling *R-t*oolbox, /ˈɛnərdʒi ɑrt/) provides a modular framework and macro-language for defining, generating, solving, and analyzing energy system optimization models through R. Instead of writing mathematical equations for each application, modelers describe a system using reusable components: commodities, technologies, supply, demand, storage, and trade. energyRt translates these descriptions into optimization models and returns results ready for analysis in R. **Build models from reusable components, from simple examples to large-scale applications.** Define the system once; adapt the analysis to the question. Temporal resolution, geographical detail, solution strategy, and solver backend can change without rebuilding the conceptual model. Start with a compact teaching example, extend it into a detailed sectoral or national model, or explore alternative spatial and temporal representations of the same system. ### Why energyRt? - **Model the system, not the implementation.** Express energy technologies and their relationships as inspectable R objects; let energyRt generate the sets, mappings, equations, and solver-specific code. - **Build incrementally and reuse components.** Assemble complex systems from smaller, understandable bricks; update components and derive model variants without duplicating entire formulations. - **Choose the right scale for each question.** Combine multiple balancing timeframes and nested geographical levels, and experiment with aggregation or sampling without redefining the underlying system. - **Avoid solver lock-in.** Use MathProg, JuMP, Pyomo, GAMS, or an experimental direct LP-matrix route, depending on the computational environment and problem size. - **Go beyond a single solve.** Manage scenarios, inspect generated models, validate solutions, visualize results, and build reproducible analyses. energyRt provides **modeling machinery rather than a fixed model, dataset, or scenario**. It is intended for analysts, researchers, educators, and model developers who need both flexibility and transparency — from introductory exercises to large-scale energy-system studies. ## How it works: bricks and axes ![A TOPIA model: nested regions as stacked map planes, the calendar and planning horizon, four process diagrams, and the solved daily dispatch and generation mix](reference/figures/readme-model.png) A TOPIA model: nested regions as stacked map planes, the calendar and planning horizon, four process diagrams, and the solved daily dispatch and generation mix *The teaching model TOPIA, drawn by energyRt: the nested regions, the calendar and horizon, four bricks as declared, and the solved dispatch and generation mix.* - **Bricks.** Commodities, supply, demand, technologies, storage, trade, weather, taxes, subsidies and custom constraints are plain R objects. energyRt generates the sets, mappings, equations, solver files and result tables; [`update()`](https://energyRt.org/reference/update.md) derives a variant from an existing object. - **Time.** A nested [timescales](https://github.com/optimal2050/timescales) calendar — annual, seasonal, hourly, representative or sampled — with different commodities balancing at different timeframes in one model. No fixed 8,760-slice ceiling. - **Space.** A [geoscales](https://github.com/optimal2050/geoscales) hierarchy lets national, zonal and nodal balances coexist, with each process and commodity at the level where its data is. - **Solver.** The same model writes MathProg, JuMP, Pyomo or GAMS, or goes straight to an LP matrix, locally or remotely. These are independent structural axes: a model is declared once at full resolution, and a coarser or sampled calendar, a sub-territory, or a different solver is passed at solve time. ## Quickstart A model with one fuel, one power plant and one demand. GLPK is bundled in the `glpsol` package, so no further solver is required. ``` r library(energyRt) GAS <- newCommodity( name = "GAS", timeframe = "ANNUAL" ) ELC <- newCommodity( name = "ELC", timeframe = "ANNUAL" ) SUP_GAS <- newSupply( name = "SUP_GAS", commodity = "GAS", supply = data.frame(cost = 6.0) # MEUR/PJ ) EGAS <- newTechnology( name = "EGAS", input = list(comm = "GAS"), output = list(comm = "ELC"), ceff = data.frame( comm = "GAS", cinp2use = 0.55 ), invcost = list(invcost = 900), # MEUR/GW fixom = 25, cap2act = 31.536, olife = 25L ) DEM_ELC <- newDemand( name = "DEM_ELC", commodity = "ELC", demand = data.frame(demand = 50) # PJ/year ) mod <- newModel( name = "HELLO", data = newRepository("parts", GAS, ELC, SUP_GAS, EGAS, DEM_ELC), region = "R1", discount = 0.05, horizon = newHorizon( period = 2025:2040, intervals = c(1, 5, 10), mid_is_end = TRUE ) ) scen <- solve_model( mod, name = "BASE", solver = solver_options$glpk ) getData(scen, "vObjective", merge = TRUE) # discounted system cost getData(scen, "vTechCap", merge = TRUE) # installed capacity ``` Changing an axis is one argument on the same objects — here the solver: ``` r scen_highs <- solve_model( mod, name = "BASE_highs", solver = solver_options$julia_highs ) ``` [`solve_model()`](https://energyRt.org/reference/solve_model.md) interpolates and solves in one call. To inspect or modify the interpolated scenario, use the composable stages: ``` r scen <- mod |> interpolate(name = "BASE") |> solve() ``` The [Get started](https://energyrt.org/articles/energyRt.html) vignette explains the model and workflow step by step. ## Modeling and analysis capabilities - **Bricks** — commodities, processes, user constraints and the containers that hold them, each drawable and inspectable. [Model bricks](https://energyrt.org/articles/model-bricks.html) - **Nested time** — user-defined calendars, mixed balancing timeframes, sampled calendars for iteration. [Time resolution](https://energyrt.org/articles/resolution.html) - **Nested space** — multi-level balances, coarse processes over fine commodities, region aggregation and sub-territory solves. [Space resolution](https://energyrt.org/articles/resolution.html) - **Vintages, clusters and graded resources** — one object expands into a family of processes; tiered commodities and weather so the best sites run out before the next grade starts. [Vintages & clusters](https://energyrt.org/articles/variants.html) - **Four languages, a direct matrix, GPU and cloud** — MathProg, JuMP, Pyomo or GAMS from one model; an LP/MPS matrix through multimod; NEOS and cloud execution. [Solver backends](https://energyrt.org/articles/backends.html) - **Solve strategies** — perfect foresight, myopic, sampled, region by region, or guided toward a target, each recorded as a run. [Workflow](https://energyrt.org/articles/workflow.html) - **Data and scenario management** — a project registry addressing thousands of solved runs by name; Arrow-backed results larger than memory. [Scenario management](https://energyrt.org/articles/scenario-management.html) - **Validation and reproducibility** — structural checks that refuse a meaningless model, [`verify_solution()`](https://energyRt.org/reference/verify_solution.md) re-deriving the model’s own identities, content hashes for every object. [Workflow](https://energyrt.org/articles/workflow.html) - **Reporting and visualisation** — [`draw()`](https://energyRt.org/reference/draw.md) diagrams, `autoplot()`, maps, levelized costs without a solver, and HTML/PDF/Word reports for any object. [Reports](https://energyrt.org/articles/reports.html), [autoplot()](https://energyrt.org/articles/autoplot.html) The full inventory is in [Features](https://energyrt.org/articles/features.html). ## Modeling languages and solve routes Four modelling languages, one direct-matrix route, and remote execution. The model definition does not change between them. | Route | What it does | Good fit | |----|----|----| | [GLPK / MathProg](https://www.gnu.org/software/glpk/) | Writes MathProg and solves with `glpsol` | First models, teaching, transparent local runs | | [Julia / JuMP](https://jump.dev/) | Writes JuMP for HiGHS, CBC, GLPK, CPLEX or cuOpt | Larger local models and a choice of algorithms | | [Python / Pyomo](https://www.pyomo.org/) | Writes Pyomo for HiGHS, CBC, GLPK or CPLEX | Python-based solver environments | | [GAMS](https://www.gams.com/) | Writes GAMS for solvers such as CPLEX or CBC | Existing institutional GAMS workflows | | [multimod](https://github.com/optimal2050/multimod) | Assembles the LP matrix directly, writes MPS, solves with HiGHS or cuOpt, or renders the formulation as LaTeX | Large linear problems, documentation, inspection | [NEOS](https://neos-server.org/) runs supported solver jobs remotely without a local licence. GPU first-order solving uses NVIDIA cuOpt through JuMP (Linux, or WSL on Windows), or cloud hardware through the experimental mmcloud route. Setup, presets and limits are in [Solver backends](https://energyrt.org/articles/backends.html). ## Installation ``` r pak::pkg_install(c("optimal2050/energyRt", "glpsol")) ``` `pak` installs energyRt’s R dependencies, including the optimal2050 packages listed in `DESCRIPTION`. The `glpsol` package bundles the GLPK binary on every platform, and energyRt uses it first; Julia/JuMP, Python/Pyomo or GAMS are configured separately. Then check the setup: ``` r library(energyRt) en_setup() en_check_dependencies() ``` The [installation guide](https://energyrt.org/articles/install.html) has the platform-specific steps. ## Documentation - [Features](https://energyrt.org/articles/features.html) — the full inventory of capabilities, organised by axis and workflow stage. - [Get started](https://energyrt.org/articles/energyRt.html) — the core idea and first model. - [Model bricks](https://energyrt.org/articles/model-bricks.html) — the objects used to describe a system. - [Model dimensions](https://energyrt.org/articles/resolution.html) and [timescales](https://github.com/optimal2050/timescales) — user-defined nested calendars and regional hierarchies. - [Storage](https://energyrt.org/articles/storage.html) and [Vintages & clusters](https://energyrt.org/articles/variants.html) — the two classes with the most structure, worked through end to end. - [Units](https://energyrt.org/articles/units.html) — stating units, and the capacity-to-activity conversion. - [TOPIA I](https://energyrt.org/articles/topia-build.html), [II](https://energyrt.org/articles/topia-use.html) and [III](https://energyrt.org/articles/region-aggregation.html) — building a complete teaching model, running scenarios on it, and aggregating its regions. - [Workflow](https://energyrt.org/articles/workflow.html), [scenario management](https://energyrt.org/articles/scenario-management.html) and [reports](https://energyrt.org/articles/reports.html) — from a model to a reproducible study. - [reneuro](https://github.com/optimal2050/reneuro/) — the same machinery applied to Europe + Neighbors power system at production scale. ## Status Version 0.90 is the pre-release for v1.0 and the first release since `v0.50-beta`; what remains before v1.0 is testing, debugging and visualisation rather than new structure. The [release notes](https://energyrt.org/news/) list what changed. Bug reports and proposed improvements go to the [issue tracker](https://github.com/optimal2050/energyRt/issues). The package website is . # Package index ## Model components The S4 classes a model is made of. Each is built by its `new*()` constructor below and carries its data in slots. - [`class-calendar`](https://energyRt.org/reference/class-calendar.md) : An S4 class to represent sub-annual time resolution structure. - [`class-commodity`](https://energyRt.org/reference/class-commodity.md) : An S4 class to represent a commodity - [`class-config`](https://energyRt.org/reference/class-config.md) : An S4 class to represent default model configuration. - [`class-constraint`](https://energyRt.org/reference/class-constraint.md) [`class-summand`](https://energyRt.org/reference/class-constraint.md) [`summand-class`](https://energyRt.org/reference/class-constraint.md) **\[experimental\]** : An S4 class to represent a custom constraint. - [`class-costs`](https://energyRt.org/reference/class-costs.md) **\[experimental\]** : An S4 class to add costs to objective function - [`class-demand`](https://energyRt.org/reference/class-demand.md) : An S4 class to declare a demand in the model - [`class-export`](https://energyRt.org/reference/class-export.md) : An S4 class to represent commodity export to the rest of the world. - [`class-horizon`](https://energyRt.org/reference/class-horizon.md) : An S4 class to represent model/scenario planning horizon with intervals (year-steps) - [`class-import`](https://energyRt.org/reference/class-import.md) : An S4 class to represent commodity import from the rest of the world. - [`class-model`](https://energyRt.org/reference/class-model.md) [`model`](https://energyRt.org/reference/class-model.md) : An S4 class to represent model - [`class-modInp`](https://energyRt.org/reference/class-modInp.md) : An S4 class to represent model input - [`class-modOut`](https://energyRt.org/reference/class-modOut.md) : An S4 class to store results of a solved scenario - [`class-parameter`](https://energyRt.org/reference/class-parameter.md) : An S4 class to specify the model set or parameter - [`class-repository`](https://energyRt.org/reference/class-repository.md) : An S4 class to store the model objects. - [`class-scenario`](https://energyRt.org/reference/class-scenario.md) [`scenario`](https://energyRt.org/reference/class-scenario.md) : An S4 class to represent scenario, an interpolated and/or solved model. - [`class-settings`](https://energyRt.org/reference/class-settings.md) : An S4 class to represent scenario settings - [`class-technology`](https://energyRt.org/reference/class-technology.md) : An S4 class to represent technology - [`class-trade`](https://energyRt.org/reference/class-trade.md) : An S4 class to represent inter-regional trade - [`class-variable`](https://energyRt.org/reference/class-variable.md) : An S4 class to specify a model variable - [`class-weather`](https://energyRt.org/reference/class-weather.md) : S4 class to represent weather factors - [`storage-class`](https://energyRt.org/reference/class-storage.md) : An S4 class to represent storage type of technological process. - [`subsidy-class`](https://energyRt.org/reference/class-subsidy.md) : An S4 class to represent a commodity subsidy - [`tax-class`](https://energyRt.org/reference/class-tax.md) : An S4 class to represent a commodity tax - [`supply-class`](https://energyRt.org/reference/supply-class.md) : An S4 class to represent a supply of a commodity - [`energyRt-validity`](https://energyRt.org/reference/energyRt-validity.md) : Object construction and validity in energyRt ## Building a model Constructors for the objects above, the repository that holds them, and the model that binds them to a calendar, regions and a horizon. - [`newModel()`](https://energyRt.org/reference/newModel.md) [`setHorizon(`*``*`)`](https://energyRt.org/reference/newModel.md) [`getHorizon(`*``*`)`](https://energyRt.org/reference/newModel.md) : Create new model object - [`newRepository()`](https://energyRt.org/reference/newRepository.md) : A constructor for the repository class - [`newCommodity()`](https://energyRt.org/reference/newCommodity.md) : Create new commodity object - [`newTechnology()`](https://energyRt.org/reference/technology.md) [`update(`*``*`)`](https://energyRt.org/reference/technology.md) : Create a new "technology" object. - [`newStorage()`](https://energyRt.org/reference/storage.md) : Create new storage object - [`newSupply()`](https://energyRt.org/reference/newSupply.md) : Constructor for supply object. - [`newDemand()`](https://energyRt.org/reference/newDemand.md) [`update(`*``*`)`](https://energyRt.org/reference/newDemand.md) : Create new demand object - [`newTrade()`](https://energyRt.org/reference/newTrade.md) : Create new trade object - [`newACLine()`](https://energyRt.org/reference/newACLine.md) **\[experimental\]** : Create an AC transmission line - [`newDCLink()`](https://energyRt.org/reference/newDCLink.md) **\[experimental\]** : Create a DC transmission link - [`newImport()`](https://energyRt.org/reference/newImport.md) : Create new export object - [`newExport()`](https://energyRt.org/reference/newExport.md) [`update(`*``*`)`](https://energyRt.org/reference/newExport.md) : Create new export object - [`newWeather()`](https://energyRt.org/reference/newWeather.md) [`update(`*``*`)`](https://energyRt.org/reference/newWeather.md) : Create new weather object - [`newConstraint()`](https://energyRt.org/reference/newConstraint.md) : Create constraint object to add custom constraints to the model. - [`newCosts()`](https://energyRt.org/reference/newCosts.md) : Create new costs object - [`newTax()`](https://energyRt.org/reference/newTax.md) : Create a new tax object - [`newSubsidy()`](https://energyRt.org/reference/newSubsidy.md) : Create a new subsidy object - [`newScenario()`](https://energyRt.org/reference/newScenario.md) : Generate a new scenario object - [`newRegistry()`](https://energyRt.org/reference/registry.md) [`load_registry()`](https://energyRt.org/reference/registry.md) [`save_registry()`](https://energyRt.org/reference/registry.md) [`add_to_registry()`](https://energyRt.org/reference/registry.md) [`add(`*``*`)`](https://energyRt.org/reference/registry.md) [`summary(`*``*`)`](https://energyRt.org/reference/registry.md) [`find_in_registry()`](https://energyRt.org/reference/registry.md) [`refresh_registry()`](https://energyRt.org/reference/registry.md) : Project registry of models, scenarios, and runs - [`add(`*``*`)`](https://energyRt.org/reference/add.md) [`add(`*``*`)`](https://energyRt.org/reference/add.md) : Add an object to the model's repository - [`update(`*``*`)`](https://energyRt.org/reference/update.md) [`update(`*``*`)`](https://energyRt.org/reference/update.md) [`update(`*``*`)`](https://energyRt.org/reference/update.md) [`update(`*``*`)`](https://energyRt.org/reference/update.md) : Update supply object - [`update(`*``*`)`](https://energyRt.org/reference/update-model-method.md) : Update a model's elements and the frames they are declared at - [`asSupplyCurve()`](https://energyRt.org/reference/supply-curve.md) [`asImportCurve()`](https://energyRt.org/reference/supply-curve.md) [`asExportCurve()`](https://energyRt.org/reference/supply-curve.md) **\[experimental\]** : Stepped supply, export and import curves - [`lossTranches()`](https://energyRt.org/reference/lossTranches.md) **\[experimental\]** : Loss tranches for a transmission line - [`combine_vintages()`](https://energyRt.org/reference/combine_vintages.md) : Combine per-vintage technology objects into one vintaged technology ## Time resolution Calendars and horizons. The shipped `calendars` catalog is generated with the sibling *timescales* package; [`newCalendar()`](https://energyRt.org/reference/newCalendar.md) builds your own. - [`newCalendar()`](https://energyRt.org/reference/newCalendar.md) : Generate a new calendar object from - [`newHorizon()`](https://energyRt.org/reference/newHorizon.md) [`update(`*``*`)`](https://energyRt.org/reference/newHorizon.md) [`setHorizon(`*``*`)`](https://energyRt.org/reference/newHorizon.md) [`update(`*``*`)`](https://energyRt.org/reference/newHorizon.md) : Create a new object of class 'horizon' - [`calendars`](https://energyRt.org/reference/calendars.md) : Example calendars - [`horizons`](https://energyRt.org/reference/horizons.md) : Example planning horizons - [`tsl_sets`](https://energyRt.org/reference/timeslices.md) [`tsl_levels`](https://energyRt.org/reference/timeslices.md) : Sets of the common formats with structure - [`make_timetable()`](https://energyRt.org/reference/calendar.md) : Create timetable of time-timeslices from given structure as a list - [`recast_model_calendar()`](https://energyRt.org/reference/recast_model_calendar.md) : Recast a model onto another calendar - [`setCalendar(`*``*`)`](https://energyRt.org/reference/setCalendar.md) [`setCalendar(`*``*`)`](https://energyRt.org/reference/setCalendar.md) [`setCalendar(`*``*`)`](https://energyRt.org/reference/setCalendar.md) [`getCalendar(`*``*`)`](https://energyRt.org/reference/setCalendar.md) [`getCalendar(`*``*`)`](https://energyRt.org/reference/setCalendar.md) [`getCalendar(`*``*`)`](https://energyRt.org/reference/setCalendar.md) : Set or get a model's calendar, for every year or for particular years - [`getYearCalendars()`](https://energyRt.org/reference/getYearCalendars.md) : Calendars by milestone year - [`autoplot(`*``*`)`](https://energyRt.org/reference/plot_calendar_method.md) : Visualize a Calendar object - [`autoplot(`*``*`)`](https://energyRt.org/reference/plot_horizon_method.md) : Visualize a Horizon object - [`year_label()`](https://energyRt.org/reference/year_label.md) : Display labels of the model's milestone years ## Space resolution Multi-level regions. A commodity declares the level it balances on, and coarse balances roll up without a `trade` route for every pair. - [`setGeoscale(`*``*`)`](https://energyRt.org/reference/setGeoscale.md) [`getGeoscale(`*``*`)`](https://energyRt.org/reference/setGeoscale.md) [`setGeoscale(`*``*`)`](https://energyRt.org/reference/setGeoscale.md) [`getGeoscale(`*``*`)`](https://energyRt.org/reference/setGeoscale.md) [`setGeoscale(`*``*`)`](https://energyRt.org/reference/setGeoscale.md) [`getGeoscale(`*``*`)`](https://energyRt.org/reference/setGeoscale.md) : Attach or read a model's geoscale - [`get_process_groups()`](https://energyRt.org/reference/get_process_groups.md) : Technologies that may be merged into one clustered object - [`process_cluster_sweep()`](https://energyRt.org/reference/process_cluster_sweep.md) : Sweep a technology family's clusterings, to choose `k` by looking - [`model_clusters()`](https://energyRt.org/reference/model_clusters.md) : The clustering behind an aggregated model - [`check_geoscale_regions()`](https://energyRt.org/reference/check_geoscale_regions.md) : Check a geoscale against the model's declared regions - [`plot_map()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_heatmap()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_trade_map()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_trade_network()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_share_frontier()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_geoscale()`](https://energyRt.org/reference/energyRt-deprecated.md) : Deprecated plotting names - [`get_region()`](https://energyRt.org/reference/get_region.md) : Collect the regions an object operates in - [`subset_model_regions()`](https://energyRt.org/reference/subset_model_regions.md) : Restrict a model to a region subset - [`is_separable()`](https://energyRt.org/reference/is_separable.md) : Can these regions be separated from the model? - [`aggregate_model_regions()`](https://energyRt.org/reference/aggregate_model_regions.md) : Aggregate a model to a coarser set of regions - [`check_model_levels()`](https://energyRt.org/reference/check_model_levels.md) : Check declared resolutions against the commodities they serve - [`verify_aggregation()`](https://energyRt.org/reference/verify_aggregation.md) : Check what an aggregation conserved ## Process specifications Portable YAML/JSON process definitions, and the interactive designer. - [`process_from_spec()`](https://energyRt.org/reference/process_from_spec.md) : Build a process object from a spec - [`process_to_spec()`](https://energyRt.org/reference/process_to_spec.md) : Export a process object as a spec list - [`process_spec_code()`](https://energyRt.org/reference/process_spec_code.md) : The constructor call equivalent to a process spec, as text - [`process_spec_issues()`](https://energyRt.org/reference/process_spec_issues.md) : Validate a process spec and report issues - [`read_process_spec()`](https://energyRt.org/reference/read_process_spec.md) : Read and validate a process spec - [`process_designer()`](https://energyRt.org/reference/process_designer.md) : Launch the process designer - [`read_technology_xlsx()`](https://energyRt.org/reference/read_technology_xlsx.md) : Read `technology` object(s) from an Excel workbook - [`write_technology_xlsx()`](https://energyRt.org/reference/write_technology_xlsx.md) : Write `technology` object(s) to an Excel workbook ## Interpolating and solving The core pipeline. [`solve_model()`](https://energyRt.org/reference/solve_model.md) does the whole sequence; the separate verbs let a stage be inspected or re-run. - [`interpolate_model()`](https://energyRt.org/reference/interpolate_model.md) [`interpolate(`*``*`)`](https://energyRt.org/reference/interpolate_model.md) : Interpolate a model into a solver-ready scenario - [`setObjectiveWeights()`](https://energyRt.org/reference/setObjectiveWeights.md) : Weight the objective by milestone year and by region - [`solve_model()`](https://energyRt.org/reference/solve_model.md) [`solve_scenario()`](https://energyRt.org/reference/solve_model.md) [`solve(`*``*`,`*``*`)`](https://energyRt.org/reference/solve_model.md) : Solve a model or an interpolated scenario - [`write_script()`](https://energyRt.org/reference/write.md) [`write_sc()`](https://energyRt.org/reference/write.md) : Write scenario object as a Python, Julia, GAMS, or MathProg script with data files to a directory - [`read_solution()`](https://energyRt.org/reference/read.md) [`read(`*``*`)`](https://energyRt.org/reference/read.md) : Read a solved run's solution into a scenario - [`read_sequence()`](https://energyRt.org/reference/read_sequence.md) : Rebuild a solve sequence from the variants on disk - [`with_solver_log()`](https://energyRt.org/reference/with_solver_log.md) : Send the solver's progress log to a file ## multimod Converting an interpolated scenario into a [multimod](https://github.com/optimal2050/multimod) model, which can then be rendered to any backend multimod supports or assembled straight into a matrix and solved. multimod is a suggested package; these are no-ops without it. - [`as_multimod(`*``*`)`](https://energyRt.org/reference/as_multimod.scenario.md) : Build a multimod model from an interpolated scenario - [`multimod_import_data()`](https://energyRt.org/reference/multimod_import_data.md) : Import energyRt scenario data into a multimod model - [`multimod_import_log()`](https://energyRt.org/reference/multimod_import_log.md) : Get data import log from model - [`multimod_unmatched()`](https://energyRt.org/reference/multimod_unmatched.md) : Show unmatched elements - [`multimod_from_energyRt()`](https://energyRt.org/reference/multimod_from_energyRt.md) : Build a multimod model from an interpolated energyRt scenario ## Solver configuration Choosing a backend and pointing energyRt at it. - [`get_default_solver()`](https://energyRt.org/reference/default_solver.md) [`set_default_solver()`](https://energyRt.org/reference/default_solver.md) : Default solver - [`set_solver_path()`](https://energyRt.org/reference/solver_path.md) [`get_solver_path()`](https://energyRt.org/reference/solver_path.md) : Set or get the path to a solver toolchain - [`set_gams_path()`](https://energyRt.org/reference/solver.md) [`get_gams_path()`](https://energyRt.org/reference/solver.md) [`set_gdxlib_path()`](https://energyRt.org/reference/solver.md) [`get_gdxlib_path()`](https://energyRt.org/reference/solver.md) [`set_glpk_path()`](https://energyRt.org/reference/solver.md) [`get_glpk_path()`](https://energyRt.org/reference/solver.md) [`set_julia_path()`](https://energyRt.org/reference/solver.md) [`get_julia_path()`](https://energyRt.org/reference/solver.md) [`set_python_path()`](https://energyRt.org/reference/solver.md) [`get_python_path()`](https://energyRt.org/reference/solver.md) : Set GAMS and GDX library directory - [`get_exchange_format()`](https://energyRt.org/reference/exchange_format.md) [`set_exchange_format()`](https://energyRt.org/reference/exchange_format.md) [`get_exchange_compression()`](https://energyRt.org/reference/exchange_format.md) [`set_exchange_compression()`](https://energyRt.org/reference/exchange_format.md) [`get_exchange_compression_level()`](https://energyRt.org/reference/exchange_format.md) [`set_exchange_compression_level()`](https://energyRt.org/reference/exchange_format.md) : Solver data-exchange options - [`get_storage_format()`](https://energyRt.org/reference/storage_format.md) [`set_storage_format()`](https://energyRt.org/reference/storage_format.md) [`get_storage_compression()`](https://energyRt.org/reference/storage_format.md) [`set_storage_compression()`](https://energyRt.org/reference/storage_format.md) [`get_storage_compression_level()`](https://energyRt.org/reference/storage_format.md) [`set_storage_compression_level()`](https://energyRt.org/reference/storage_format.md) : On-disk table storage options ## Remote and cloud solving Solving where you are not: the NEOS server for GAMS/CPLEX without a local licence, and GPU/cloud execution for models too large for a laptop. - [`neos_ping()`](https://energyRt.org/reference/neos.md) [`neos_list_solvers()`](https://energyRt.org/reference/neos.md) : NEOS Server client (query the remote solver service) - [`get_neos_email()`](https://energyRt.org/reference/neos_email.md) [`set_neos_email()`](https://energyRt.org/reference/neos_email.md) : NEOS submission email ## Solve drivers Sequences of solves — recursive milestone-by-milestone, sampled calendars, decomposition, and guided target-seeking — with their primitives. - [`solve_recursive()`](https://energyRt.org/reference/solve_recursive.md) : Solve a model recursively, milestone by milestone - [`solve_by_sample()`](https://energyRt.org/reference/solve_by_sample.md) : Solve a model on samples of its calendar - [`solve_by_region()`](https://energyRt.org/reference/solve_by_region.md) : Solve a model region by region - [`solve_guided()`](https://energyRt.org/reference/solve_guided.md) : Solve a model with guided perfect foresight - [`solve_base_year()`](https://energyRt.org/reference/solve_base_year.md) : Solve the base year of a marked horizon - [`horizon_windows()`](https://energyRt.org/reference/horizon_windows.md) : Split a horizon into sequential solve windows - [`solution_ledger()`](https://energyRt.org/reference/solution_ledger.md) : Extract the carry-forward ledger from a solved scenario - [`apply_ledger()`](https://energyRt.org/reference/apply_ledger.md) : Apply a carry ledger to a model - [`recursive_objective()`](https://energyRt.org/reference/recursive_objective.md) : Globally discounted total cost of a recursive sequence - [`sequence_coverage()`](https://energyRt.org/reference/sequence_coverage.md) : What a solve sequence covered - [`calendar_samples()`](https://energyRt.org/reference/calendar_samples.md) : Build a calendar-sample specification - [`sample_calendar()`](https://energyRt.org/reference/sample_calendar.md) : Build a calendar from a sample of another's timeslices - [`sample_summary()`](https://energyRt.org/reference/sample_summary.md) : Summarise an ensemble across samples - [`boundary_window()`](https://energyRt.org/reference/boundary_window.md) : A generic boundary trade window - [`guided_windows()`](https://energyRt.org/reference/guided_windows.md) : Two-milestone windows for a guided solve - [`guided_gap()`](https://energyRt.org/reference/guided_gap.md) : Cost of the guidance - [`solution_targets()`](https://energyRt.org/reference/solution_targets.md) : Capacity targets from a solved scenario - [`apply_targets()`](https://energyRt.org/reference/apply_targets.md) : Impose capacity targets on a model ## Reading results Getting tidy data out of a solved scenario. - [`getData()`](https://energyRt.org/reference/getData.md) : Extract data from energyRt objects - [`get_variable()`](https://energyRt.org/reference/get_variable.md) : Get one solved variable from a scenario - [`get_weather()`](https://energyRt.org/reference/get_weather.md) : Collect the weather objects an object refers to - [`getMix()`](https://energyRt.org/reference/getMix.md) : Extract a tidy mix (generation, capacity, fuel) from a solved scenario - [`objective_weights()`](https://energyRt.org/reference/objective_weights.md) : The objective, weighted and unweighted - [`getObject()`](https://energyRt.org/reference/getObject.md) : Retrieve model objects from a repository, model or scenario - [`getUnit()`](https://energyRt.org/reference/getUnit.md) : Unit of an object's own measure - [`getScenario()`](https://energyRt.org/reference/accessors.md) [`getModel()`](https://energyRt.org/reference/accessors.md) [`getRepository()`](https://energyRt.org/reference/accessors.md) [`getDataset()`](https://energyRt.org/reference/accessors.md) [`open_project()`](https://energyRt.org/reference/accessors.md) : Access registered scenarios, models, repositories, and datasets by name - [`getVariants()`](https://energyRt.org/reference/getVariants.md) : Process variants of a solved (or interpolated) scenario - [`variantSummary()`](https://energyRt.org/reference/variantSummary.md) : Summarise a result variable across technology variants - [`findData()`](https://energyRt.org/reference/findData.md) : Performs search for available data in *scenario* object. - [`find_in_model()`](https://energyRt.org/reference/find_in_model.md) : Find where value(s) are stored across a model's objects - [`findDuplicates()`](https://energyRt.org/reference/findDuplicates.md) : Function to find duplicated values in interpolated scenario. - [`size()`](https://energyRt.org/reference/size.md) : Size of an object - [`model_size()`](https://energyRt.org/reference/model_size.md) : Size estimate of an interpolated scenario and the result of folding ## Levelized cost Pricing a technology a-priori (screening LCOE) or ex-post from a solved scenario. - [`levcost()`](https://energyRt.org/reference/levcost.md) : Levelized cost of commodity production - [`tech_share_frontier()`](https://energyRt.org/reference/tech_share_frontier.md) : Extract feasible share ranges for grouped inputs/outputs - [`plot_map()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_heatmap()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_trade_map()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_trade_network()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_share_frontier()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_geoscale()`](https://energyRt.org/reference/energyRt-deprecated.md) : Deprecated plotting names - [`clear_levcost_cache()`](https://energyRt.org/reference/clear_levcost_cache.md) : Clear cached levcost results - [`storage_duration()`](https://energyRt.org/reference/storage_duration.md) : Split a storage level into duration bands ## Reporting Rendered datasheets for models, scenarios and processes. - [`report()`](https://energyRt.org/reference/report.md) : Generate a summary report for an energyRt object - [`report_html()`](https://energyRt.org/reference/report_html.md) : Generate an HTML report for an energyRt object - [`report_pdf()`](https://energyRt.org/reference/report_pdf.md) : Generate a PDF report for an energyRt object - [`report_docx()`](https://energyRt.org/reference/report_docx.md) : Generate a Word report for an energyRt object - [`report_tex()`](https://energyRt.org/reference/report_tex.md) : Generate a LaTeX report for an energyRt object - [`report_templates()`](https://energyRt.org/reference/report_templates.md) : List the available report templates - [`report_output()`](https://energyRt.org/reference/report_helpers.md) [`report_setup()`](https://energyRt.org/reference/report_helpers.md) [`report_layout()`](https://energyRt.org/reference/report_helpers.md) [`report_esc()`](https://energyRt.org/reference/report_helpers.md) [`report_fmt_val()`](https://energyRt.org/reference/report_helpers.md) [`report_img()`](https://energyRt.org/reference/report_helpers.md) [`report_img_row()`](https://energyRt.org/reference/report_helpers.md) [`report_pagebreak()`](https://energyRt.org/reference/report_helpers.md) [`report_fig_height()`](https://energyRt.org/reference/report_helpers.md) [`report_plot_png()`](https://energyRt.org/reference/report_helpers.md) [`report_fig()`](https://energyRt.org/reference/report_helpers.md) [`report_sec()`](https://energyRt.org/reference/report_helpers.md) [`report_tbl()`](https://energyRt.org/reference/report_helpers.md) [`report_css()`](https://energyRt.org/reference/report_helpers.md) [`report_header()`](https://energyRt.org/reference/report_helpers.md) : Report template helpers - [`clear_report_cache()`](https://energyRt.org/reference/clear_report_cache.md) : Delete rendered reports - [`set_reports_path()`](https://energyRt.org/reference/reports_path.md) [`get_reports_path()`](https://energyRt.org/reference/reports_path.md) [`set_levcost_cache_path()`](https://energyRt.org/reference/reports_path.md) [`get_levcost_cache_path()`](https://energyRt.org/reference/reports_path.md) : Report and levcost output locations ## Comparison Compare scenarios’ solved results (or runs of one scenario), models’ declarations, and interpolated model inputs. - [`compare_inputs()`](https://energyRt.org/reference/compare_inputs.md) [`print(`*``*`)`](https://energyRt.org/reference/compare_inputs.md) : Compare two scenarios' model inputs - [`compare_interp_settings()`](https://energyRt.org/reference/compare_interp_settings.md) : Compare interpolation settings (size & build time) for a model - [`compare_models()`](https://energyRt.org/reference/compare_models.md) [`print(`*``*`)`](https://energyRt.org/reference/compare_models.md) : Compare two models' contents - [`compare_scenarios()`](https://energyRt.org/reference/compare_scenarios.md) [`print(`*``*`)`](https://energyRt.org/reference/compare_scenarios.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/compare_scenarios.md) [`plot(`*``*`)`](https://energyRt.org/reference/compare_scenarios.md) : Compare solved scenarios (or runs of one scenario) - [`compare_solve_settings()`](https://energyRt.org/reference/compare_solve_settings.md) : Compare interpolation settings AND solvers for a model ## Visualisation Plots and diagrams. - [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.commodity.md) : Visualize a Commodity object - [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.levcost_variants.md) : Compare levelized cost across a technology's variant grid - [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.lever.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.lever.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.lever.md) : Plot a tax, subsidy or user constraint over years - [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.process.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.process.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.process.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.process.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.process.md) : Visualize a process object over years - [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.scenario.md) : Plot mixes from a solved scenario - [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.sequence.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.sequence.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.sequence.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/autoplot.sequence.md) : Draw what a solve sequence covered - [`compare_scenarios()`](https://energyRt.org/reference/compare_scenarios.md) [`print(`*``*`)`](https://energyRt.org/reference/compare_scenarios.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/compare_scenarios.md) [`plot(`*``*`)`](https://energyRt.org/reference/compare_scenarios.md) : Compare solved scenarios (or runs of one scenario) - [`gg_trade_map()`](https://energyRt.org/reference/gg_trade_map.md) [`autoplot(`*``*`)`](https://energyRt.org/reference/gg_trade_map.md) : Map inter-regional trade routes - [`autoplot(`*``*`)`](https://energyRt.org/reference/plot_calendar_method.md) : Visualize a Calendar object - [`autoplot(`*``*`)`](https://energyRt.org/reference/plot_horizon_method.md) : Visualize a Horizon object - [`gg_heatmap()`](https://energyRt.org/reference/gg_heatmap.md) : Heatmap of timeslice-indexed values over a calendar - [`gg_map()`](https://energyRt.org/reference/gg_map.md) : Map model results by region - [`gg_share_frontier()`](https://energyRt.org/reference/gg_share_frontier.md) : Plot feasible share-mix diagram for technology inputs/outputs - [`gg_trade_network()`](https://energyRt.org/reference/gg_trade_network.md) : Plot trade as a network: capacities and flows between regions - [`draw()`](https://energyRt.org/reference/draw.md) [`draw.technology()`](https://energyRt.org/reference/draw.md) : Draw a schematic representation of a process - [`plot_map()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_heatmap()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_trade_map()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_trade_network()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_share_frontier()`](https://energyRt.org/reference/energyRt-deprecated.md) [`plot_geoscale()`](https://energyRt.org/reference/energyRt-deprecated.md) : Deprecated plotting names - [`object_image()`](https://energyRt.org/reference/object_image.md) : Image or icon attached to a model object - [`theme_energyRt()`](https://energyRt.org/reference/theme_energyRt.md) : energyRt's default ggplot theme - [`ghost_options()`](https://energyRt.org/reference/ghost_options.md) : Geometry of the faded "ghost" vintages behind a drawn technology - [`design()`](https://energyRt.org/reference/design.md) : Generate an R script that recreates an energyRt object ## Saving and loading Models, repositories and scenarios on disk — Arrow-backed, so results larger than memory stay readable. - [`save_model()`](https://energyRt.org/reference/model_store.md) [`load_model()`](https://energyRt.org/reference/model_store.md) : Save a model to / load a model from the model store - [`save_repository()`](https://energyRt.org/reference/repo_store.md) [`load_repository()`](https://energyRt.org/reference/repo_store.md) : Save a repository to / load a repository from the repository store - [`save_scenario()`](https://energyRt.org/reference/save_scenario.md) : Save scenario object on disk in parquet format using `arrow` package. - [`load_scenario()`](https://energyRt.org/reference/load_scenario.md) [`load_scenarios()`](https://energyRt.org/reference/load_scenario.md) : Load scenario (in progress) - [`seal_model()`](https://energyRt.org/reference/seal.md) [`unseal_model()`](https://energyRt.org/reference/seal.md) [`seal_repository()`](https://energyRt.org/reference/seal.md) [`unseal_repository()`](https://energyRt.org/reference/seal.md) [`seal_dataset()`](https://energyRt.org/reference/seal.md) [`unseal_dataset()`](https://energyRt.org/reference/seal.md) [`seal_scenario()`](https://energyRt.org/reference/seal.md) [`unseal_scenario()`](https://energyRt.org/reference/seal.md) [`mark_delete()`](https://energyRt.org/reference/seal.md) [`unmark_delete()`](https://energyRt.org/reference/seal.md) [`delete_marked()`](https://energyRt.org/reference/seal.md) : Seal and unseal store entries; mark them for deletion - [`get_status()`](https://energyRt.org/reference/get_status.md) [`print(`*``*`)`](https://energyRt.org/reference/get_status.md) : Seal, mark, runs, storage and lineage of a saved object - [`clear_run()`](https://energyRt.org/reference/clear_run.md) : Release a run that is marked running - [`list_versions()`](https://energyRt.org/reference/list_versions.md) : Versions held in the model, repository and dataset stores - [`list_dependents()`](https://energyRt.org/reference/list_dependents.md) : What depends on a stored model, repository or dataset - [`model_hash()`](https://energyRt.org/reference/model_hash.md) [`object_hash()`](https://energyRt.org/reference/model_hash.md) : Content hash of a model - [`repository_hash()`](https://energyRt.org/reference/repository_hash.md) : Content hash of a repository - [`dataset_hash()`](https://energyRt.org/reference/dataset_store.md) [`save_dataset()`](https://energyRt.org/reference/dataset_store.md) [`load_dataset()`](https://energyRt.org/reference/dataset_store.md) : Content hash of a dataset payload - [`isInMemory()`](https://energyRt.org/reference/isInMemory.md) : Is object stored in memory? - [`isOnDisk()`](https://energyRt.org/reference/isOnDisk.md) : Is object stored on disk? - [`obj2mem()`](https://energyRt.org/reference/obj2mem.md) : Loads objects from disk to memory - [`materialize_weather()`](https://energyRt.org/reference/materialize_weather.md) : Materialize one weather transform ## Scenario runs and artifacts What a solved scenario leaves on disk, which solution to keep, and how to hand a folder to somebody else. - [`scenario_runs()`](https://energyRt.org/reference/scenario_runs.md) [`scenario_run_info()`](https://energyRt.org/reference/scenario_runs.md) [`drop_scenario_run()`](https://energyRt.org/reference/scenario_runs.md) : List, inspect, and drop a scenario's runs - [`scenario_solutions()`](https://energyRt.org/reference/scenario_solutions.md) : What solutions does this scenario have, and which is worth importing? - [`scenario_artifacts()`](https://energyRt.org/reference/scenario_artifacts.md) : Solver artifacts of a stored scenario - [`import_solution()`](https://energyRt.org/reference/import_solution.md) : Import a run's solution and make it stick - [`promote_solution()`](https://energyRt.org/reference/promote_solution.md) : Make a run's solution the scenario's own - [`drop_solver_outputs()`](https://energyRt.org/reference/drop_solver_outputs.md) : Delete the regenerable part of a solve - [`upgrade_scenario_layout()`](https://energyRt.org/reference/upgrade_scenario_layout.md) : Upgrade a scenario folder to the current on-disk layout - [`strip_user_info()`](https://energyRt.org/reference/strip_user_info.md) : Remove machine and user information from a stored scenario - [`prepare_for_sharing()`](https://energyRt.org/reference/prepare_for_sharing.md) : Prepare a stored scenario for sharing - [`getScenario()`](https://energyRt.org/reference/accessors.md) [`getModel()`](https://energyRt.org/reference/accessors.md) [`getRepository()`](https://energyRt.org/reference/accessors.md) [`getDataset()`](https://energyRt.org/reference/accessors.md) [`open_project()`](https://energyRt.org/reference/accessors.md) : Access registered scenarios, models, repositories, and datasets by name - [`getObject()`](https://energyRt.org/reference/getObject.md) : Retrieve model objects from a repository, model or scenario - [`newRegistry()`](https://energyRt.org/reference/registry.md) [`load_registry()`](https://energyRt.org/reference/registry.md) [`save_registry()`](https://energyRt.org/reference/registry.md) [`add_to_registry()`](https://energyRt.org/reference/registry.md) [`add(`*``*`)`](https://energyRt.org/reference/registry.md) [`summary(`*``*`)`](https://energyRt.org/reference/registry.md) [`find_in_registry()`](https://energyRt.org/reference/registry.md) [`refresh_registry()`](https://energyRt.org/reference/registry.md) : Project registry of models, scenarios, and runs - [`set_registry_file()`](https://energyRt.org/reference/registry_file.md) [`get_registry_file()`](https://energyRt.org/reference/registry_file.md) [`set_models_path()`](https://energyRt.org/reference/registry_file.md) [`get_models_path()`](https://energyRt.org/reference/registry_file.md) [`set_repositories_path()`](https://energyRt.org/reference/registry_file.md) [`get_repositories_path()`](https://energyRt.org/reference/registry_file.md) [`set_datasets_path()`](https://energyRt.org/reference/registry_file.md) [`get_datasets_path()`](https://energyRt.org/reference/registry_file.md) : Registry file and model store locations - [`dataset_hash()`](https://energyRt.org/reference/dataset_store.md) [`save_dataset()`](https://energyRt.org/reference/dataset_store.md) [`load_dataset()`](https://energyRt.org/reference/dataset_store.md) : Content hash of a dataset payload - [`seal_model()`](https://energyRt.org/reference/seal.md) [`unseal_model()`](https://energyRt.org/reference/seal.md) [`seal_repository()`](https://energyRt.org/reference/seal.md) [`unseal_repository()`](https://energyRt.org/reference/seal.md) [`seal_dataset()`](https://energyRt.org/reference/seal.md) [`unseal_dataset()`](https://energyRt.org/reference/seal.md) [`seal_scenario()`](https://energyRt.org/reference/seal.md) [`unseal_scenario()`](https://energyRt.org/reference/seal.md) [`mark_delete()`](https://energyRt.org/reference/seal.md) [`unmark_delete()`](https://energyRt.org/reference/seal.md) [`delete_marked()`](https://energyRt.org/reference/seal.md) : Seal and unseal store entries; mark them for deletion ## Validation and diagnostics Checks on a model’s inputs, on an interpolated scenario, and on a solved one. [`verify_solution()`](https://energyRt.org/reference/verify_solution.md) re-derives the model’s identities from the results. - [`check_feasibility()`](https://energyRt.org/reference/check_feasibility.md) : Check a model for contradictions that need no solver - [`validate_scenario_parameters()`](https://energyRt.org/reference/validate_scenario_parameters.md) : Validate interpolated scenario parameters - [`verify_solution()`](https://energyRt.org/reference/verify_solution.md) : Verify accounting identities of a solved scenario - [`verify_checks()`](https://energyRt.org/reference/verify_checks.md) : Checks available to [`verify_solution()`](https://energyRt.org/reference/verify_solution.md) - [`process_operability()`](https://energyRt.org/reference/process_operability.md) : Declared processes that cannot operate - [`audit_coefficients()`](https://energyRt.org/reference/audit_coefficients.md) : Coefficient-range audit of a written model - [`en_check_glpk()`](https://energyRt.org/reference/en_check.md) [`en_check_julia()`](https://energyRt.org/reference/en_check.md) [`en_check_python()`](https://energyRt.org/reference/en_check.md) [`en_check_pyomo()`](https://energyRt.org/reference/en_check.md) [`en_check_gams()`](https://energyRt.org/reference/en_check.md) [`en_check_gdx()`](https://energyRt.org/reference/en_check.md) [`en_check_julia_pkgs()`](https://energyRt.org/reference/en_check.md) [`en_check_solve()`](https://energyRt.org/reference/en_check.md) [`en_check_dependencies()`](https://energyRt.org/reference/en_check.md) : Detect external solver software and dependencies - [`en_check_packages()`](https://energyRt.org/reference/en_check_packages.md) : Check R package and external-tool dependencies - [`trim_parameters()`](https://energyRt.org/reference/trim_parameters.md) : Trim numeric/bounds parameters to the domain of the maps that index them - [`update_parameter()`](https://energyRt.org/reference/update_parameter.md) : Update parameter in the scenario by adding data to it ## Datasets Data bundled with the package for the examples and articles. - [`topia`](https://energyRt.org/reference/topia.md) : The TOPIA reference dataset - [`build_topia()`](https://energyRt.org/reference/build_topia.md) : TOPIA instances, cut from the shipped model - [`topia_profile()`](https://energyRt.org/reference/topia_profile.md) : Synthetic input shapes on a calendar (deterministic) - [`topia_profiles()`](https://energyRt.org/reference/topia_profiles.md) : TOPIA input profiles - [`topia_simulate()`](https://energyRt.org/reference/topia_simulate.md) : Synthetic TOPIA profiles - [`model_structure`](https://energyRt.org/reference/model_structure.md) : Catalogue of the model vocabulary - [`prefix`](https://energyRt.org/reference/prefix.md) [`prefix_longname`](https://energyRt.org/reference/prefix.md) : Unit prefix multipliers - [`solver_options`](https://energyRt.org/reference/solver_options.md) : Solver presets - [`currency_codes`](https://energyRt.org/reference/currency_codes.md) : Currency spellings, and the ISO code and scale each denotes - [`currency_fx`](https://energyRt.org/reference/currency_fx.md) : Annual exchange rates, local currency per US dollar - [`currency_deflator`](https://energyRt.org/reference/currency_deflator.md) : Annual price indices, for moving money between years - [`vre_cf`](https://energyRt.org/reference/vre_cf.md) : Hourly wind and solar capacity factors, one site, one year - [`vre_storage_duration`](https://energyRt.org/reference/vre_storage_duration.md) : Duration bands of a full-year battery, precomputed ## Setup and environment Installing and checking the solver toolchains. - [`en_setup()`](https://energyRt.org/reference/en_setup.md) : Set up energyRt after installation - [`en_install_deps()`](https://energyRt.org/reference/en_install_deps.md) : Install the energyRt dependency library layer - [`en_install_julia_pkgs()`](https://energyRt.org/reference/en_install_julia_pkgs.md) : Install Julia packages - [`en_install_python_deps()`](https://energyRt.org/reference/en_install_python_deps.md) : Install Python/Pyomo dependencies (deprecated) - [`en_config_path()`](https://energyRt.org/reference/en_config.md) [`en_config_read()`](https://energyRt.org/reference/en_config.md) [`en_config_write()`](https://energyRt.org/reference/en_config.md) : The energyRt configuration file - [`en_config_show()`](https://energyRt.org/reference/en_config_show.md) : Show the effective energyRt configuration ## Options and paths Package options, and where energyRt reads and writes. - [`energyRt-options`](https://energyRt.org/reference/energyRt-options.md) : energyRt Options - [`set_option()`](https://energyRt.org/reference/en_option.md) [`get_option()`](https://energyRt.org/reference/en_option.md) : Get or set an energyRt option - [`set_path_builder()`](https://energyRt.org/reference/path_builders.md) [`get_path_builder()`](https://energyRt.org/reference/path_builders.md) : Override how folder names are derived - [`set_scenarios_path()`](https://energyRt.org/reference/scenarios_path.md) [`get_scenarios_path()`](https://energyRt.org/reference/scenarios_path.md) : Set or get the directory with scenarios - [`set_registry_file()`](https://energyRt.org/reference/registry_file.md) [`get_registry_file()`](https://energyRt.org/reference/registry_file.md) [`set_models_path()`](https://energyRt.org/reference/registry_file.md) [`get_models_path()`](https://energyRt.org/reference/registry_file.md) [`set_repositories_path()`](https://energyRt.org/reference/registry_file.md) [`get_repositories_path()`](https://energyRt.org/reference/registry_file.md) [`set_datasets_path()`](https://energyRt.org/reference/registry_file.md) [`get_datasets_path()`](https://energyRt.org/reference/registry_file.md) : Registry file and model store locations - [`set_log_file()`](https://energyRt.org/reference/log.md) [`get_log_file()`](https://energyRt.org/reference/log.md) [`set_profile_dir()`](https://energyRt.org/reference/log.md) [`get_profile_dir()`](https://energyRt.org/reference/log.md) [`read_log()`](https://energyRt.org/reference/log.md) : Read the operation log - [`set_progress_bar()`](https://energyRt.org/reference/progress.md) [`show_progress_bar()`](https://energyRt.org/reference/progress.md) : Switch on/off and select/customize progress bar - [`get_default_value()`](https://energyRt.org/reference/get_default_value.md) : Return default value for one, several, or all parameters - [`isVerbose()`](https://energyRt.org/reference/isVerbose.md) [`isDebug()`](https://energyRt.org/reference/isVerbose.md) : Verbosity and debug level ## Utilities Small helpers, conversions and accessors. - [`get_process_aux()`](https://energyRt.org/reference/get_process_aux.md) : Get auxiliary commodities for each process - [`get_process_class()`](https://energyRt.org/reference/get_process_class.md) : Get class of processes - [`get_process_comm()`](https://energyRt.org/reference/get_process_comm.md) : Commodities associated with a processes - [`get_process_groups()`](https://energyRt.org/reference/get_process_groups.md) : Technologies that may be merged into one clustered object - [`get_process_inputs()`](https://energyRt.org/reference/get_process_inputs.md) : Get inputs of processes - [`get_process_invest_window()`](https://energyRt.org/reference/get_process_invest_window.md) : Start and end years for process by region - [`get_process_outputs()`](https://energyRt.org/reference/get_process_outputs.md) : Get output commodities for each process - [`get_process_region()`](https://energyRt.org/reference/get_process_region.md) : Get regions for each process - [`get_process_stored()`](https://energyRt.org/reference/get_process_stored.md) : Stored commodities of each process - [`get_process_timeframe()`](https://energyRt.org/reference/get_process_timeframe.md) : Get operational timeframe of processes - [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) [`getUnits(`*``*`)`](https://energyRt.org/reference/getUnits.md) : Get parameter units for energyRt class objects - [`commodity_properties()`](https://energyRt.org/reference/commodity_properties.md) : Recognised commodity properties - [`commodity_property()`](https://energyRt.org/reference/commodity_property.md) : Physical property of a commodity - [`convert_data`](https://energyRt.org/reference/convert_data.md) : The unit database [`convert()`](https://energyRt.org/reference/convert.md) reads - [`convert(`*``*`)`](https://energyRt.org/reference/convert.md) [`convert(`*``*`)`](https://energyRt.org/reference/convert.md) [`add_to_convert(`*``*`,`*``*`,`*``*`)`](https://energyRt.org/reference/convert.md) : Convert units - [`currency_base_year()`](https://energyRt.org/reference/currency_base_year.md) : The year untagged money is read at - [`add_currency_fx()`](https://energyRt.org/reference/add_currency.md) [`add_currency_deflator()`](https://energyRt.org/reference/add_currency.md) : Add an exchange rate or a price index - [`normalize_model_currency()`](https://energyRt.org/reference/normalize_model_currency.md) : Convert a model's costs to one currency - [`renameSets()`](https://energyRt.org/reference/renameSets.md) : Rename data.frame columns of list of data.frames. - [`revalueSets()`](https://energyRt.org/reference/revalueSets.md) : Replace specified values with new values in factor or character columns of a data.frame. - [`register_weather_transform()`](https://energyRt.org/reference/register_weather_transform.md) : Register a weather transform for the session - [`print()`](https://energyRt.org/reference/print.md) : Print methods for the energyRt classes - [`summary(`*``*`)`](https://energyRt.org/reference/summary.md) [`summary(`*``*`)`](https://energyRt.org/reference/summary.md) : Summarize a model or scenario # Articles ### All vignettes - [Validating and debugging a model](https://energyRt.org/articles/debugging.md): - [Get started with energyRt](https://energyRt.org/articles/energyRt.md): - [Installation and Settings](https://energyRt.org/articles/install.md): - [Model bricks: commodities, processes, and policies](https://energyRt.org/articles/model-bricks.md): - [Scaling models and alternative solve strategies](https://energyRt.org/articles/model-size.md): - [Results and reporting](https://energyRt.org/articles/reports.md): - [Model dimensions: time and space](https://energyRt.org/articles/resolution.md): - [Development Status and Roadmap](https://energyRt.org/articles/roadmap.md): - [Models, scenarios, and projects](https://energyRt.org/articles/scenario-management.md): - [Storage](https://energyRt.org/articles/storage.md): - [TOPIA I: building the model](https://energyRt.org/articles/topia-build.md): - [TOPIA II: running scenarios](https://energyRt.org/articles/topia-use.md): - [Units, conversions, and currencies](https://energyRt.org/articles/units.md): - [Vintages and clusters](https://energyRt.org/articles/variants.md): - [Solving models](https://energyRt.org/articles/workflow.md):