Skip to content

Commit

Permalink
build based on 91619f7
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 18, 2025
1 parent 04eba90 commit 5b0f44f
Show file tree
Hide file tree
Showing 59 changed files with 2,557 additions and 2 deletions.
2 changes: 1 addition & 1 deletion stable
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.11.0
v0.12.0
1 change: 1 addition & 0 deletions v0.12
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v0.12.0
1 change: 1 addition & 0 deletions v0.12.0/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-02-18T16:57:10","documenter_version":"1.8.1"}}
10 changes: 10 additions & 0 deletions v0.12.0/10-how-to-use/index.html
View file

Large diffs are not rendered by default.

59 changes: 59 additions & 0 deletions v0.12.0/20-tutorials/index.html
View file

Large diffs are not rendered by default.

141 changes: 141 additions & 0 deletions v0.12.0/30-concepts/index.html
View file

Large diffs are not rendered by default.

125 changes: 125 additions & 0 deletions v0.12.0/40-formulation/index.html
View file

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions v0.12.0/50-schemas/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Model Parameters · TulipaEnergyModel.jl</title><meta name="title" content="Model Parameters · TulipaEnergyModel.jl"/><meta property="og:title" content="Model Parameters · TulipaEnergyModel.jl"/><meta property="twitter:title" content="Model Parameters · TulipaEnergyModel.jl"/><meta name="description" content="Documentation for TulipaEnergyModel.jl."/><meta property="og:description" content="Documentation for TulipaEnergyModel.jl."/><meta property="twitter:description" content="Documentation for TulipaEnergyModel.jl."/><meta property="og:url" content="https://TulipaEnergy.github.io/TulipaEnergyModel.jl/50-schemas/"/><meta property="twitter:url" content="https://TulipaEnergy.github.io/TulipaEnergyModel.jl/50-schemas/"/><link rel="canonical" href="https://TulipaEnergy.github.io/TulipaEnergyModel.jl/50-schemas/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="TulipaEnergyModel.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">TulipaEnergyModel.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Welcome</a></li><li><a class="tocitem" href="../10-how-to-use/">How to Use</a></li><li><a class="tocitem" href="../20-tutorials/">Tutorials</a></li><li><a class="tocitem" href="../30-concepts/">Concepts</a></li><li><a class="tocitem" href="../40-formulation/">Mathematical Formulation</a></li><li class="is-active"><a class="tocitem" href>Model Parameters</a></li><li><a class="tocitem" href="../60-structures/">Model Structures</a></li><li><a class="tocitem" href="../90-contributing/">Contributing Guidelines</a></li><li><a class="tocitem" href="../91-developer/">Developer Documentation</a></li><li><a class="tocitem" href="../95-reference/">Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Model Parameters</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Model Parameters</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/TulipaEnergy/TulipaEnergyModel.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/TulipaEnergy/TulipaEnergyModel.jl/blob/main/docs/src/50-schemas.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="schemas"><a class="docs-heading-anchor" href="#schemas">Model Parameters</a><a id="schemas-1"></a><a class="docs-heading-anchor-permalink" href="#schemas" title="Permalink"></a></h1><p>The optimization model parameters with the input data must follow the schema below for each table. To create these tables we currently use CSV files that follow this same schema and then convert them into tables using TulipaIO, as shown in the basic example of the <a href="../20-tutorials/#basic-example">Tutorials</a> section.</p><p>The schemas can be accessed at any time after loading the package by typing <code>TulipaEnergyModel.schema_per_table_name</code> in the Julia console. Here is the complete list of model parameters in the schemas per table (or CSV file):</p><div class="admonition is-info"><header class="admonition-header">Optional tables/files and their defaults</header><div class="admonition-body"><p>The following tables/files are allowed to be missing: &quot;assets_rep_periods_partitions&quot;, &quot;assets_timeframe_partitions&quot;, &quot;assets_timeframe_profiles&quot;, &quot;flows_rep_periods_partitions&quot;, &quot;group_asset&quot;, &quot;profiles_timeframe&quot;.</p><ul><li>For the partitions tables/files, the default value are <code>specification = uniform</code> and <code>partition = 1</code> for each asset/flow and year</li><li>For the profiles tables/files, the default value is a flat profile of value 1.0 p.u.</li><li>If no group table/file is available there will be no group constraints in the model</li></ul></div></div><ul><li><strong><code>asset_both</code></strong><ul><li><code>asset: VARCHAR</code></li><li><code>milestone_year: INTEGER</code></li><li><code>commission_year: INTEGER</code></li><li><code>decommissionable: BOOLEAN</code></li><li><code>initial_units: DOUBLE</code></li><li><code>initial_storage_units: DOUBLE</code></li></ul></li><li><strong><code>asset_commission</code></strong><ul><li><code>asset: VARCHAR</code></li><li><code>commission_year: INTEGER</code></li><li><code>fixed_cost: DOUBLE</code></li><li><code>investment_cost: DOUBLE</code></li><li><code>investment_limit: DOUBLE</code></li><li><code>fixed_cost_storage_energy: DOUBLE</code></li><li><code>investment_cost_storage_energy: DOUBLE</code></li><li><code>investment_limit_storage_energy: DOUBLE</code></li></ul></li><li><strong><code>asset_milestone</code></strong><ul><li><code>asset: VARCHAR</code></li><li><code>milestone_year: INTEGER</code></li><li><code>investable: BOOLEAN</code></li><li><code>peak_demand: DOUBLE</code></li><li><code>storage_inflows: DOUBLE</code></li><li><code>initial_storage_level: DOUBLE</code></li><li><code>min_energy_timeframe_partition: DOUBLE</code></li><li><code>max_energy_timeframe_partition: DOUBLE</code></li><li><code>units_on_cost: DOUBLE</code></li></ul></li><li><strong><code>asset</code></strong><ul><li><code>asset: VARCHAR</code></li><li><code>type: VARCHAR</code></li><li><code>group: VARCHAR</code></li><li><code>capacity: DOUBLE</code></li><li><code>min_operating_point: DOUBLE</code></li><li><code>investment_method: VARCHAR</code></li><li><code>investment_integer: BOOLEAN</code></li><li><code>technical_lifetime: INTEGER</code></li><li><code>economic_lifetime: INTEGER</code></li><li><code>discount_rate: DOUBLE</code></li><li><code>consumer_balance_sense: VARCHAR</code></li><li><code>capacity_storage_energy: DOUBLE</code></li><li><code>is_seasonal: BOOLEAN</code></li><li><code>use_binary_storage_method: VARCHAR</code></li><li><code>unit_commitment: BOOLEAN</code></li><li><code>unit_commitment_method: VARCHAR</code></li><li><code>unit_commitment_integer: BOOLEAN</code></li><li><code>ramping: BOOLEAN</code></li><li><code>storage_method_energy: BOOLEAN</code></li><li><code>energy_to_power_ratio: DOUBLE</code></li><li><code>investment_integer_storage_energy: BOOLEAN</code></li><li><code>max_ramp_up: DOUBLE</code></li><li><code>max_ramp_down: DOUBLE</code></li></ul></li><li><strong><code>assets_profiles</code></strong><ul><li><code>asset: VARCHAR</code></li><li><code>commission_year: INTEGER</code></li><li><code>profile_type: VARCHAR</code></li><li><code>profile_name: VARCHAR</code></li></ul></li><li><strong><code>assets_rep_periods_partitions</code></strong><ul><li><code>asset: VARCHAR</code></li><li><code>year: INTEGER</code></li><li><code>rep_period: INTEGER</code></li><li><code>specification: VARCHAR</code></li><li><code>partition: VARCHAR</code></li></ul></li><li><strong><code>assets_timeframe_partitions</code></strong><ul><li><code>asset: VARCHAR</code></li><li><code>year: INTEGER</code></li><li><code>specification: VARCHAR</code></li><li><code>partition: VARCHAR</code></li></ul></li><li><strong><code>assets_timeframe_profiles</code></strong><ul><li><code>asset: VARCHAR</code></li><li><code>commission_year: INTEGER</code></li><li><code>profile_type: VARCHAR</code></li><li><code>profile_name: VARCHAR</code></li></ul></li><li><strong><code>flow_both</code></strong><ul><li><code>from_asset: VARCHAR</code></li><li><code>to_asset: VARCHAR</code></li><li><code>milestone_year: INTEGER</code></li><li><code>commission_year: INTEGER</code></li><li><code>decommissionable: BOOLEAN</code></li><li><code>initial_export_units: DOUBLE</code></li><li><code>initial_import_units: DOUBLE</code></li></ul></li><li><strong><code>flow_commission</code></strong><ul><li><code>from_asset: VARCHAR</code></li><li><code>to_asset: VARCHAR</code></li><li><code>commission_year: INTEGER</code></li><li><code>fixed_cost: DOUBLE</code></li><li><code>investment_cost: DOUBLE</code></li><li><code>efficiency: DOUBLE</code></li><li><code>investment_limit: DOUBLE</code></li></ul></li><li><strong><code>flow_milestone</code></strong><ul><li><code>from_asset: VARCHAR</code></li><li><code>to_asset: VARCHAR</code></li><li><code>milestone_year: INTEGER</code></li><li><code>investable: BOOLEAN</code></li><li><code>variable_cost: DOUBLE</code></li></ul></li><li><strong><code>flow</code></strong><ul><li><code>from_asset: VARCHAR</code></li><li><code>to_asset: VARCHAR</code></li><li><code>carrier: VARCHAR</code></li><li><code>is_transport: BOOLEAN</code></li><li><code>capacity: DOUBLE</code></li><li><code>technical_lifetime: INTEGER</code></li><li><code>economic_lifetime: INTEGER</code></li><li><code>discount_rate: DOUBLE</code></li><li><code>investment_integer: BOOLEAN</code></li></ul></li><li><strong><code>flows_profiles</code></strong><ul><li><code>from_asset: VARCHAR</code></li><li><code>to_asset: VARCHAR</code></li><li><code>year: INTEGER</code></li><li><code>profile_type: VARCHAR</code></li><li><code>profile_name: VARCHAR</code></li></ul></li><li><strong><code>flows_rep_periods_partitions</code></strong><ul><li><code>from_asset: VARCHAR</code></li><li><code>to_asset: VARCHAR</code></li><li><code>year: INTEGER</code></li><li><code>rep_period: INTEGER</code></li><li><code>specification: VARCHAR</code></li><li><code>partition: VARCHAR</code></li></ul></li><li><strong><code>group_asset</code></strong><ul><li><code>name: VARCHAR</code></li><li><code>milestone_year: INTEGER</code></li><li><code>invest_method: BOOLEAN</code></li><li><code>min_investment_limit: DOUBLE</code></li><li><code>max_investment_limit: DOUBLE</code></li></ul></li><li><strong><code>profiles_rep_periods</code></strong><ul><li><code>profile_name: VARCHAR</code></li><li><code>year: INTEGER</code></li><li><code>rep_period: INTEGER</code></li><li><code>timestep: INTEGER</code></li><li><code>value: DOUBLE</code></li></ul></li><li><strong><code>profiles_timeframe</code></strong><ul><li><code>profile_name: VARCHAR</code></li><li><code>year: INTEGER</code></li><li><code>period: INTEGER</code></li><li><code>value: DOUBLE</code></li></ul></li><li><strong><code>rep_periods_data</code></strong><ul><li><code>year: INTEGER</code></li><li><code>rep_period: INTEGER</code></li><li><code>num_timesteps: INTEGER</code></li><li><code>resolution: DOUBLE</code></li></ul></li><li><strong><code>rep_periods_mapping</code></strong><ul><li><code>year: INTEGER</code></li><li><code>period: INTEGER</code></li><li><code>rep_period: INTEGER</code></li><li><code>weight: DOUBLE</code></li></ul></li><li><strong><code>year_data</code></strong><ul><li><code>year: INTEGER</code></li><li><code>length: INTEGER</code></li><li><code>is_milestone: BOOLEAN</code></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../40-formulation/">« Mathematical Formulation</a><a class="docs-footer-nextpage" href="../60-structures/">Model Structures »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.1 on <span class="colophon-date" title="Tuesday 18 February 2025 16:57">Tuesday 18 February 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 5b0f44f

Please sign in to comment.