diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..e0ae4b8 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,25 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.8" +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py +# Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF +formats: + - pdf +# Optionally set the version of Python and requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt diff --git a/README.md b/README.md index dab22ae..7369153 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -Welcome to the open_plan gui repository +[![Documentation Status](https://readthedocs.org/projects/open-plan-documentation/badge/?version=latest)](https://open-plan-documentation.readthedocs.io/en/latest/?badge=latest) -Here will the code of the gui be available after we clear licensing and proof setting files before publishing. If you want to get notified when the code gets uploaded you can send an email to ... +Welcome to the open-plan-tool documentation repository, + +Here the code of the documentation will be available. If you want to get notified when the code gets uploaded you can send an email to open_plan@rl-institut.de. The open_plan team -Learn more about the open_plan project on our [website](https://open-plan-tool.org/) +![open_plan_logo (10X1)](https://user-images.githubusercontent.com/70587431/144256918-974fcefd-29f5-4b2f-b68b-6468327ef50b.png) + +Learn more about the open_plan project on our [website](https://open-plan-tool.org/). diff --git a/docs/MVS_kpi_categories.csv b/docs/MVS_kpi_categories.csv new file mode 100644 index 0000000..17ead1f --- /dev/null +++ b/docs/MVS_kpi_categories.csv @@ -0,0 +1,4 @@ +ref,category,description +technical_kpi,technical,"Technical KPI are calculated to assess the performance of a simulated energy system, ie. represent the technical system configuration and operation. They are calculated based on the asset capacities and asset dispatch. They should allow the comparision of different energy system topologies and different project sites with each other." +economic_kpi,economic,"Economic KPI are calculated to assess the costs of a simulated energy system. They include the costs per asset as well as the system's overall costs. Relative values like the levelized costs of supply allow a comparision to other investment options." +environmental_kpi,environmental,"Environmental KPI are calculated to assess the impact of a simulated energy system on the environment." \ No newline at end of file diff --git a/docs/MVS_kpis_list.csv b/docs/MVS_kpis_list.csv new file mode 100644 index 0000000..a72dc2e --- /dev/null +++ b/docs/MVS_kpis_list.csv @@ -0,0 +1,46 @@ +ref,label,:Unit:,:Valid Interval:,:Type:,category,see_also,:Definition: +annual_total_flow,Aggregated flow,kWh,>=0,Numeric,technical,"average_flow, peak_flow","Dispatch of the asset over a year, aggregated generation, demand or throughput." +annuity_om,"Annual operation, maintenance and dispatch expenses",currency/a,>=0,Numeric,economic,"annuity_total, costs_om_total","Annuity of the operation, maintenance and dispatch costs of the asset or energy system, i.e. ballpark number of the annual expenses for asset or system operation." +annuity_total,Annuity,currency/a,>=0,Numeric,economic,"annuity_om, costs_total",Annuity of the assets costs over the project lifetime or the energy system's :ref:`net present costs (NPC) ` . +attributed_costs,Costs attributed to a specific sector,currency,>=0,Numeric,economic,costs_total,"Costs attributed to supplying the demand of a specific sector, based on the :ref:`net present costs (NPC) ` of the energy system and the share of the sector demand compared to the overall system demand." +automatic_report,Simulation report,None,None,html or pdf,files,,"Automatically generated simulation report, including the most important input data as well as all output data. The `html` can be browsed interactively, while the `pdf` can be shared with partners." +average_flow,Average flow,kWh,>=0,Numeric,technical,"annual_total_flow, peak_flow",Average value of the assets dispatch. The ratio of average dispatch to peak dispatch indicates how much the asset is used in comparison to its actual installed capacity. +bar_chart_optimizedAddCap,Bar chart of optimal capacities,"kWh, kWp, kW, ...",None,Figure,files,optimizedAddCap,A bar chart to compare the optimized additional capacities for each asset to be installed in the energy system. Please be aware that the units of the capacities may different. +costs_cost_om,Operation and maintenance costs,currency,>=0,Numeric,economic,"costs_dispatch, costs_investment_over_lifetime, costs_om_total, costs_total, costs_upfront_in_year_zero","Costs for fix annual operation and maintenance costs over the whole project lifetime, which do not depend on the assets dispatch but solely on installed capacity. An example would be the maintenance costs for cleaning the installed PV capacity." +costs_dispatch,Dispatch costs,currency,>=0,Numeric,economic,"costs_cost_om, costs_investment_over_lifetime, costs_om_total, costs_total, costs_upfront_in_year_zero","Dispatch costs over the whole project lifetime including all expenditures that depend on the dispatch of assets (e.g. fuel costs, electricity consumption from the external grid, costs for operation and maintainance that depend on the throughput of an asset)" +costs_investment_over_lifetime,Investment costs,currency,>=0,Numeric,economic,"costs_cost_om, costs_dispatch, costs_om_total, costs_total, costs_upfront_in_year_zero, replacement_costs_during_project_lifetime","Investment costs over the whole project lifetime, including all replacement costs." +costs_om_total,"Operation, maintenance and dispatch costs",currency,>=0,Numeric,economic,"costs_cost_om, costs_dispatch, costs_investment_over_lifetime, costs_total, costs_upfront_in_year_zero","Costs for annual operation and maintenance costs as well as dispatch of all assets of the energy system, for the whole project duration." +costs_total,Net Present Costs (NPC),currency,>=0,Numeric,economic,"costs_cost_om, costs_dispatch, costs_investment_over_lifetime, costs_om_total, costs_upfront_in_year_zero","Net present costs of the system for the whole project duration, includes all operation, maintainance and dispatch costs as well as the investment costs (including replacements). Applied to a single asset, the costs can also be called present costs of the asset." +costs_upfront_in_year_zero,Upfront investment costs,currency,>=0,Numeric,economic,"costs_cost_om, costs_dispatch, costs_investment_over_lifetime, costs_om_total, costs_total","The costs which will have to be paid upfront when project begins, ie. In year 0. These are the investment and fix project costs into the chosen configuration." +degree_of_autonomy,Degree of Autonomy,Factor,"[0,1]",Numeric,technical,total_demand,"A degree of autonomy close to zero shows high dependence on the energy provider, while a degree of autonomy of 1 represents an autonomous or net-energy system and a degree of autonomy higher 1 a surplus-energy system." +degree_of_nze,Degree of Net Zero Energy,Factor,>=0,Numeric,technical,"total_feedin, total_consumption_from_energy_provider",The degree of net zero energy describes the ability of an energy system to provide its aggregated annual demand through local sources. +excel_scalar_kpi,Excel file with all KPI,None,None,Excel file,files,,"Excel sheet with all calculated KPI, both for the individual assets, the sectors and the overall energy system." +excel_timeseries,Excel file with dispatch timeseries,None,None,Excel file,files,"flow, plot_dispatch",Excel sheet with the dispatch of all assets of the energy system. Each tab represents one energy bus. +flow,Dispatch of an asset,"kW,kgH2,...",None,Time series (with time stamps and values),technical,"plot_dispatch, peak_flow, annual_total_flow, average_flow","Optimized dispatch of an asset in the optimized energy system, ie. its generation or thoughput." +json_input_processed,Simulation data after pre-processing (JSON),None,None,JSON,files,,"This file includes all data that is used to setup the energy system model, including all the pre-processing performed within :ref:`the module C0 `. It is mostly used by developers." +json_with_results,Simulation data and results (JSON),None,None,JSON,files,,"This file includes all simulation data and also results of the energy system optimization. With :code:`mvs_report` this file can be used to create a report without re-simulating the energy system. This file is also only used by developers, and also the file used to provide the EPA with the simulation results." +levelized_cost_of_energy_of_asset,Levelized cost of throughput,currency/kWh,>=0,Numeric,economic,"annuity_total, annual_total_flow","Cost per kWh throughput through an asset, based on the assets costs during the project lifetime as well as the total throughput through the asset in the project lifetime. For generation assets, equivalent to the levelized cost of generation." +levelized_costs_of_electricity_equivalent,Levelized costs of electricity equivalent,currency/kWheleq,>=0,Numeric,economic,"costs_total, total_demand","Levelized cost of energy of the sector-coupled energy system, calculated from the systems annuity and the total system demand in electricity equivalent." +logfile,MVS logfile,None,None,Logfile,files,,"Logfile of the MVS simulation including a number of log entries: Debug, information, warning and error messages. Helpful to debug the energy system simulation." +network_graph,Energy system model visualization,None,None,Figure,files,,"Plot of the energy system model in oemof-solph topology. This graph also includes the automatically generated components, ie. the sub-assets of energy providers and an energy excess sink on each energy bus. The model therefore appears different than in the Energy Planning Application (EPA)." +onsite_energy_fraction,Onsite energy fraction,Factor,"[0,1]",Numeric,technical,onsite_energy_matching,Onsite energy fraction is also referred to as self-consumption. It describes the fraction of all locally generated energy that is consumed by the system itself. +onsite_energy_matching,Onsite energy matching,Factor,"[0,1]",Numeric,technical,"onsite_energy_fraction, total_feedin",The onsite energy matching is also referred to as self-sufficiency. It describes the fraction of the total demand that can be covered by the locally generated energy. +optimizedAddCap,Optimal additional capacity,"kW, kWh, kWp, ...",>=0,Numeric,technical,peak_flow,Capacity added to installed capacity for optimal economic system performance. +peak_flow,Peak flow,kW,>=0,Numeric,technical,"average_flow, annual_total_flow",Peak of the dispatch of an asset. +pie_chart_costs,Pie charts of cost parameters,Percentages,None,Figure,files,"costs_total, costs_om_total, annuity_total",Displays the share of individual asset costs on different economical parameters of the overall system +plot_dispatch,Dispatch of all assets on a bus,"kW, kgH2, ...",None,Figure,files,flow,"Visualization of the dispatch of all assets of a specific energy bus, ie. all inflows and outflows of a specific bus. Generated for every single energy bus in the energy system. If relevant, a plot of the state of charge is also displayed." +plot_input_timeseries,Input timeseries,"kW, kgH2, ...",None,Figure,files,,"Vizualization of timeseries provided as input data, eg. PV generation timeseries." +renewable_factor,Renewable factor,Factor,"[0,1]",Numeric,technical,"renewable_share_of_local_generation, onsite_energy_fraction, onsite_energy_matching",Describes the share of the energy influx to the local energy system that is provided from renewable sources. This includes both local generation as well as consumption from energy providers. +renewable_share_of_local_generation,Renewable share of local generation,Factor,"[0,1]",Numeric,technical,renewable_factor,The renewable share of local generation describes how much of the energy generated locally is produced from renewable sources. It does not take into account the consumption from energy providers. +replacement_costs_during_project_lifetime,Replacement costs,currency,>=0,Numeric,economic,costs_investment_over_lifetime,Costs for replacement of assets which occur over the project lifetime. +specific_emissions_per_electricity_equivalent,Specific GHG per electricity equivalent,kg GHGeq/kWh,>=0,Numeric,environmental,total_emissions,Specific GHG emissions per supplied electricity equivalent. +total_consumption_from_energy_provider,Energy import,"kWh, kWheleq, ...",>=0,Numeric,technical,,Aggregated energy imports into the local energy system from the provider. +total_demand,Energy demand,"kWh, kWheleq, ...",>=0,Numeric,technical,,Demand of energy in local energy system over a the project lifetime. +total_emissions,Total GHG emissions,kg GHGeq,>=0,Numeric,environmental,"renewable_factor, specific_emissions_per_electricity_equivalent",Total greenhouse gas emissions in kg. +total_excess,Energy excess,"kWh, kWheleq, ...",>=0,Numeric,technical,,"Excess of energy, ie. unused energy in local energy system." +total_feedin,Energy export,"kWh, kWheleq, ...",>=0,Numeric,technical,onsite_energy_fraction,Feed-in of energy into external grid. +total_internal_generation,Total local generation,kWheleq,>=0,Numeric,technical,"total_internal_non-renewable_generation, total_internal_renewable_generation",Aggregated amount of energy generated within the energy system. +total_internal_non-renewable_generation,Total non-renewable local generation,kWheleq,>=0,Numeric,technical,"total_internal_generation, total_internal_renewable_generation",Aggregated amount of non-renewable energy generated within the energy system. +total_internal_renewable_generation,Total renewable local generation,kWheleq,>=0,Numeric,technical,"total_internal_generation, total_internal_non-renewable_generation",Aggregated amount of renewable energy generated within the energy system. +total_non-renewable_energy_use,Total non-renewable energy use,kWheleq,>=0,Numeric,technical,total_renewable_energy_use,Aggregated amount of non-renewable energy used within the energy system (ie. Including local generation and external supply). +total_renewable_energy_use,Total renewable energy use,kWheleq,>=0,Numeric,technical,total_non-renewable_energy_use,Aggregated amount of renewable energy used within the energy system (ie. Including local generation and external supply). diff --git a/docs/MVS_parameters_categories.csv b/docs/MVS_parameters_categories.csv new file mode 100644 index 0000000..fad575b --- /dev/null +++ b/docs/MVS_parameters_categories.csv @@ -0,0 +1,13 @@ +ref,csv_file_name,description +constraints,constraints,"The file `constraints.csv` includes the following parameter(s):" +economic_data,economic_data,"The file `economic_data.csv` includes all economic data that the simulation will use. This includes the following parameters:" +busses,energyBusses,"The file `energyBusses.csv` defines all busses required to build the energy system. It includes following parameters:" +consumption,energyConsumption,"The file `energyConsumption.csv` defines all energy demands that should be included in the energy system. It includes the following parameters:" +conversion,energyConversion,"The file `energyConversion.csv` defines the assets that convert one energy carrier into another one, eg. inverters or generators. Following parameters define them:" +production,energyProduction,"The file `energyProduction.csv` defines the assets that serve as energy sources, eg. fuel sources or PV plants. They include the following parameters:" +providers,energyProviders,"The file `energyProviders.csv` defines the energy providers of the energy system. They include the following parameters:" +storage,energyStorage,"The file `energyStorage.csv` defines the storage assets included in the energy system. It does not hold all needed parameters, but requires `storage_xx.csv` to be defined as well. The file `energyStorage.csv` includes the following parameters:" +fixcost,fixcost,"The parameters must be filled for all three columns/components namely: *distribution_grid*, *engineering* and *operation*.\nThe file `fixcost.csv` includes the following parameters:" +project_data,project_data,"The file `project_data.csv` includes the following parameters:" +simulation_settings,simulation_settings,"The file `simulation_settings.csv` includes the following parameters:" +storage_csv,storage_*,"The `*` in the storage filename is the number identifying the storage. It depends on the number of storage components (such as batteries, etc.) present in the system. For e.g., there should be two storage files named storage_01.csv and storage_02.csv if the system contains two storage components.The file `storage_xx.csv` contains the following parameters:" diff --git a/docs/MVS_parameters_list.csv b/docs/MVS_parameters_list.csv new file mode 100644 index 0000000..11d7d32 --- /dev/null +++ b/docs/MVS_parameters_list.csv @@ -0,0 +1,56 @@ +verbose,:Default:,:Definition_Short:,:Definition_Long:,:Example:,:Restrictions:,:Type:,:Unit:,sensitivity_analysis,label,ref,category,see_also,,,, +Age of the installed plant,0,Number of years the asset has already been in operation,"If the project lasts longer than its remaining lifetime, the replacement costs of the asset will be taken into account.",10,Natural number,numeric,a,1,age_installed,age_ins-label,conversion:production,,,,, +C-Rate,1,Maximum permissable power at which the storage can be charged or discharged relative to the nominal capacity of the storage,The C rate indicates the reciprocal of the time for which a battery of the specified capacity can be charged or discharged with the maximum charge or discharge current. A C-rate of 1 implies that the battery can be fully charged or discharged completely in a single timestep. A C-rate of 0.5 implies that the battery needs at least 2 timesteps to be fully charged or discharged.,1,Real number between 0 and 1,numeric,Factor,1,c-rate,crate-label,storage_csv,,,,, +None,None,Name of the country where the project is being deployed,,Norway,None,str,None,0,country,country-label,project_data,,,,, +None,None,The currency of the country where the project is implemented,,EUR,None,str,None,0,currency,currency-label,economic_data,,,,, +Fix project costs,0,Planning and development costs,This could be planning and development costs which do not depend on the (optimized) capacities of the assets.,10000,Positive real number,numeric,€,1,development_costs,developmentcosts-label,conversion,storage_csv,production,fixcost,, +Discount factor,0.05,The factor which accounts for the depreciation in the value of money in the future compared to the current value of the same money,The common method is to calculate the weighted average cost of capital (WACC) and use it as the discount rate.,0.06,Real number,numeric,Factor,0,discount_factor,discountfactor-label,economic_data,,,,, +Variable operational costs,0.01,Costs associated with a flow through/from the asset (OPEX_var or fuel costs),This could be fuel costs for fuel sources like biogas or oil or operational costs for thermal power plants which only occur when operating the plant.,0.01,None,numeric,€/kWh,1,dispatch_price,dispatchprice-label,conversion,storage_csv,production,fixcost,, +None,False,Stands for Demand Side Management. Currently not implemented.,,False,Acceptable values are either True or False.,boolean,None,0,dsm,dsm-label,hidden,,,,, +None,0.8,Ratio of energy output to energy input,The battery efficiency is the ratio of the energy taken out from the battery to the energy put into the battery.,0.95,Positive real number,numeric,Factor,1,efficiency,efficiency-label,conversion,storage_csv,,,, +Specific emissions,0.4,Emissions per unit dispatch of an asset,,14.4,Positive real number,numeric,kgCO2eq/asset unit,1,emission_factor,emissionfactor-label,providers,production,,,, +None,0.3,Price of the energy carrier sourced from the utility grid,Can be also a timeseries,0.3,None,numeric,€/kWh,1,energy_price,energyprice-label,providers,,,,, +Commodity,Electricity,Energy commodity,"Convention: For an energy conversion asset define the commodity of the output. For a sink define the commodity based on the input flow. For a source define the commodity based on the output flow. For a storage, define the commodity based on the stored energy carrier.",Electricity,"One of “Electricity”, “Gas”, “Bio-Gas”, “Diesel”, “Heat”, “H2”",str,None,0,energyVector,energyvector-label,busses,consumption,production,storage,providers,conversion +None,365,The number of days for which the simulation is to be run,,365,Natural number,numeric,None,1,evaluated_period,evaluatedperiod-label,simulation_settings,,,,, +Maximum feedin capacity,None,Maximum capacity for feeding electricity into the grid,,1000,Acceptable values are either a positive real number or None,numeric,:unit:,0,feedin_cap,feedincap-label,providers,,,,, +None,0.1,Price received for feeding electricity into the grid,Can be also a timeseries,0.1,None,numeric,€/kWh,1,feedin_tariff,feedintariff-label,providers,,,,, +None,None,Name of the csv file containing the input generation or demand timeseries,,demand_harbor.csv,This file must be placed in a folder named “time_series” inside your input folder.,str,None,0,file_name,filename-label,consumption,production,storage_csv,,, +Fixed absolute thermal losses,0,Thermal losses of the storage independent of the state of charge and independent of nominal storage capacity between two consecutive timesteps,,0.0003,Between 0 and 1,numeric,factor,1,fixed_thermal_losses_absolute,fixed_thermal_losses_absolute-label,storage_csv,,,,, +Fixed relative thermal losses,0,Thermal losses of storage independent of state of charge between two consecutive timesteps relative to nominal storage capacity,,0.0016,Between 0 and 1,numeric,factor,1,fixed_thermal_losses_relative,fixed_thermal_losses_relative-label,storage_csv,,,,, +None,None,Label of the bus/component from which the energyVector is arriving into the asset,,Electricity,None,str,None,0,inflow_direction,inflowdirection-label,consumption,conversion,providers,storage,, +Installed capacity,0,Already existing installed capacity,"If the project lasts longer than its remaining lifetime, the replacement costs of the asset will be taken into account.",50,None,numeric,:unit:,1,installedCap,installedcap-label,conversion,production,storage_csv,,, +None,None,Name of the asset,,pv_plant_01,"Input the names in a computer friendly format, preferably with underscores instead of spaces, and avoiding special characters",str,None,0,label,labl-label,fixcost,,,,, +Location's latitude,None,Latitude coordinate of the project's geographical location,,45.641603,Should follow geographical convention,numeric,None,0,latitude,latitude-label,project_data,,,,, +Asset lifetime,20,Number of operational years of the asset until it has to be replaced,,20,Natural number,numeric,a,1,lifetime,lifetime-label,conversion,storage_csv,production,fixcost,, +Location's longitude,None,Longitude coordinate of the project's geographical location,,10.95787,Should follow geographical convention,numeric,None,0,longitude,longitude-label,project_data,,,,, +None,None,Maximum amount of total emissions which are allowed in the optimized energy system,,100000,Acceptable values are either a positive real number or None.,numeric,kgCO2eq/a,1,maximum_emissions,maxemissions-label,constraints,,,,, +Maximum capacity,None,Maximum total capacity of an asset that can be installed at the project site,"This includes the already existing installed and additional capacity possible. An example would be that a roof can only carry 50 kW PV (maximum capacity), whereas the installed capacity is already 10 kW. The optimization would only be allowed to add 40 kW PV at maximum.",1000,Acceptable values are either a positive real number or None.,numeric,:unit:,1,maximumCap,maxcap-label,production;storage,,,,, +Degree of autonomy,0.6,Minimum degree of autonomy that needs to be met by the optimization,"This constraint defines a lower bound on the degree of autonomy of the energy system. Note that constraint is applied to the the whole, sector-coupled energy system, but not to specific sectors individually.",0.6,Real number between 0 and 1,numeric,factor,1,minimal_degree_of_autonomy,minda-label,constraints,,,,, +Renewable share,0.8,Minimum share of energy supplied by renewable generation that needs to be met by the optimization,"This constraint defines a lower bound on the renewable share of the system, which takes into account both local generation as well as the renewable share of energy providers. Note that constraint is applied to the renewable share of the whole, sector-coupled energy system, but not to specific sectors individually.",0.8,Real number between 0 and 1,numeric,factor,1,minimal_renewable_factor,minrenshare-label,constraints,,,,, +None,False,Specifies whether optimization needs to result into a net zero energy system (True) or not (False),,True,Acceptable values are either Yes or No.,boolean,None,0,net_zero_energy,nzeconstraint-label,constraints,,,,, +Optimize capacity,False,Choose if capacity optimization should be performed for this asset.,,True,Acceptable values are either Yes or No.,boolean,None,0,optimizeCap,optimizecap-label,conversion,storage,providers,production,, +None,None,Label of bus/component towards which the energyVector is leaving from the asset,,PV plant (mono),None,str,None,0,outflow_direction,outflowdirec-label,consumption,conversion,storage,providers,, +None,False,Enables the output of the linear programming (lp) file with the linear equation system describing the optimization problem,The lp file contains the objective function and all constraints. It enables the user to look at the underlying equations of the optimization.,False,Acceptable values are either True or False,boolean,None,0,output_lp_file,outputlpfile-label,simulation_settings,,,,, +Peak demand price,0,Grid fee to be paid based on the peak demand of a given period,,60,None,numeric,€/kW,1,peak_demand_pricing,peakdemand-label,providers,peakdemandperiod-label,,,, +Period of peak demand pricing,1,Number of reference periods in one year for the peak demand pricing,,2,"Only one of the following are acceptable values: 1 (yearly), 2, 3 ,4, 6, 12 (monthly)",numeric,times per year,1,peak_demand_pricing_period,peakdemandperiod-label,providers,peakdemand-label,,,, +None,20,The number of years the project is intended to be operational,The project duration also sets the installation time of the assets used in the simulation. After the project ends these assets are 'sold' and the refund is charged against the initial investment costs.,30,Natural number,numeric,a,0,project_duration,projectduration-label,economic_data,,,,, +None,None,Assign a project ID as per your preference.,,1,Cannot be the same as an already existing project ID,str,None,0,project_id,projectid-label,project_data,,,,, +None,None,Assign a project name as per your preference.,,Borg Havn,None,str,None,0,project_name,projectname-label,project_data,,,,, +Renewable share of the generation mix,0.44,Share of renewables in the generation mix of the energy supplied by the DSO utility,,0.5,Real number between 0 and 1,numeric,Factor,1,renewable_share,renshare-label,providers,,,,, +Renewable asset,True,Choose if this asset should be considered as renewable.,This parameter is necessary to consider the renewable share constraint correctly.,True,Acceptable values are either Yes or No.,boolean,None,0,renewableAsset,renewableasset-label,production,,,,, +None,None,Brief description of the scenario being simulated,,This scenario simulates a sector-coupled energy system,None,str,None,0,scenario_description,scenariodescription-label,project_data,,,,, +None,None,Assign a scenario ID as per your preference.,,1,Cannot be the same as an already existing scenario ID within the project,str,None,0,scenario_id,scenarioid-label,project_data,,,,, +None,None,Assign a scenario name as per your preference.,,Warehouse 14,None,str,None,0,scenario_name,scenarioname-label,project_data,,,,, +Initial state of charge,None,State of charge of the storage in the zeroth time step,The state of charge is specified as a factor of the nominal capacity.,,,numeric,None or factor,1,soc_initial,socin-label,storage_csv,,,,, +Maximum state of charge,1,The maximum permissible level of charge of the storage as a factor of the nominal capacity,When the battery is filled to its nominal capacity the state of charge is represented by the value 1.,,Real number between 0 and 1,numeric,Factor,1,soc_max,socmax-label,storage_csv,,,,, +Minimum state of charge,0,The minimum permissible level of charge of the storage as a factor of the nominal capacity,When the battery is fully discharged the state of charge is represented by the value 0.,,Real number between 0 and 1,numeric,Factor,1,soc_min,socmin-label,storage_csv,,,,, +Investment costs,1000,Specific investment costs of the asset related to the installed capacity (CAPEX),,1000,None,numeric,€/:unit:,1,specific_costs,specificcosts-label,conversion,storage_csv,production,fixcost,, +Fix operational costs,10,Specific operational and maintenance costs of the asset related to the installed capacity (OPEX_fix),,10,None,numeric,€/(:unit:\*a),1,specific_costs_om,specificomcosts-label,conversion,storage_csv,production,fixcost,, +None,None,Date and time when the simulation starts with the first step,This date will be used for the results graphs as well as the timeseries upload.,2018-01-01 00:00:00,Acceptable format is YYYY-MM-DD HH:MM:SS,str,None,0,start_date,startdate-label,simulation_settings,,,,, +None,None,Name of a csv file containing the properties of a storage component,,storage_01.csv,Follows the convention of 'storage_xx.csv' where 'xx' is a number. This file must be placed in a folder named “csv_elements” inside your input folder.,str,None,0,storage_filename,storagefilename-label,storage,,,,, +Tax factor,0,Tax factor,,0,Between 0 and 1,numeric,Factor,0,tax,tax-label,economic_data,,,,, +None,60,Length of the time steps,,60,Can only be 60 minutes at the moment,numeric,None,1,timestep,timestep-label,simulation_settings,,,,, +None,None,Type of the component,,demand,*demand*,str,None,0,type_asset,typeasset-label,hidden,,,,, +None,None,Input the type of OEMOF component,"A photovoltaic plant would be a source, a solar inverter would be a transformer, etc. The `type_oemof` will later on be determined through the EPA.",sink,*sink* or *source* or one of the other component classes of OEMOF.,str,None,0,type_oemof,typeoemof-label,conversion,storage,production,fixcost,consumption,providers +None,kW,Unit associated with the capacity of the component,,"Storage could have units like kW or kWh, transformer station could have kVA, and so on.",Appropriate scientific unit,str,NA,0,unit,unit-label,conversion,storage_csv,production,fixcost,consumption,providers +Power loss index,0,"Power loss index for CHPs, usually known as beta coefficient",0.6,Between 0 and 1,numeric,factor,beta,0,beta,Beta-label,conversion,,,,, diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/Overview_old.txt b/docs/Overview_old.txt new file mode 100644 index 0000000..bf2a714 --- /dev/null +++ b/docs/Overview_old.txt @@ -0,0 +1,45 @@ +================= +About the Project +================= + +H2020 Project E-Land +-------------------- + + + + +Flowchart +--------- + + +.. _validation-plan: + +MVS Validation Plan +------------------- + +The adopted validation plan is part of the MVS’ entire development process and is based on three main validation types: conceptual model validation, model verification and operational validity. Following some in-depth research, a validation approach is chosen for the MVS, through which the most appropriate validation techniques are applied to the MVS so that it gains the necessary credibility. + +The validation techniques used are listed here below and expanded in :ref:`validation-methodology`: + +* Face validity + +* Static testing + +* Graphical displays + +* Benchmark tests + +* Extreme input parameters + +* Sensitivity analysis + +* Comparison to other model + + +Access MVS Server API +--------------------- + +The Multi-Vector Simulator can be used to simulate energy systems via the browser using the `API on the RLI server `__. It processes the parsed JSON input file, and returns the JSON result file. +The simulation is executed by uploading the simulation files (by clicking the 'Browse' button) and then hitting the 'Run simulation' button. One can also visualize the log messages (error/warning) during the simulation. + +The code for the implementation of the MVS E-Land API is hosted in this `github repository `__. diff --git a/docs/_files/input_parameters_list.inc b/docs/_files/input_parameters_list.inc new file mode 100755 index 0000000..6c5872b --- /dev/null +++ b/docs/_files/input_parameters_list.inc @@ -0,0 +1,400 @@ +.. _demand_profile: + +Demand profile +^^^^^^^^^^^^^^ + +:Definition: The energy demand time serie with timestep (if different energy types are considered different profiles must be given) +:Unit: nan +:Default: nan +:Category: Technical +:Restrictions: nan + +---- + +.. _energy_timeseries: + +Energy timeseries +^^^^^^^^^^^^^^^^^ + +:Definition: Specific timeseries of energy sources from a primary-secondary transformation (e.g. PV, Wind) +:Unit: kWh +:Default: nan +:Category: Technical +:Restrictions: between 0 and 1 (normalized with maximum) + +---- + +.. _source_power_mix: + +Source power mix +^^^^^^^^^^^^^^^^ + +:Definition: Percentage of each source of power (inclusive % from Grid) +:Unit: Percentage +:Default: nan +:Category: Technical +:Restrictions: nan + +---- + +.. _lower_bound_renewable_energy_share_: + +Lower bound renewable energy share +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: A constraint that specifies the lower bound on the share of renewable energies in the optimized output energy mix +:Unit: Percentage +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _co2_upper_limit: + +CO2 upper limit +^^^^^^^^^^^^^^^ + +:Definition: A constraint that specifies an upper bound on the CO2 emissions +:Unit: T of CO2 +:Default: None +:Category: Environmental +:Restrictions: nan + +---- + +.. _energy_sources_capacities: + +Energy sources capacities +^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Energy sources with their capacity open for optimization +:Unit: kW +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _storage_units: + +Storage units +^^^^^^^^^^^^^ + +:Definition: Energy storage units with their capacity and technology +:Unit: kW +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _existing_energy_source_infrastructure: + +Existing energy source infrastructure +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Existing energy infrastructure not up for optimization (with given capacities) +:Unit: kW +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _existing_energy_storage_infrastructure: + +Existing energy storage infrastructure +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Existing storage infrastructure not up for optimization (with given capacities) +:Unit: kW +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _gps_coordinates: + +GPS coordinates +^^^^^^^^^^^^^^^ + +:Definition: GPS coordinate of the location, to retrieve the weather conditions in case of missing timeseries. Could be a point, a set of points, or a polygon +:Unit: nan +:Default: None +:Category: GIS +:Restrictions: nan + +---- + +.. _grid_parameters_(v2.0_of_the_tool): + +Grid parameters (v2.0 of the tool) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Grid parameters such as: power, voltage, frequence, line length, line impedance, transformers, topology +:Unit: nan +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _degree_of_autonomy_(da): + +Degree of Autonomy (DA) +^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Degree of Autonomy or self sufficiency wished (capability of the system to sustain a certain part of the load) +:Unit: factor +:Default: None +:Category: Constraint +:Restrictions: between 0 and 1 + +---- + +.. _ it's always a matter of data: + +Temporal resolution of simulation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Time step of the simulation. The user should be aware that a higher resolution require more data and can lead to longer simulation times (might be already in the provided timeseries) +:Unit: nan +:Default: nan +:Category: Time +:Restrictions: nan + +---- + +.. _optimization_goal: + +Optimization goal +^^^^^^^^^^^^^^^^^ + +:Definition: The quantities which govern the optimization (CO2, costs, renewable maximization in energy mix, degree of autonomy, multi-objectives) +:Unit: nan +:Default: None +:Category: Simulation +:Restrictions: nan + +---- + +.. _maximum_investment_budget: + +Maximum investment budget +^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Upper bound on the investment budget +:Unit: EUR +:Default: None +:Category: Financial +:Restrictions: nan + +---- + +.. _current_price_of_co2_emission_certificates: + +Current price of CO2 emission certificates +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Current price of CO2 emission certificates +:Unit: EUR +:Default: nan +:Category: Financial +:Restrictions: nan + +---- + +.. _future_price_estimates_for_co2_emission_certificates: + +Future price estimates for CO2 emission certificates +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Timeseries of future price for CO2 emission certificates (values from the EU-ETS and DE-ETS) +:Unit: EUR +:Default: nan +:Category: Financial +:Restrictions: nan + +---- + +.. _interest_rate: + +Interest rate +^^^^^^^^^^^^^ + +:Definition: A guess of what the interest rate will be in during the project lifetime. Could be provided as constant or timeseries. +:Unit: EUR +:Default: Value provided +:Category: Financial +:Restrictions: nan + +---- + +.. _costs_of_replacement: + +Costs of replacement +^^^^^^^^^^^^^^^^^^^^ + +:Definition: Costs of replacement/improvement of the current system components/assets +:Unit: EUR +:Default: Value provided for each accepted asset type +:Category: Financial +:Restrictions: nan + +---- + +.. _grid_stability_fee: + +Grid stability fee +^^^^^^^^^^^^^^^^^^ + +:Definition: Fee/payment for contribution to grid stability +:Unit: EUR +:Default: Value provided +:Category: Financial +:Restrictions: nan + +---- + +.. _ it's always a matter of data : + +Spatial resolution +^^^^^^^^^^^^^^^^^^ + +:Definition: Define the wished spatial resolution (it is wished that it can range from building up to districts) +:Unit: nan +:Default: nan +:Category: GIS +:Restrictions: nan + +---- + +.. _new_power_plant_available_space: + +New power plant available space +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Available space for new power plants (for PV installation for example) +:Unit: nan +:Default: nan +:Category: GIS +:Restrictions: nan + +---- + +.. _consumer_requirements: + +Consumer requirements +^^^^^^^^^^^^^^^^^^^^^ + +:Definition: consumer requirements such as a specific localisation and wished minimal load profile (e.g. in an industry park) +:Unit: nan +:Default: nan +:Category: GIS/Technical +:Restrictions: nan + +---- + +.. _existing_grid_structure_(v2.0_of_the_tool): + +Existing grid structure (v2.0 of the tool) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: GPS coordinates of current grid structure (lines and hubs) +:Unit: nan +:Default: nan +:Category: GIS/Technical +:Restrictions: nan + +---- + +.. _future_grid_structure_(v2.0_of_the_tool): + +Future grid structure (v2.0 of the tool) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: GPS coordinates of future grid structure (lines and hubs) +:Unit: nan +:Default: nan +:Category: GIS/Technical +:Restrictions: nan + +---- + +.. _security_of_supply: + +Security of supply +^^^^^^^^^^^^^^^^^^ + +:Definition: e.g. existence of back-up system +:Unit: nan +:Default: nan +:Category: Technical +:Restrictions: nan + +---- + +.. _balancing_ratio_for_anciliary_services: + +Balancing ratio for anciliary services +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Balancing ratio for ancilliary services (need a more precise definition as PF could not re-figure out what this means) +:Unit: nan +:Default: nan +:Category: Technical +:Restrictions: nan + +---- + +.. _number_of_future_extra_users: + +Number of future extra users +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Number of future extra user in energy cell +:Unit: nan +:Default: nan +:Category: Technical +:Restrictions: nan + +---- + +.. _load_types: + +Load types +^^^^^^^^^^ + +:Definition: Designation of flexible and non-flexible loads in the load profile +:Unit: nan +:Default: nan +:Category: Technical +:Restrictions: nan + +---- + +.. _costs_of_asset_use: + +Costs of asset use +^^^^^^^^^^^^^^^^^^ + +:Definition: The price of a liter of diesel or a kWh from the grid +:Unit: EUR +:Default: Value provided +:Category: Financial +:Restrictions: nan + +---- + +.. _project_lifetime: + +Project lifetime +^^^^^^^^^^^^^^^^ + +:Definition: The lifetime of the project (simulation time) +:Unit: Time +:Default: nan +:Category: Simulation +:Restrictions: nan \ No newline at end of file diff --git a/docs/_files/input_parameters_list_short.inc b/docs/_files/input_parameters_list_short.inc new file mode 100755 index 0000000..b7fdd0b --- /dev/null +++ b/docs/_files/input_parameters_list_short.inc @@ -0,0 +1,32 @@ +:Name:,:Unit:,:Default:,:Category:,:Restrictions:,:Definition: +Demand profile,,,Technical,,The energy demand time serie with timestep (if different energy types are considered different profiles must be given) +Energy timeseries,kWh,,Technical,between 0 and 1 (normalized with maximum),"Specific timeseries of energy sources from a primary-secondary transformation (e.g. PV, Wind)" +Source power mix,Percentage,,Technical,,Percentage of each source of power (inclusive % from Grid) +Lower bound renewable energy share ,Percentage,None,Technical,,A constraint that specifies the lower bound on the share of renewable energies in the optimized output energy mix +CO2 upper limit,T of CO2,None,Environmental,,A constraint that specifies an upper bound on the CO2 emissions +Energy sources capacities,kW,None,Technical,,Energy sources with their capacity open for optimization +Storage units,kW,None,Technical,,Energy storage units with their capacity and technology +Existing energy source infrastructure,kW,None,Technical,,Existing energy infrastructure not up for optimization (with given capacities) +Existing energy storage infrastructure,kW,None,Technical,,Existing storage infrastructure not up for optimization (with given capacities) +GPS coordinates,,None,GIS,,"GPS coordinate of the location, to retrieve the weather conditions in case of missing timeseries. Could be a point, a set of points, or a polygon" +Grid parameters (v2.0 of the tool),,None,Technical,,"Grid parameters such as: power, voltage, frequence, line length, line impedance, transformers, topology" +Degree of Autonomy (DA),factor,None,Constraint,between 0 and 1,Degree of Autonomy or self sufficiency wished (capability of the system to sustain a certain part of the load) +Temporal resolution of simulation,,,Time,,Time step of the simulation. The user should be aware that a higher resolution require more data and can lead to longer simulation times (might be already in the provided timeseries) +Optimization goal,,None,Simulation,,"The quantities which govern the optimization (CO2, costs, renewable maximization in energy mix, degree of autonomy, multi-objectives)" +Maximum investment budget,EUR,None,Financial,,Upper bound on the investment budget +Current price of CO2 emission certificates,EUR,,Financial,,Current price of CO2 emission certificates +Future price estimates for CO2 emission certificates,EUR,,Financial,,Timeseries of future price for CO2 emission certificates (values from the EU-ETS and DE-ETS) +Interest rate,EUR,Value provided,Financial,,A guess of what the interest rate will be in during the project lifetime. Could be provided as constant or timeseries. +Costs of replacement,EUR,Value provided for each accepted asset type,Financial,,Costs of replacement/improvement of the current system components/assets +Grid stability fee,EUR,Value provided,Financial,,Fee/payment for contribution to grid stability +Spatial resolution,,,GIS,,Define the wished spatial resolution (it is wished that it can range from building up to districts) +New power plant available space,,,GIS,,Available space for new power plants (for PV installation for example) +Consumer requirements,,,GIS/Technical,,consumer requirements such as a specific localisation and wished minimal load profile (e.g. in an industry park) +Existing grid structure (v2.0 of the tool),,,GIS/Technical,,GPS coordinates of current grid structure (lines and hubs) +Future grid structure (v2.0 of the tool),,,GIS/Technical,,GPS coordinates of future grid structure (lines and hubs) +Security of supply,,,Technical,, e.g. existence of back-up system +Balancing ratio for anciliary services,,,Technical,,Balancing ratio for ancilliary services (need a more precise definition as PF could not re-figure out what this means) +Number of future extra users,,,Technical,,Number of future extra user in energy cell +Load types,,,Technical,,Designation of flexible and non-flexible loads in the load profile +Costs of asset use,EUR,Value provided,Financial,,The price of a liter of diesel or a kWh from the grid +Project lifetime,Time,,Simulation,,The lifetime of the project (simulation time) diff --git a/docs/_files/output_parameters_list.inc b/docs/_files/output_parameters_list.inc new file mode 100755 index 0000000..30ea808 --- /dev/null +++ b/docs/_files/output_parameters_list.inc @@ -0,0 +1,283 @@ +.. _costs_for_co2_emission: + +Costs for CO2 emission +^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Calculated costs for CO2 emission certificates (current and future) from inputs +:Unit: EUR +:Default: None +:Category: Financial +:Restrictions: nan + +---- + +.. _lcoe: + +LCOE +^^^^ + +:Definition: Levelized costs of energy +:Unit: EUR +:Default: None +:Category: Financial +:Restrictions: 0 or above + +---- + +.. _emissions_co2eq: + +Emissions CO2eq +^^^^^^^^^^^^^^^ + +:Definition: Emissions of CO2eq (gCO2eq/kWh, TCO2eq emitted) +:Unit: T of CO2eq +:Default: None +:Category: Environmental +:Restrictions: 0 or above + +---- + +.. _relative_emissions_co2eq: + +Relative emissions CO2eq +^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Emissions of CO2eq relative to another scenario (% reduced emissions compared to another scenario. E.g: BAU) +:Unit: Percentage +:Default: None +:Category: Environmental +:Restrictions: 0 or above + +---- + +.. _investment_needed: + +Investment needed +^^^^^^^^^^^^^^^^^ + +:Definition: Total investment needed +:Unit: EUR +:Default: None +:Category: Financial +:Restrictions: 0 or above + +---- + +.. _degree_of_sector-coupling: + +Degree of sector-coupling +^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: A synergy index of the energy system expressed via the DOA defined in a publication of RLI +:Unit: factor +:Default: None +:Category: KPI +:Restrictions: between 0 and 1 + +---- + +.. _degree_of_autonomy_(da): + +Degree of Autonomy (DA) +^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Degree of Autonomy or self sufficiency obtained, typically a number between 0 and 1 +:Unit: factor +:Default: None +:Category: KPI +:Restrictions: between 0 and 1 + +---- + +.. _transformation_pathway: + +Transformation pathway +^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Enable the user to carry out this analysis on how to get from current situation to future situation from the other outputs. The pathway itself shall not be output by the simulation as it depends on policies and human political decisions as well +:Unit: None +:Default: nan +:Category: Report +:Restrictions: nan + +---- + +.. _scenarios_comparisons: + +Scenarios comparisons +^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Comparison of different energy systems and energy mixs (like RLI stemp-mv tool). Could compare energy savings, costs savings, CO2 savings +:Unit: None +:Default: nan +:Category: Report +:Restrictions: nan + +---- + +.. _energy_mix: + +Energy mix +^^^^^^^^^^ + +:Definition: Percentage of each asset for each energy type. +:Unit: Percentage +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _renewable_energy_share: + +Renewable energy share +^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: The share of renewable energy produced in the output energy mix +:Unit: Percentage +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _wasted_energy: + +Wasted energy +^^^^^^^^^^^^^ + +:Definition: Energy which could not be stored, or was lost in Joule effect (heating), i.e. losses in heat boilers +:Unit: kW +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _installed__capacity: + +Installed capacity +^^^^^^^^^^^^^^^^^^^ + +:Definition: The minimal capacity that needs to be installed in order to meet peak demand +:Unit: kW +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _installed_power: + +Installed power +^^^^^^^^^^^^^^^ + +:Definition: The aggregated power that needs to be produced in order to meet demand +:Unit: kWh +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _calculate_network_requirements_or_expansion_possibilities: + +Calculate network requirements or expansion possibilities +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Calculate network requirements or expansion possibilities +:Unit: None +:Default: nan +:Category: Report +:Restrictions: nan + +---- + +.. _grid_equipment_requirements: + +Grid equipment requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Number of new transformers (v2.0 of the tool) +:Unit: nan +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _grid_cable_requirements: + +Grid cable requirements +^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: length and size of new cables required (v2.0 of the tool) +:Unit: km +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _available_generation_technologies: + +Available generation technologies +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: List of existing technologies which could fulfill the capacity without exceeding the costs +:Unit: None +:Default: nan +:Category: Report +:Restrictions: nan + +---- + +.. _required_storage: + +Required storage +^^^^^^^^^^^^^^^^ + +:Definition: Required size to sustain peak demands for each storage technology (only if storage is part of input) +:Unit: kW +:Default: None +:Category: Technical +:Restrictions: nan + +---- + +.. _connection_points: + +Connection points +^^^^^^^^^^^^^^^^^ + +:Definition: Transfer interfaces with existing supply structures (gas/electricity/water/wastewater) +:Unit: None +:Default: nan +:Category: Report +:Restrictions: nan + +---- + +.. _amortisation_period_of_system_improvements: + +Amortisation period of system improvements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: How many months/years should one wait to get back the money invested in the components/assets +:Unit: Time +:Default: None +:Category: Financial +:Restrictions: 0 or above + +---- + +.. _list_of_support_programmes: + +List of support programmes +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: List of support programmes (government, NGO, World Bank) which criteria are fulfilled by the output energy system +:Unit: None +:Default: nan +:Category: Report +:Restrictions: nan \ No newline at end of file diff --git a/docs/_files/output_parameters_list_short.inc b/docs/_files/output_parameters_list_short.inc new file mode 100755 index 0000000..8cd5daa --- /dev/null +++ b/docs/_files/output_parameters_list_short.inc @@ -0,0 +1,23 @@ +:Name:,:Unit:,:Default:,:Category:,:Restrictions:,:Definition: +Costs for CO2 emission,EUR,None,Financial,,Calculated costs for CO2 emission certificates (current and future) from inputs +LCOE,EUR,None,Financial,0 or above,Levelized costs of energy +Emissions CO2eq,T of CO2eq,None,Environmental,0 or above,"Emissions of CO2eq (gCO2eq/kWh, TCO2eq emitted)" +Relative emissions CO2eq,Percentage,None,Environmental,0 or above,Emissions of CO2eq relative to another scenario (% reduced emissions compared to another scenario. E.g: BAU) +Investment needed,EUR,None,Financial,0 or above,Total investment needed +Degree of sector-coupling,factor,None,KPI,between 0 and 1,A synergy index of the energy system expressed via the DOA defined in a publication of RLI +Degree of Autonomy (DA),factor,None,KPI,between 0 and 1,"Degree of Autonomy or self sufficiency obtained, typically a number between 0 and 1" +Transformation pathway,None,,Report,,Enable the user to carry out this analysis on how to get from current situation to future situation from the other outputs. The pathway itself shall not be output by the simulation as it depends on policies and human political decisions as well +Scenarios comparisons,None,,Report,,"Comparison of different energy systems and energy mixs (like RLI stemp-mv tool). Could compare energy savings, costs savings, CO2 savings" +Energy mix,Percentage,None,Technical,,Percentage of each asset for each energy type. +Renewable energy share,Percentage,None,Technical,,The share of renewable energy produced in the output energy mix +Wasted energy,kW,None,Technical,,"Energy which could not be stored, or was lost in Joule effect (heating), i.e. losses in heat boilers" +Installed capacity,kW,None,Technical,,The minimal capacity that needs to be installed in order to meet peak demand +Installed power,kWh,None,Technical,,The aggregated power that needs to be produced in order to meet demand +Calculate network requirements or expansion possibilities,None,,Report,,Calculate network requirements or expansion possibilities +Grid equipment requirements,,None,Technical,,Number of new transformers (v2.0 of the tool) +Grid cable requirements,km,None,Technical,,length and size of new cables required (v2.0 of the tool) +Available generation technologies,None,,Report,,List of existing technologies which could fulfill the capacity without exceeding the costs +Required storage,kW,None,Technical,,Required size to sustain peak demands for each storage technology (only if storage is part of input) +Connection points,None,,Report,,Transfer interfaces with existing supply structures (gas/electricity/water/wastewater) +Amortisation period of system improvements,Time,None,Financial,0 or above,How many months/years should one wait to get back the money invested in the components/assets +List of support programmes,None,,Report,,"List of support programmes (government, NGO, World Bank) which criteria are fulfilled by the output energy system" diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/_static/docstring-setting.png b/docs/_static/docstring-setting.png new file mode 100644 index 0000000..d79648e Binary files /dev/null and b/docs/_static/docstring-setting.png differ diff --git a/docs/_static/table-style.css b/docs/_static/table-style.css new file mode 100644 index 0000000..f6206d3 --- /dev/null +++ b/docs/_static/table-style.css @@ -0,0 +1,3 @@ +table.limitations-table>tbody>tr>td, table.limitations-table>tbody>tr>th { + white-space: normal; +} \ No newline at end of file diff --git a/docs/_templates/.gitkeep b/docs/_templates/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..8dc6a93 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,396 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +import pandas as pd +import sphinx_rtd_theme + +sys.path.insert(0, os.path.abspath("..")) + + +def generate_parameter_description(input_csv_file, output_rst_file): + """Read the MVS parameter description and generate a .rst formatted document + + Parameters + ---------- + input_csv_file: str + path of the file with extensive description of all mvs parameters + output_rst_file: str + path of the rst file with RTD formatted mvs parameters + + Returns + ------- + None + + """ + df = pd.read_csv(input_csv_file) + df = df.loc[df.category != "hidden"] + parameter_properties = [ + ":Definition_Short:", + ":Definition_Long:", + ":Type:", + ":Unit:", + ":Example:", + ":Restrictions:", + ":Default:", + ] + # Replace empty definition by empty strings + df.loc[:,[":Definition_Short:", ":Definition_Long:"]] = df.loc[:,[":Definition_Short:", ":Definition_Long:"]].fillna(value="") + + lines = [] + # formats following the template: + # .._: + # + # + # ^^^^^^ + # + # :Definition: + # :Type: + # :Unit: + # :Example: + # :Restrictions: + # :Default: + # + # This parameter is used within the following categories: [List of categories] + # + # ---- + # + for row in df.iterrows(): + props = row[1] + + if isinstance(props.see_also, str): + see_also = [ + "", + "", + "See also: " + + ", ".join([f":ref:`{ref}`" for ref in props.see_also.split(";")]), + ] + else: + see_also = [] + lines = ( + lines + + [f".. _{props.ref}:", "", props.label, "^" * len(props.label), "",] + + [f"{p} {props[p]}" for p in parameter_properties if props[p] != ""] + + [""] + # + [ + # "This parameter is used within the following categories: " + # + ", ".join([f":ref:`{cat}`" for cat in props.category.split(";")]) + # ] + # + see_also + + ["", "",] + ) + + with open(output_rst_file, "w") as ofs: + ofs.write("\n".join(lines)) + + +def generate_parameter_categories( + input_param_csv_file, input_cat_csv_file, output_rst_file +): + """Rassemble the MVS parameter categories from csv file and generate a .rst formatted document + + Parameters + ---------- + input_param_csv_file: str + path of the file with extensive description of all mvs parameters + input_cat_csv_file: str + path of the file with extensive description of all mvs parameters categories + output_rst_file: str + path of the rst file with RTD formatted mvs parameter categories + + Returns + ------- + None + + """ + df_param = pd.read_csv(input_param_csv_file) + df_cat = pd.read_csv(input_cat_csv_file) + + lines = [] + # formats following the template: + # .._: + # + # + # ^^^^^^ + # + # * :ref:`param1` + # * :ref:`param2` + # + # ---- + # + + for row in df_cat.iterrows(): + props = row[1] + + cat_label = props.csv_file_name + ".csv" + + # lookup all parameters for which the category is tagged + df_param["in_category"] = df_param.category.apply( + lambda x: True if props.ref in x.split(";") else False + ) + + parameter_per_cat = df_param.loc[df_param.in_category == True, "ref"].to_list() + + lines = ( + lines + + [f".. _{props.ref}:", "", cat_label, "^" * len(cat_label), "",] + + props.description.split("\\n") + + ["",] + + [f"* :ref:`{p}`" for p in parameter_per_cat] + + ["", "",] + ) + + with open(output_rst_file, "w") as ofs: + ofs.write("\n".join(lines)) + + +def generate_kpi_categories(input_param_csv_file, input_cat_csv_file, output_rst_file): + """Reassemble the MVS parameter categories from csv file and generate a .rst formatted document + + Parameters + ---------- + input_param_csv_file: str + path of the file with extensive description of all mvs parameters + input_cat_csv_file: str + path of the file with extensive description of all mvs parameters categories + output_rst_file: str + path of the rst file with RTD formatted mvs parameter categories + + Returns + ------- + None + + """ + df_param = pd.read_csv(input_param_csv_file) + df_cat = pd.read_csv(input_cat_csv_file) + + lines = [] + # formats following the template: + # + # + # + # * :ref:`param1` + # * :ref:`param2` + # + + for row in df_cat.iterrows(): + props = row[1] + + cat_label = props.category + df_param["in_category"] = df_param.category == props.category + + parameter_per_cat = df_param.loc[df_param.in_category == True, "ref"].to_list() + parameter_names = df_param.loc[df_param.in_category == True, "label"].to_list() + + parameters = {} + for i in range(0, len(parameter_per_cat)): + parameters.update({parameter_per_cat[i]: parameter_names[i]}) + + lines = ( + lines + + [f"{props.description} These are the calculated {props.category} KPI:",] + + ["",] + + [f"* :ref:`{parameters[p]} <{p}>`" for p in parameter_per_cat] + + ["", "",] + ) + + with open(output_rst_file, "w") as ofs: + ofs.write("\n".join(lines)) + + +def generate_parameter_table(input_csv_file, output_csv_file): + df = pd.read_csv(input_csv_file) + df = df.loc[df.category != "hidden"] + + parameter_properties = [ + ":Type:", + ":Unit:", + ":Default:", + ] + + name_mapping = {c: c.replace(":", "") for c in parameter_properties} + name_mapping["label"] = "Parameter" + + # replace the label by a RTD reference + df["label"] = df["ref"].apply(lambda x: f":ref:`{x}`") + + df[["label"] + parameter_properties].rename(columns=name_mapping).to_csv( + output_csv_file, index=False + ) + + +# def copy_readme(): + # with open("../README.rst", "r", encoding="utf8") as fp: + # data = fp.readlines() + # with open("readme.inc", "w") as fp: + # fp.writelines(data[data.index("Setup\n") :]) + + +def generate_kpi_description(input_csv_file, output_path): + """Generate a .rst formatted document for each kpi in a given csv file + + Parameters + ---------- + input_csv_file: str + path of the file with extensive description of all mvs kpis + output_path: str + path of where the .inc files should be saved for each parameter + + Returns + ------- + None + + """ + df = pd.read_csv(input_csv_file) + df = df.loc[df.category != "hidden"] + parameter_properties = [ + ":Definition:", + ":Type:", + ":Unit:", + ":Valid Interval:", + ] + + # formats following the template: + # .._: + # + # + # ^^^^^^ + # + # :Definition: + # :Type: + # :Unit: + # :Valid Interval: + # :Connected indicators: List of indicators that are connected to the described indicator, to ease referencing + # + + df = df.replace("None", "NA") + for row in df.iterrows(): + props = row[1] + # Create a string with references to all the indicators connected to the current indicator + if isinstance(props.see_also, str): + see_also = " | ".join( + [f":ref:`{ref.replace(' ', '')}`" for ref in props.see_also.split(",")] + ) + else: + see_also = "None" + + # Define the title of the *.inc files + if props.category == "files": + # For files, only show the readable label + title = props.label + else: + # For other KPI show both the readable label (name) as well as the constant variable name as defined in `constants_json_strings.py` + title = props.label + " (" + props.ref + ")" + + # Write lines based on definitions to an *.inc file + lines = ( + [f".. _{props.ref}:", "", title, "^" * len(title), "",] + + [f"{p} {props[p]}" for p in parameter_properties] + + [f":Related indicators: {see_also}"] + + ["", "",] + ) + + with open(os.path.join(output_path, props.ref + ".inc"), "w") as ofs: + ofs.write("\n".join(lines)) + + +# Input parameters +generate_parameter_description( + "MVS_parameters_list.csv", "model/parameters/MVS_parameters_list.inc" +) +generate_parameter_table( + "MVS_parameters_list.csv", "model/parameters/MVS_parameters_list.tbl" +) +generate_parameter_categories( + "MVS_parameters_list.csv", + "MVS_parameters_categories.csv", + "model/parameters/MVS_parameters_categories.inc", +) + +# Output parameters +generate_kpi_description("MVS_kpis_list.csv", "model/outputs") + +generate_kpi_categories( + "MVS_kpis_list.csv", + "MVS_kpi_categories.csv", + "model/outputs/MVS_kpi_categories.inc", +) +# copy_readme() + +# -- Project information ----------------------------------------------------- + +project = "open_plan" +copyright = "2023, Reiner Lemoine Institut and Open Plan team" +author = "Reiner Lemoine Institut and Open Plan team" + +# from multi_vector_simulator.version import version_num + +# release = version_num + +# -- General configuration --------------------------------------------------- + +master_doc = "index" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.imgmath", + "sphinx.ext.autosummary", + "sphinx.ext.mathjax", + "sphinx.ext.viewcode", + "sphinx.ext.extlinks", + # "sphinxcontrib.rsvgconverter", + "numpydoc", +] + +mathjax_path="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML" + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + +# generate autosummary even if no references +autosummary_generate = True +autosummary_imported_members = True + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +import sphinx_rtd_theme + +numpydoc_show_class_members = False + +html_theme = "sphinx_rtd_theme" + +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# These paths are either relative to html_static_path +# or fully qualified paths (eg. https://...) +html_css_files = [ + 'table-style.css', +] diff --git a/docs/examples/Electricity_supply_to_community.rst b/docs/examples/Electricity_supply_to_community.rst new file mode 100644 index 0000000..50aacf0 --- /dev/null +++ b/docs/examples/Electricity_supply_to_community.rst @@ -0,0 +1,8 @@ +Electricity supply to community +=============================== + +A community of 3,000 residents wants to determine how they can increase the self-sufficiency of their electricity supply. PV and wind as renewable sources are considered, and battery storage. +Lifetime: 20 years + +.. image:: ../images/Use_Cases/IMG_E_supply_community.png + :width: 100% diff --git a/docs/examples/Heat_supply_to_community.rst b/docs/examples/Heat_supply_to_community.rst new file mode 100644 index 0000000..5c4d49d --- /dev/null +++ b/docs/examples/Heat_supply_to_community.rst @@ -0,0 +1,8 @@ +Heat supply to community +======================== + +A community of 3,000 residents wants to determine how they can increase the self-sufficiency and renewable share of their heat supply. +Lifetime: 20 years + +.. image:: ../images/Use_Cases/IMG_H_supply_community.png + :width: 100% diff --git a/docs/examples/Hydrogen_production_for_a_technology_park.rst b/docs/examples/Hydrogen_production_for_a_technology_park.rst new file mode 100644 index 0000000..5f415de --- /dev/null +++ b/docs/examples/Hydrogen_production_for_a_technology_park.rst @@ -0,0 +1,8 @@ +Hydrogen production for a technology park +========================================= + +A technology park considers locally producing hydrogen from excess PV generation, either for using as a means of electricity storage or for external sales. +Lifetime: 20 years + +.. image:: ../images/Use_Cases/IMG_hydrogen_technology_park.png + :width: 100% diff --git a/docs/examples/Industrial_site_Max_Boegl.rst b/docs/examples/Industrial_site_Max_Boegl.rst new file mode 100644 index 0000000..9ae6123 --- /dev/null +++ b/docs/examples/Industrial_site_Max_Boegl.rst @@ -0,0 +1,8 @@ +Industrial site Max Bögl +======================== + +An industrial site with an annual electricity consumption of 26 GWh and a peak load of 6.3 MW is aiming to increase its self-sufficiency rate and reduce its grid connection power by expanding PV, wind power and a battery. This is shown in four different scenarios. +Lifetime: 20 years + +.. image:: ../images/Use_Cases/IMG_MaxBoegl.png + :width: 100% diff --git a/docs/examples/Sector_coupling_for_apartment_building.rst b/docs/examples/Sector_coupling_for_apartment_building.rst new file mode 100644 index 0000000..ef09fcc --- /dev/null +++ b/docs/examples/Sector_coupling_for_apartment_building.rst @@ -0,0 +1,8 @@ +Sector coupling for apartment building +====================================== + +Optimization of an apartment building (approx. 20 apartments) near Konstanz with the following data: 70,000 kWh/year electricity consumption BDEW H0 profile 286,000 kWh/year heat consumption (heating + hot water) modeled by outdoor temperature according to BDEW. Weather data from German weather service for Constance 2018. Cost data for components largely from Danish technology catalog. +Lifetime: 20 years + +.. image:: ../images/Use_Cases/IMG_sector_coupling_apartment.png + :width: 100% diff --git a/docs/examples/Sector_coupling_for_office_building.rst b/docs/examples/Sector_coupling_for_office_building.rst new file mode 100644 index 0000000..a53d4d7 --- /dev/null +++ b/docs/examples/Sector_coupling_for_office_building.rst @@ -0,0 +1,8 @@ +Sector coupling for office building +=================================== + +An office building aims to improve the sustainability, overall efficiency and flexibility of its energy system by introducing renewables and considering sector coupling for electricity and heat. +Lifetime: 20 years + +.. image:: ../images/Use_Cases/IMG_sector_coupling_office.png + :width: 100% diff --git a/docs/examples/Sector_coupling_for_single_household.rst b/docs/examples/Sector_coupling_for_single_household.rst new file mode 100644 index 0000000..b751b59 --- /dev/null +++ b/docs/examples/Sector_coupling_for_single_household.rst @@ -0,0 +1,9 @@ +Sector coupling for single household +==================================== + +Optimization of the home supply near Constance for a single family house with the following data: 3500kWh/year electricity consumption BDEW h0 profile 28600kWh/year heat consumption (heating + hot water) modeled by outdoor temperature according to BDEW. Weather data from German weather service for Konstanz 2018. Cost data for components largely from Danish technology catalog. Assumed roof pitch of 30° with south orientation for solar collector and PV modules. +Lifetime: 20 years + +.. image:: ../images/Use_Cases/IMG_sector_coupling_household.png + :width: 100% + diff --git a/docs/examples/simple_energy_system.rst b/docs/examples/simple_energy_system.rst new file mode 100644 index 0000000..8a0387d --- /dev/null +++ b/docs/examples/simple_energy_system.rst @@ -0,0 +1,6 @@ +==================== +Simple energy system +==================== + +work in progress.... + diff --git a/docs/examples/simple_energy_system_2.rst b/docs/examples/simple_energy_system_2.rst new file mode 100644 index 0000000..c3b052b --- /dev/null +++ b/docs/examples/simple_energy_system_2.rst @@ -0,0 +1,7 @@ +====================== +Simple energy system 2 +====================== + +work in progress.... + + diff --git a/docs/files_to_be_displayed/example_docstring.py b/docs/files_to_be_displayed/example_docstring.py new file mode 100644 index 0000000..d33e281 --- /dev/null +++ b/docs/files_to_be_displayed/example_docstring.py @@ -0,0 +1,61 @@ +import pandas as pd + + +def example_function(arg1, argN): + r""" + One line no more that 80 character explaining very shortly what the function does + + More detailed explanation about the function, + can have several lines + + Parameters + ---------- + arg1 : str or list(str) + description of arg1 + Default: . + + ... + + argN : str or list(str) + description of argN + Default: . + + Returns + ------- + :class:`pandas.DataFrame` + here comes the description + (In case of no return, you can write what the function changes, e.g. updates + `variable_x` with `y`.) + + Notes + ----- + You can cite the references below using [1]_ or [2]_ add maths equations like this: + + .. math:: P=\frac{1}{8}\cdot\rho_{hub}\cdot d_{rotor}^{2} + \cdot\pi\cdot v_{wind}^{3}\cdot cp\left(v_{wind}\right) + + with: + P: power [W], :math:`\rho`: density [kg/m³], d: diameter [m], + v: wind speed [m/s], cp: power coefficient + + You can also indicate here which tests are covering this function: + This function is tested with: + - tests.test_example_function() + + References + ---------- + .. [1] paper 1 + .. [2] paper 2 + + Examples + -------- + # Here you can write some basic python code that is tested with pytest + >>> import src.C2_economic_functions as e_funcs + >>> CAPEX = e_funcs.capex_from_investment( + ... investment_t0=220000, lifetime=20, project_life=20, + ... discount_factor=0.1, tax=0.15) + >>> round(CAPEX, 7) + 253000.0 + + """ + return pd.DataFrame(...) diff --git a/docs/files_to_be_displayed/example_multiple_inputs_energyConversion.csv b/docs/files_to_be_displayed/example_multiple_inputs_energyConversion.csv new file mode 100644 index 0000000..f8d2692 --- /dev/null +++ b/docs/files_to_be_displayed/example_multiple_inputs_energyConversion.csv @@ -0,0 +1,16 @@ +,unit,electrolyser +age_installed,year,3 +development_costs,currency,0 +specific_costs,currency/kW,1500 +efficiency,factor,"[0.01923,0.28845]" +inflow_direction,str,"[MicroGrid,Water]" +installedCap,kW,0 +label,str,Electrolyser +lifetime,year,20 +specific_costs_om,currency/kW/year,75 +dispatch_price,currency/kWh,"[0,0.0038]" +optimizeCap,bool,True +outflow_direction,str,Local H2 grid +energyVector,str,Electricity +type_oemof,str,transformer +unit,str,kW diff --git a/docs/files_to_be_displayed/example_scalar_as_timeseries_energyConversion.csv b/docs/files_to_be_displayed/example_scalar_as_timeseries_energyConversion.csv new file mode 100644 index 0000000..8b8156d --- /dev/null +++ b/docs/files_to_be_displayed/example_scalar_as_timeseries_energyConversion.csv @@ -0,0 +1,16 @@ +,unit,heat_pump +age_installed,year,0 +development_costs,currency,0 +specific_costs,currency/kW,7000 +efficiency,factor,"{'file_name': 'cops_eers_test.csv', 'header': 'no_unit', 'unit': 'NA'}" +inflow_direction,str,Electricity +installedCap,kW,0 +label,str,Heat pump +lifetime,year,20 +specific_costs_om,currency/kW/year,0 +dispatch_price,currency/kWh,0 +optimizeCap,bool,True +outflow_direction,str,Heat +energyVector,str,Electricity +type_oemof,str,transformer +unit,str,kW diff --git a/docs/getting_started/basic_structure.rst b/docs/getting_started/basic_structure.rst new file mode 100644 index 0000000..a7682e1 --- /dev/null +++ b/docs/getting_started/basic_structure.rst @@ -0,0 +1,16 @@ +=============== +Basic structure +=============== + +This repository contains the code for the user interface. The +simulations are performed by +`multi-vector-simulator `__ +on a dedicated server (see the +`open-plan-tool/simulation-server `__ +repository). Once a simulation is over the results are sent back to the +user interface were one can analyse them. + +.. figure:: https://github.com/open-plan-tool/gui/assets/4399407/89e1ff2a-1dd0-40e6-91a3-465c77426867 + :alt: open-plan structure + + open-plan structure \ No newline at end of file diff --git a/docs/getting_started/installation.rst b/docs/getting_started/installation.rst new file mode 100644 index 0000000..fcf9de0 --- /dev/null +++ b/docs/getting_started/installation.rst @@ -0,0 +1,160 @@ +============ +Installation +============ + +open-plan-tool runs already live at open-plan-tool https://open-plan.rl-institut.de and the simulation server at https://mvs-open-plan.rl-institut.de/ +However it is possible to install both of them locally on your machine or on your own server + + +Prior to the deploy you should find yourself at the root of the open-plan-tool GUI repository + +.. code-block:: bash + + git clone https://github.com/open-plan-tool/gui.git open-plan-tool-GUI + cd open-plan-tool-GUI + + +Deploy GUI locally using and using our open plan MVS server +----------------------------------------------------------- + +Prior to be able to develop locally, you might need to install postgres, +simply google ``install postgres`` followed by your os name +(``linux/mac/windows``) + +1. Create a virtual environment +2. Activate your virtual environment +3. Install the dependencies with + ``pip install -r app/requirements/postgres.txt`` +4. Install extra local development dependencies with + ``pip install -r app/dev_requirements.txt`` +5. Move to the ``app`` folder with ``cd app`` +6. Create environment variables (only replace content surrounded by + ``<>``) + +:: + + SQL_ENGINE=django.db.backends.postgresql + SQL_DATABASE= + SQL_USER= + SQL_PASSWORD= + SQL_HOST=localhost + SQL_PORT=5432 + DEBUG=(True|False) + +8. Add an environment variable ``MVS_HOST_API`` and set the url of the + simulation server you wish to use for your models (https://mvs-open-plan.rl-institut.de/ if you wish to use our simulation server). You can deploy your own `simulation server `_ locally if you need +9. Execute the ``local_setup.sh`` file (``. local_setup.sh`` on + linux/mac ``bash local_setup.sh`` on windows) you might have to make + it executable first. Answer yes to the question +10. Start the local server with ``python manage.py runserver`` +11. You can then login with ``testUser`` and ``ASas12,.`` or create your + own account + +Deploy using Docker Compose +--------------------------- + +The following commands should get everything up and running, using the +web based version of the MVS API. + +You need to be able to run docker-compose inside your terminal. If you +can’t you should install `Docker +desktop `__ first. + +- Clone the repository locally + ``git clone --single-branch --branch main https://github.com/open-plan-tool/gui.git open_plan_gui`` +- Move inside the created folder (``cd open_plan_gui``) +- Edit the ``.envs/epa.postgres`` and ``.envs/db.postgres`` environment + files + + - Change the value assigned to ``EPA_SECRET_KEY`` with a `randomly + generated one `__ + + - Make sure to replace dummy names with you preferred names + + - The value assigned to the variables ``POSTGRES_DB``, + ``POSTGRES_USER``, ``POSTGRES_PASSWORD`` in ``.envs/db.postgres`` + should match the ones of the variables ``SQL_DATABASE``, + ``SQL_USER``, ``SQL_PASSWORD`` in ``.envs/epa.postgres``, + respectively + + - Define an environment variable ``MVS_HOST_API`` in + ``.envs/epa.postgres`` and set the url of the simulation server + you wish to use for your models (for example + ``MVS_API_HOST=""``), you + can deploy your own `simulation + server `__ + locally if you need + + - Assign the domain of your website (without ``http://`` or + ``https://``) to ``TRUSTED_HOST`` , see + https://docs.djangoproject.com/en/4.2/ref/settings/#csrf-trusted-origins + for more information + +Next you can either provide the following commands inside a terminal +(with ubuntu you might have to prepend ``sudo``) + +:: + + docker-compose --file=docker-compose-postgres.yml up -d --build + +(you can replace ``postgres`` by ``mysql`` if you want to use mysql) + +:: + + docker-compose --file=docker-compose-postgres.yml exec -u root app_pg sh initial_setup.sh + +(this will also load a default testUser account with sample scenario). + +Or you can run a python script with the following command + +:: + + python deploy.py -db postgres + +Finally, open a browser and navigate to http://localhost:8080 (or to http://localhost:8090 if you chose to use ``mysql`` instead of ``postgres``): you should see the login page of the open-plan-tool app. You can then login with ``testUser`` and ``ASas12,.`` or create your own account. + +Proxy settings (optional) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you use a proxy you will need to set ``USE_PROXY=True`` and edit +``PROXY_ADDRESS=http://proxy_address:port`` with your proxy settings in +``.envs/epa.postgres``. + +.. note:: If you wish to use mysql instead of postgres, simply + replace ``postgres`` by ``mysql`` and ``app_pg`` by ``app`` in the + above commands or filenames + + +.. note:: Grab a cup of coffee or tea for this… + + + +Test Account +------------ + + You can access a preconfigured project using the following login + credentials: ``testUser:ASas12,.`` + + .. raw:: html + +
+ +Tear down (uninstall) docker containers +--------------------------------------- + +To remove the application (including relevant images, volumes etc.), one +can use the following commands in terminal: + +:: + + docker-compose down --file=docker-compose-postgres.yml -v + +you can add ``--rmi local`` if you wish to also remove the images (this +will take you a long time to rebuild the docker containers from scratch +if you want to redeploy the app later then) + +Or you can run a python script with the following command + +:: + + python deploy.py -db postgres --down \ No newline at end of file diff --git a/docs/getting_started/mathematics_simply_explained.rst b/docs/getting_started/mathematics_simply_explained.rst new file mode 100644 index 0000000..2f5ab11 --- /dev/null +++ b/docs/getting_started/mathematics_simply_explained.rst @@ -0,0 +1,173 @@ +====================================================== +The mathematics behind open-plan-tool simply explained +====================================================== + +Aim of the open-plan-tool +------------------------- + +The aim of the open-plan-tool is to provide an open source application that has the +capability to model small to medium-sized energy systems with emphasis on renewable +energy technologies and optimize them cost-efficiently. +The easy to use graphical user interface and also the in-depth insight into the +optimization program and its visible open source code encourages end-users and also +researchers to use it. +.. [Write some more about the aim of open-plan-tool.....] + +One important aspect of future scenarios is the determination of optimal dimensioning +and combinations of various technologies. To compute an optimal individual energy system +open-plan-tool uses linear optimization. +When we think about how we want to set up our energy system, we have several +goals. For example, we want to minimize the cost of the energy system or the +amount of CO2 that we emit. Furthermore, we want to make sure that demand +can be met at any point in time, as well as a variety of other goals. +To help us find a way to satisfy all these goals, we can use linear +optimization. What was briefly outlined in the last section is basically a +non-mathematical way of describing the main and secondary conditions that we +need to use linear optimization. In the following example, this will be further illustrated. + +[Das folgende ist ein einfaches Beispiel, was die Methodik der linearen Optimierung anhand +eines zweidimensionalen Lösungsraums erklären soll.] +The following example describes the principle of linear optimization in a two-dimensional space. + +An energy system with various technologies +------------------------------------------ + +When it comes to electricity generation, we can imagine a simple energy system using solar energy and fossil fuels. +To use solar energy we need PV modules, and to use the fossil fuel, we need a fossil +fuel power station. For both technologies we are trying to find out how much +capacity we should build to get the cost minimum solution. +We also have a battery and we have the consumer for which we know the exact demand. + +.. + Additionally, the optimization leads to the answer of the question if installing a battery would be an option to + further reduce costs. Further our energy system contains the electricity demand. +.. +[Picture Energysystem] + +Using this data, we can now think about our optimal solution. In this case our +objective is to minimize costs. The objective function is described as a linear +function that we want to minimize. +[spez. Kosten + repective installed capacities] + +We can now represent this graphically as a solution space, which shows us all the possible input combinations. +On the x-axis we have the fossil fuel generator capacity, and on the y-axis we have the +capacity of a PV plant. Any point within the solution space is a possible +solution, and using linear optimization, we will find the optimum. + +.. image:: ../images/slide_1.png + :width: 1000 + +If we just want to minimize the costs, we would have to say that the optimum is +(0,0), as this costs us the least. Therefore, we need to add more information, +or more secondary conditions. +An optimization is linear as long as the main and secondary conditions only +contain linear functions. In the following section, we will look at a few +secondary conditons. + +In our example, we assume that a small fossil fuel generator has already been +installed, and consequently, the solution space is reduced, as shown in the +picture. + +.. image:: ../images/slide_2.png + :width: 1000 + +Another secondary condition is that the amount of solar capacity that we can +build is restricted by the area that we can actually build solar cells on, +which is represented by the purple line. + +.. image:: ../images/slide_3.png + :width: 1000 + +We also know that we do not want to install more capacity than necessary, +meaning that the generation capacity of the fossil fuel generator should not +exceed the peak demand, which is shown by the black straight line. + +We also have to be able to meet the peak demand. We need to make sure that we +have enough capacity installed to meet this demand, which is depicted by the +diagonal line, which shows us all the combinations of solar and fossil fuel +capacity that let us meet peak demand. However, all the solutions above the +diagonal line are also theoretically possible. + +.. image:: ../images/slide_4.png + :width: 1000 + +We also have some PV plants installed and consequently our solution space is +reduced again. + +.. image:: ../images/slide_5.png + :width: 1000 + +Finally, we also want to make sure that our energy system is sustainable, and +therefore, we define a maximum amount of CO2 that we want to emit, which is +represented by the green line. After having reduced the solution space again, +we now turn to solving the optimization problem. + +.. image:: ../images/slide_6.png + :width: 1000 + +After we have defined our solution space, the next step is to find the optimum. +Several ways of solving these problems have been developed, one of which is the +simplex method. This can be done on paper, but as the number of equations +rises, this becomes more and more difficult. + +In open-plan-tool this is done by a solver, which can solve the optimization, given +that the equations are in a certain form. The solver then proceeds in two +steps. In the first step, it checks if there is a solution to the problem, and +as soon as a solution is found, the solver proceeds to the second step. In the +second step, the solver then tries to find a better solution and continues +this process iteratively until it has found the best solution. To do this, +the solver moves along the edges of the solutions space, as the optimum will +always lie on the edge of the solution space in a linear optimization model +as long as there is an optimum. +In our simple example, this means that the solution has to lie somewhere on +the edge of our solutions space. In this case the solution is the yellow +point. + +.. image:: ../images/slide_7.png + :width: 1000 + +It is also possible that several solutions exist. Graphically, this would mean +that an entire edge of the constraint to the solution space would be an +optimum, meaning that we have several solutions that give us the same optimal +result. In this case we can pick any point of the input combinations that lead +us to the optimal solution. +If we increase the complexity, by either adding more secondary conditions, or +by expanding the main condition, the solution space becomes more complex, and +can go from 3 Dimensional to 50 Dimensional or even more. When the solution +space becomes more complex, it becomes basically impossible to graphically +demonstrate how the solution space is solved, but the principle is exactly the +same in a two dimensional problem or a 50 dimensional problem, it just takes +longer for the solver to do its work. + +.. + - Presentation of the benefits of individual technologies + +.. + Solving energy management problems with the help of linear optimization + +.. + General information on modeling + +.. + Reduction of the considered system to subcomponents with a certain level of detail + +.. + real system + Simplifications are necessary + Results can be complex + Energy systems based on renewable energies can become very complex. + The components with which an energy supply system can be modeled in open-plan-tool are classified as follows: + - Sources + - Sinks + - Transformer + - Storage + .. image:: images/energy_system_model.png + :width: 200 + Sub header 1 + ############ + text + Sub header 2 + ############ + text + Header 2 + -------- diff --git a/docs/getting_started/quick_start_guide.rst b/docs/getting_started/quick_start_guide.rst new file mode 100644 index 0000000..a79317c --- /dev/null +++ b/docs/getting_started/quick_start_guide.rst @@ -0,0 +1,219 @@ +=========== +Quick start +=========== + +First steps +----------- + +Create an account +^^^^^^^^^^^^^^^^^ +The first step to start using open-plan-tool is to create an account. To do this, you must click on the "Sign up" button at the top right corner and fill in the following information: your name, email address, username and password. Finally, do not forget to read and accept the privacy statement. You should receive an email with a link to confirm the account creation. You can find our privacy policy `here `_. + + +.. image:: ../images/IMG1_Sign_up.png + :width: 100% + +Explore the dashboard +^^^^^^^^^^^^^^^^^^^^^ + +When you log in, the following dashboard is displayed. In the following image the points described below are labeled with numbers and letters. + +.. image:: ../images/IMG2_Main_Screen.png + :width: 100% + +**1. Logo. Clicking here will take you back to the home screen and your projects. Here you find all the projects you have created, and you can create new projects.** + +**2. Top navigation menu. Located on the upper right part of the screen, here you will find the shortcuts to:** + + a) Documentation. Key information so that you can get to know the tool and develop your projects. + b) Use cases. Here you will find some use cases where the functionalities of the system and its application in different projects and scenarios are presented. + c) We are happy to hear about your experience with open_plan, so feel free to share your questions, comments and suggestions here. + d) Change the language. English (en) and German (de) are supported. + e) Profile drop-down options. + +**3. Dashboard. Here is the link to create a new project or the list of current projects when they already exist.** + +**4. Bottom navigation menu. Located at the bottom right of the screen. Here you will find:** + g) Contact. General information about the project, a section where you can leave your feedback and find the link to GitHub, where you can follow the development or find useful information related to how to host the tool by yourself. + j) License. You can find the license information here. + k) Imprint. Important information about the tool and some disclaimers are in this section. + l) Privacy. Information on data protection, data processing and the legal and policy issues around them. + + + +Create a project +^^^^^^^^^^^^^^^^ + +To create a project in open-plan-tool, the user has three options: + +.. image:: ../images/New_project_EN.png + :width: 30% + +:Empty project: + +Here a project is created from scratch. When you select this option you must configure your project and for that you must include the following information: + +- Name + +- Description + +- Country + +- Location (coordinates) + +- Duration (years) + +- Currency + +- Discount factor + + +:From file: + +It is also possible to load a project from a file. In this case you must include the name of the project and upload the file in json format. This option makes it possible to share projects among each other. + +:From use case: + +If you want to start from one of the configured use cases, you can do so in this option. You will see a pop-up window with a link to the use cases, and a drop-down list where you can choose the use case to use. Once selected, it will appear in the "My projects" section. + + +Create a scenario +^^^^^^^^^^^^^^^^^ + +Once the project is created, it is possible to create various scenarios within the project. To do this, you have two options: you can create a new scenario by defining all its parameters or you can load a previously created scenario from a json file. So here there is also the option to share scenarios among each other. + +.. image:: ../images/IMG_4_New_scenario.png + :width: 50% + +When creating a scenario from scratch, there are four steps to go through: + +1) Scenario setup +2) Energy system design +3) Constraints +4) Simulation. + +At the top you will see the name of the project (in bold type), the name of the scenario, the four steps for scenario creation, and an identifier which step you are in. + + +.. image:: ../images/IMG_Scenario_Steps.png + :width: 100% + +Below is a brief description of what should be done at each step. + + +**1) Scenario setup** + + +The setup consists of assigning a name to the scenario, its corresponding description, the evaluated period (number of days) the simulation will run, the length of the time steps of the simulation in minutes, the start date (keep in mind that this date is important for getting the data from the time series and for plotting the data) and the fixed project costs which include the planning and development costs of the project. + + +**2) Energy system design** + +In this section the energy system will be designed using different components, which are located on the left panel and classified in different categories: **Providers, Production, Conversion, Storage, Demand and Bus.** +In the graphic panel drag the components you need to design your energy system and do not forget to include the buses. Note that assets are connected to each other using a bus which is the identifier for the energy carrier (e.g. electricity or heat). Interconnecting two buses or two assets directly is not allowed. Connect the components together using the green and red terminals. The green terminals represent inputs, while the red terminals represent outputs, see the following example: + +.. image:: ../images/IMG_example_connections.png + :width: 100% + + +The components representing **battery energy storage systems (BESS)** have been defined with one input and one output. The BESS can be connected directly to the electrical bus; please note that the bus is supplied and feeds the battery at the same time. + +.. image:: ../images/IMG_example_storage.png + :width: 100% + + +When you click on the components, a screen appears where you can configure the different parameters. The input parameters are different for each component category, however, you will typically find three ways to complete the information: spaces to enter values, drop-down lists with default information or buttons to load time series (in this case, a graph will be displayed where the loaded data series can be previewed). The input field for the components that belong to one category (e.g. the conversion components) contains usually the same parameters, but there are also components that may differ slightly, such as the heat pump. Below we show you as an example some of the component setup screens. + + +.. image:: ../images/IMG_setup_Bus.png + :width: 100% + + +.. image:: ../images/IMG_setup_PV.png + :width: 100% + + +.. image:: ../images/IMG_setup_HeatDemand.png + :width: 100% + + +Before proceeding to the next section, be sure to complete the information requirements for each component and save the energy system. + + +**3) Constraints** + +In the third section system-wide constraints can be set. At the moment two constraints, the degree of autonomy and the share of renewables, are implemented: + + + - **Degree of autonomy:** This constraint is a lower boundary for the degree of autonomy of the energy system. The factor can take values between 0 and 1, with the value close to zero showing a degree of autonomy with high dependence on the energy supplier, while a degree of autonomy of 1 represents a fully autonomous energy system. + + + - **Share of renewables:** This constraint is a lower boundary for the renewable share of the energy system, where both local generation as well as the renewable share of the generation mix supplied by the energy providers are taken into account. + +Within each constraint you can decide whether to activate it or not, and in case of activation set a value that must be met by the system. + + +**4) Simulation** + +Once the scenario parameters are set, you proceed to the simulation panel. At the bottom you will find the button to run the simulation. + +Once the simulation is done you get the results of your scenario by clicking on the button **Check results dashboard.** + +Further you can select the option whether you want to include an LP file. With the LP file you can look the mathematical formulation consisting of objective function and constraints. It is recommended to choose a small number of days to evaluate (e.g. one day) to keep the LP file readable. After running the simulation you can download the LP file and open it in a text editor. + +.. image:: ../images/IMG_simulation_panel.png + :width: 100% + + +Simulation results +^^^^^^^^^^^^^^^^^^ + +In the **results dashboard** you can have a detailed look at the results of your scenarios. When pressing the button you are automatically in the currently simulated scenario, but you can select another project [1] or scenario [2]. Only scenarios that have already been simulated are displayed. + +In the upper right part you have the possibility to download all timeseries of the scenario including given timeseries and simulation results, the resulting Key Performance Indicators (KPIs), and the component costs as Excel files [3]. Further you can return to the scenario setup [4]. + +To view the most relevant results directly, you have the three options: **single scenarios, compare scenarios and sensitivity analysis [5].** Please note that the option of sensitivity analysis is not fully implemented yet. At the moment you get an error as soon as you click the button. We proceed working on this feature in the future. + +.. image:: ../images/IMG_Simulation_Results_1.png + :width: 100% + +:Single scenarios: + +This option makes it easy to view the results of one scenario at a time. On the left is a drop-down menu where the scenario is selected (a) and on the right is the option to add a new chart (b). + + +.. image:: ../images/IMG_Simulation_singleScenarios.png + :width: 100% + +Subsequently, the scenario KPIs will be presented, which include: Degree of Autonomy, Levelized costs of electricity equivalent, Onsite energy fraction, Renewable factor and Renewable share of local generation. + +Then, you will be able to visualize the energy system, all its components and connections. Finally, some charts summarizing the results of the scenario are presented, including the overall cost breakdown, the energy series (in KW), the installed and optimized capacity, as well as a Sankey diagram. + +Additional charts can be included, as shown in the image above with item b. The charts are interactive, as you can see the value by hovering the pointer over the chart, and there is a menu that appears in the upper right corner of the chart area. Here you can zoom in and out, reset the axes, download the image as .png format, among other options. In the legend of the charts you can select which data series to view or hide with a single click. Tables and charts can be exported in .xls, .pdf format. To do so, you can locate the three dots in the upper right corner of the tables or charts, click on them and select the alternative that suits you best. + +:Compare scenarios: + +It is also possible to compare the results of multiple scenarios. You only need to include the scenarios to be compared (c). Remember that you can add additional charts if necessary (b). + +.. image:: ../images/IMG_Simulation_compareScenarios.png + :width: 100% + +For each scenario, a column with the values will appear in the KPI table. Also, the cost, energy and installed and optimized capacity charts show the values of the scenarios. This facilitates the comparison of the data. + +As for the previous option, the charts are interactive, can be adjusted according to your needs, and both the table and the charts can be exported in different formats. + +:Sensitivity analysis: + +This functionality is not fully implemented yet. At the moment you get an error as soon as you click the button. We proceed working on this feature in the future. + + +Feedback or Question +-------------------- + +We are happy to hear about your experience with open-plan-tool, so feel free to share your questions, comments and suggestions `here. `_ We will get back to you as soon as possible. +We also have a FAQ section, your question may already be answered there. +Remember that on the project's GitHub page you can keep track of the developments that are in progress or those that have been completed. + +FAQ +--- +**To be completed** \ No newline at end of file diff --git a/docs/images/26-10-2020_sector_coupled_example.png b/docs/images/26-10-2020_sector_coupled_example.png new file mode 100644 index 0000000..b111d73 Binary files /dev/null and b/docs/images/26-10-2020_sector_coupled_example.png differ diff --git a/docs/images/IMG1_Sign_up.png b/docs/images/IMG1_Sign_up.png new file mode 100644 index 0000000..63e53a0 Binary files /dev/null and b/docs/images/IMG1_Sign_up.png differ diff --git a/docs/images/IMG2_Main_Screen.png b/docs/images/IMG2_Main_Screen.png new file mode 100644 index 0000000..3113506 Binary files /dev/null and b/docs/images/IMG2_Main_Screen.png differ diff --git a/docs/images/IMG_4_New_scenario.png b/docs/images/IMG_4_New_scenario.png new file mode 100644 index 0000000..15e6918 Binary files /dev/null and b/docs/images/IMG_4_New_scenario.png differ diff --git a/docs/images/IMG_Scenario_Steps.png b/docs/images/IMG_Scenario_Steps.png new file mode 100644 index 0000000..2da0d2f Binary files /dev/null and b/docs/images/IMG_Scenario_Steps.png differ diff --git a/docs/images/IMG_Simulation_Results_1.png b/docs/images/IMG_Simulation_Results_1.png new file mode 100644 index 0000000..2612e9a Binary files /dev/null and b/docs/images/IMG_Simulation_Results_1.png differ diff --git a/docs/images/IMG_Simulation_compareScenarios.png b/docs/images/IMG_Simulation_compareScenarios.png new file mode 100644 index 0000000..7dee5d8 Binary files /dev/null and b/docs/images/IMG_Simulation_compareScenarios.png differ diff --git a/docs/images/IMG_Simulation_singleScenarios.png b/docs/images/IMG_Simulation_singleScenarios.png new file mode 100644 index 0000000..d091cf2 Binary files /dev/null and b/docs/images/IMG_Simulation_singleScenarios.png differ diff --git a/docs/images/IMG_example_connections.png b/docs/images/IMG_example_connections.png new file mode 100644 index 0000000..f1b23ab Binary files /dev/null and b/docs/images/IMG_example_connections.png differ diff --git a/docs/images/IMG_example_storage.png b/docs/images/IMG_example_storage.png new file mode 100644 index 0000000..109943d Binary files /dev/null and b/docs/images/IMG_example_storage.png differ diff --git a/docs/images/IMG_setup_Bus.png b/docs/images/IMG_setup_Bus.png new file mode 100644 index 0000000..8c64104 Binary files /dev/null and b/docs/images/IMG_setup_Bus.png differ diff --git a/docs/images/IMG_setup_HeatDemand.png b/docs/images/IMG_setup_HeatDemand.png new file mode 100644 index 0000000..52234d8 Binary files /dev/null and b/docs/images/IMG_setup_HeatDemand.png differ diff --git a/docs/images/IMG_setup_PV.png b/docs/images/IMG_setup_PV.png new file mode 100644 index 0000000..42eec6e Binary files /dev/null and b/docs/images/IMG_setup_PV.png differ diff --git a/docs/images/IMG_simulation_panel.png b/docs/images/IMG_simulation_panel.png new file mode 100644 index 0000000..f533251 Binary files /dev/null and b/docs/images/IMG_simulation_panel.png differ diff --git a/docs/images/IMG_tool.png b/docs/images/IMG_tool.png new file mode 100644 index 0000000..834ef7d Binary files /dev/null and b/docs/images/IMG_tool.png differ diff --git a/docs/images/MVS_flowchart.png b/docs/images/MVS_flowchart.png new file mode 100644 index 0000000..cdca0cb Binary files /dev/null and b/docs/images/MVS_flowchart.png differ diff --git a/docs/images/Model_Assumptions_Peak_Demand_Pricing_Dispatch_Graph.png b/docs/images/Model_Assumptions_Peak_Demand_Pricing_Dispatch_Graph.png new file mode 100644 index 0000000..f6ca247 Binary files /dev/null and b/docs/images/Model_Assumptions_Peak_Demand_Pricing_Dispatch_Graph.png differ diff --git a/docs/images/Model_Assumptions_energyProvider_assets.png b/docs/images/Model_Assumptions_energyProvider_assets.png new file mode 100644 index 0000000..e9b1da5 Binary files /dev/null and b/docs/images/Model_Assumptions_energyProvider_assets.png differ diff --git a/docs/images/New_project_EN.png b/docs/images/New_project_EN.png new file mode 100644 index 0000000..a34ea9a Binary files /dev/null and b/docs/images/New_project_EN.png differ diff --git a/docs/images/Sensitivity_1.png b/docs/images/Sensitivity_1.png new file mode 100644 index 0000000..f54e8c8 Binary files /dev/null and b/docs/images/Sensitivity_1.png differ diff --git a/docs/images/Test_coverage.png b/docs/images/Test_coverage.png new file mode 100644 index 0000000..5803df0 Binary files /dev/null and b/docs/images/Test_coverage.png differ diff --git a/docs/images/Use_Cases/IMG_E_supply_community.png b/docs/images/Use_Cases/IMG_E_supply_community.png new file mode 100644 index 0000000..147b5a6 Binary files /dev/null and b/docs/images/Use_Cases/IMG_E_supply_community.png differ diff --git a/docs/images/Use_Cases/IMG_H_supply_community.png b/docs/images/Use_Cases/IMG_H_supply_community.png new file mode 100644 index 0000000..783e4eb Binary files /dev/null and b/docs/images/Use_Cases/IMG_H_supply_community.png differ diff --git a/docs/images/Use_Cases/IMG_MaxBoegl.png b/docs/images/Use_Cases/IMG_MaxBoegl.png new file mode 100644 index 0000000..4fc79d9 Binary files /dev/null and b/docs/images/Use_Cases/IMG_MaxBoegl.png differ diff --git a/docs/images/Use_Cases/IMG_hydrogen_technology_park.png b/docs/images/Use_Cases/IMG_hydrogen_technology_park.png new file mode 100644 index 0000000..14699ce Binary files /dev/null and b/docs/images/Use_Cases/IMG_hydrogen_technology_park.png differ diff --git a/docs/images/Use_Cases/IMG_sector_coupling_apartment.png b/docs/images/Use_Cases/IMG_sector_coupling_apartment.png new file mode 100644 index 0000000..7d8f21a Binary files /dev/null and b/docs/images/Use_Cases/IMG_sector_coupling_apartment.png differ diff --git a/docs/images/Use_Cases/IMG_sector_coupling_household.png b/docs/images/Use_Cases/IMG_sector_coupling_household.png new file mode 100644 index 0000000..5bcd21e Binary files /dev/null and b/docs/images/Use_Cases/IMG_sector_coupling_household.png differ diff --git a/docs/images/Use_Cases/IMG_sector_coupling_office.png b/docs/images/Use_Cases/IMG_sector_coupling_office.png new file mode 100644 index 0000000..a1ed517 Binary files /dev/null and b/docs/images/Use_Cases/IMG_sector_coupling_office.png differ diff --git a/docs/images/energy_system.png b/docs/images/energy_system.png new file mode 100644 index 0000000..d1ef801 Binary files /dev/null and b/docs/images/energy_system.png differ diff --git a/docs/images/energy_system_model.png b/docs/images/energy_system_model.png new file mode 100644 index 0000000..f0c5833 Binary files /dev/null and b/docs/images/energy_system_model.png differ diff --git a/docs/images/slide_1.png b/docs/images/slide_1.png new file mode 100644 index 0000000..be896e2 Binary files /dev/null and b/docs/images/slide_1.png differ diff --git a/docs/images/slide_2.png b/docs/images/slide_2.png new file mode 100644 index 0000000..d54b0e2 Binary files /dev/null and b/docs/images/slide_2.png differ diff --git a/docs/images/slide_3.png b/docs/images/slide_3.png new file mode 100644 index 0000000..662698d Binary files /dev/null and b/docs/images/slide_3.png differ diff --git a/docs/images/slide_4.png b/docs/images/slide_4.png new file mode 100644 index 0000000..e8c1607 Binary files /dev/null and b/docs/images/slide_4.png differ diff --git a/docs/images/slide_5.png b/docs/images/slide_5.png new file mode 100644 index 0000000..8e7143e Binary files /dev/null and b/docs/images/slide_5.png differ diff --git a/docs/images/slide_6.png b/docs/images/slide_6.png new file mode 100644 index 0000000..fa11cd2 Binary files /dev/null and b/docs/images/slide_6.png differ diff --git a/docs/images/slide_7.png b/docs/images/slide_7.png new file mode 100644 index 0000000..cf7f551 Binary files /dev/null and b/docs/images/slide_7.png differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..90487f5 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,205 @@ +.. .. +.. SPDX-FileCopyrightText: Open Plan Authors + +.. SPDX-License-Identifier: CC-BY-4.0 + +.. _Flowchart: + +============== +open-plan-tool +============== + +The open-plan-tool is an open-source tool for designing and optimizing multi-energy carriers energy systems and operational strategies for the supply of neighborhoods, industrial parks and industries. + +Its versatility allows you to create different projects and scenarios. You will be able to evaluate different cases and compare results between scenarios with just a few clicks. We also provide you with some use cases that can serve as a reference for your own projects. + +Modeling your energy systems has never been so easy before, the tool was developed with a strong focus on easy use without requiring programming language expertise. Using modular components, you can configure your energy system. + +.. image:: images/IMG_tool.png + :width: 100% + + +You will be asked to provide the required data via individual data, a collection of csv files or a unique JSON file with particular format. The input data is split into the following categories: +Project description, which entails the general information regarding the project (country, coordinates, etc.), as well as the economic data such as the discount factor, project duration, or tax; +System configuration, in which the user specifies the technical and financial data of each asset; +Constrains, are a fundamental part of the definition of the linear problem and describe the degree of autonomy and the share of renewable energies. +This set of input data is then translated to a linear programming problem, also known as a constrained optimization problem. The open-plan-tool is based on the multi-vector simulator (MVS), which in turn is based on the oemof-solph python library, with which a problem is described by specifying an objective function to minimize annual energy supply costs, decision variables and limits and constraints. + +The simulation outputs are also separated into categories: KPI indicators, economic results and technical results (that include the optimized capacities and dispatch of each asset). + +Explore what open-plan-tool has to offer: + +Online tool: `open-plan-tool `_ + +Publications: `List of publications `_ + +GitHub: `Online Repository `_ + +Youtube: `Watch Our Videos `_ + + + +The open-plan-tool project consortium is composed of the `Reiner Lemoine Institute (RLI) `_, `German Solar Energy Society [Deutsche Gesellschaft für Sonnenenergie (DGS)] `_ and the `Potsdam Institute for Climate Impact Research `_. It is funded within the framework of the "Technology-oriented systems analysis" funding area of the BMWi's 7th Energy Research Programme "Innovation for the energy transition". + +The open-plan-tool project complements other previous open-science research projects of RLI, such as open_eGO (OpenEnergyPlatfrom), open_FRED (feed-in time series on OpenEnergyPlatform) and enables the comparison, validation and improvement of energy system modelling. + + + +Maintainers +------------ +The open-plan-tool is currently maintained by staff from the `Reiner Lemoine Institute `__ the `Potsdam Institute for Climate Impact Research `__ and the `German Solar Energy Society `__. + + +.. .. only:: html + +.. .. image:: https://readthedocs.org/projects/multi-vector-simulator/badge/?version=latest +.. :target: https://multi-vector-simulator.readthedocs.io/en/latest/?badge=latest +.. :alt: Documentation Status + +.. .. image:: https://github.com/rl-institut/multi-vector-simulator/workflows/CI/badge.svg +.. :alt: Build status + +.. .. image:: https://coveralls.io/repos/github/rl-institut/multi-vector-simulator/badge.svg +.. :target: https://coveralls.io/github/rl-institut/multi-vector-simulator +.. :alt: Test coverage + +.. .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4610237.svg +.. :target: https://doi.org/10.5281/zenodo.4610237 +.. :alt: Zenodo DOI + +.. .. image:: https://img.shields.io/badge/License-GPL%20v2-blue.svg +.. :target: https://img.shields.io/badge/License-GPL%20v2-blue.svg +.. :alt: License gpl2 + +.. .. image:: https://badge.fury.io/py/multi-vector-simulator.svg +.. :target: https://pypi.org/project/multi-vector-simulator/ +.. :alt: Pypi version + +.. .. image:: https://img.shields.io/badge/code%20style-black-000000.svg +.. :target: https://github.com/psf/black +.. :alt: black linter + +.. The open-plan-tool is an `oemof `__ -based Python package which aims at facilitating the modelling of multi-energy carriers energy systems in island or grid connected mode. + +.. The main goals of the open-plan-tool are + +.. #. to minimize the production costs by determining the generating units' optimal output, which meets the total demand + +.. #. to optimize near-future investments in generation and storage assets with the least possible cost of energy. + + + +.. The open-plan-tool graphical model is divided into three connected blocks that trace the logic sequence: inputs, system model, and outputs. This is a typical representation of a simulation model: + +.. .. image:: images/MVS_flowchart.png +.. :width: 600 + +.. The user is asked to provide the required data via a collection of csv files or a unique json file with particular format. The input data is split into the following categories: + +.. * **Project description**, which entails the general information regarding the project (country, coordinates, etc.), as well as the economic data such as the discount factor, project duration, or tax + +.. * **Energy consumption**, which is expressed as times series based on the type of energy (in this case: electrical and thermal) + +.. * **System configuration**, in which the user specifies the technical and financial data of each asset + +.. * **Meteorological data**, which is related to the components that generate electricity by harnessing an existing source of energy that is weather- and time-dependent (e.g. solar and wind power) + +.. This set of input data is then translated to a linear programming problem, also known as a constrained optimization problem. The MVS is based on the `oemof-solph `__ python library that describes the problem by specifying an objective function to minimize the annual energy supply costs, the decision variables and the bounds and constraints. + +.. The simulation outputs are also separated into categories: + +.. * Economic results used for the financial evaluation, such as the levelized cost of electricity/heat or the net present value of the projected investments +.. * Technical results that include the optimized capacities and dispatch of each asset +.. * Environmental results assessing the system’s environmental contribution in terms of CO2 emissions. + +.. Additionally, different vizualizations of the results can be provided, eg. as pie charts, plots of asset dispatch and an automatic summary report. + +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: Getting Started + + getting_started/quick_start_guide.rst + getting_started/installation.rst + getting_started/basic_structure.rst + +.. + getting_started/contact_us.rst + +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: Use Cases + + examples/Industrial_site_Max_Boegl.rst + examples/Electricity_supply_to_community.rst + examples/Heat_supply_to_community.rst + examples/Sector_coupling_for_office_building.rst + examples/Hydrogen_production_for_a_technology_park.rst + examples/Sector_coupling_for_single_household.rst + examples/Sector_coupling_for_apartment_building.rst + + +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: Mathematical Description + + getting_started/mathematics_simply_explained.rst + +.. + math/math_intro.rst + + +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: Model Reference + + model/assumptions.rst + model/components.rst + model/constraints.rst + model/limitations.rst + model/input_parameters.rst + model/simulation_outputs.rst + + +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: References + + references/references.rst + +.. Model Reference +.. =============== + +.. * **How the energy system is modelled**: :doc:`Assumption behind the model ` | :doc:`Available components for modelling ` | :doc:`Setting constraints on model or components ` | :doc:`Scope and limitation of the model ` +.. * **Description of parameters**: :doc:`Input parameters ` | :doc:`Output variables and KPIs ` +.. * **Validation of the model**: :doc:`Validation methodology ` + +.. .. maybe add Pilot projects here as well? +.. .. +.. release_notes (for website, remove for report, not implemented yet, nice to have) +.. contributing (here paste content of contributing.md --> convert to RST and include it as we did for readme, the mention to contributing in getting started will link to this chapter) +.. API Reference +.. ============= + +.. * **Documentation**: :doc:`Modules and functions ` +.. * **Getting involved**: :doc:`Contributing guidelines and protocols ` +.. * **Academic references**: :doc:`Publications and Bibliography ` +.. * **Using or modifying MVS**: :doc:`License ` | :doc:`How to cite MVS ` +.. * **Getting help**: :doc:`Know issues and workaround ` | :doc:`Report a bug or issue ` + + + +.. Indices and tables +.. ================== + +.. * :ref:`genindex` +.. * :ref:`modindex` +.. * :ref:`search` + + + + diff --git a/docs/locale/de/LC_MESSAGES/abstract_components/abstract_component_template.mo b/docs/locale/de/LC_MESSAGES/abstract_components/abstract_component_template.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/abstract_components/abstract_component_template.mo differ diff --git a/docs/locale/de/LC_MESSAGES/abstract_components/abstract_component_template.po b/docs/locale/de/LC_MESSAGES/abstract_components/abstract_component_template.po new file mode 100755 index 0000000..8fb8741 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/abstract_components/abstract_component_template.po @@ -0,0 +1,23 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../abstract_components/abstract_component_template.rst:1 +msgid "... Template file" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/abstract_components/project.mo b/docs/locale/de/LC_MESSAGES/abstract_components/project.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/abstract_components/project.mo differ diff --git a/docs/locale/de/LC_MESSAGES/abstract_components/project.po b/docs/locale/de/LC_MESSAGES/abstract_components/project.po new file mode 100755 index 0000000..1d83b2f --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/abstract_components/project.po @@ -0,0 +1,107 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../abstract_components/project.rst:2 +msgid "Project" +msgstr "" + +#: ../../abstract_components/project.rst:8 +msgid "Attributes" +msgstr "" + +#: ../../abstract_components/project.rst:13 +msgid "**Project as an object**" +msgstr "" + +#: ../../abstract_components/project.rst:11 +msgid "" +"Project is an object that exists in the computer's temporary memory " +"(RAM). It can be considered as the a concept that holds one or more " +"scenarios of the energy system simulation sharing some common " +"characteristics." +msgstr "" + +#: ../../abstract_components/project.rst:13 +msgid "" +"It could be saved to the permanent memory by saving the data the object " +"holds to disk as a file of an appropriate format." +msgstr "" + +#: ../../abstract_components/project.rst:16 +msgid "Actions" +msgstr "" + +#: ../../abstract_components/project.rst:18 +msgid "" +"Existing project object can be loaded through the *load_project* view " +"component in the Landing Page view" +msgstr "" + +#: ../../abstract_components/project.rst:19 +msgid "" +"New project object can be created through the UI of the tool using the " +"*create_project* view component in the Landing Page view" +msgstr "" + +#: ../../abstract_components/project.rst:20 +msgid "" +"Current project object can be saved to the disk by the user through the " +"*Save Project* button that connects to the *read_write_files* view-" +"component" +msgstr "" + +#: ../../abstract_components/project.rst:24 +msgid "Requirements" +msgstr "" + +#: ../../abstract_components/project.rst:26 +msgid "The objects must be accessible to other relevant view components" +msgstr "" + +#: ../../abstract_components/project.rst:27 +msgid "" +"External project objects created in other software that are to be " +"imported into open_plan should adhere to the data standards" +msgstr "" + +#: ../../abstract_components/project.rst:28 +msgid "" +"The project object be saved to disk in an appropriate format before " +"exiting the tool in order to be accessible later" +msgstr "" + +#: ../../abstract_components/project.rst:31 +msgid "Link with views" +msgstr "" + +#: ../../abstract_components/project.rst:33 +#: ../../abstract_components/project.rst:39 +msgid ":ref:`read_write_files-label`" +msgstr "" + +#: ../../abstract_components/project.rst:37 +msgid "Link with other view-components" +msgstr "" + +#: ../../abstract_components/project.rst:40 +msgid "" +"This view-component is required to read and write files from and to the " +"disk respectively" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/abstract_components/scenario.mo b/docs/locale/de/LC_MESSAGES/abstract_components/scenario.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/abstract_components/scenario.mo differ diff --git a/docs/locale/de/LC_MESSAGES/abstract_components/scenario.po b/docs/locale/de/LC_MESSAGES/abstract_components/scenario.po new file mode 100755 index 0000000..d83b8d4 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/abstract_components/scenario.po @@ -0,0 +1,98 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../abstract_components/scenario.rst:2 +msgid "Scenario" +msgstr "" + +#: ../../abstract_components/scenario.rst:8 +msgid "Attributes" +msgstr "" + +#: ../../abstract_components/scenario.rst:12 +msgid "**Scenario as an object**" +msgstr "" + +#: ../../abstract_components/scenario.rst:11 +msgid "" +"Scenario is an object that exists in the computer's temporary memory " +"(RAM). It can be considered as the a concept that wraps an instance of " +"the energy system class plus the inputs. However, it could be saved to " +"the permanent memory by saving the data the object holds to disk as a " +"file of an appropriate format." +msgstr "" + +#: ../../abstract_components/scenario.rst:15 +msgid "Actions" +msgstr "" + +#: ../../abstract_components/scenario.rst:17 +msgid "" +"Scenario can be saved to disk through the *load scenario* view component " +"in the Scenarios view" +msgstr "" + +#: ../../abstract_components/scenario.rst:18 +msgid "" +"Multiple scenario objects can be created during the simulation using the " +"*create scenario* view component in the Scenarios view" +msgstr "" + +#: ../../abstract_components/scenario.rst:19 +msgid "" +"Multiple scenario objects can be compared in the *scenario comparison* " +"view" +msgstr "" + +#: ../../abstract_components/scenario.rst:23 +msgid "Requirements" +msgstr "" + +#: ../../abstract_components/scenario.rst:25 +msgid "The objects must be accessible to other relevant view components" +msgstr "" + +#: ../../abstract_components/scenario.rst:26 +msgid "" +"External scenario objects created in other software that are to be " +"imported into open_plan should adhere to the data standards" +msgstr "" + +#: ../../abstract_components/scenario.rst:27 +msgid "" +"Should be saved to disk in an appropriate format before exiting the tool " +"in order to be accessible later" +msgstr "" + +#: ../../abstract_components/scenario.rst:30 +msgid "Link with views" +msgstr "" + +#: ../../abstract_components/scenario.rst:32 +msgid "*placeholder* *placeholder2*" +msgstr "" + +#: ../../abstract_components/scenario.rst:36 +msgid "Link with other view-components" +msgstr "" + +#: ../../abstract_components/scenario.rst:38 +msgid "*placeholder*" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/index.mo b/docs/locale/de/LC_MESSAGES/index.mo new file mode 100755 index 0000000..8a24779 Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/index.mo differ diff --git a/docs/locale/de/LC_MESSAGES/index.po b/docs/locale/de/LC_MESSAGES/index.po new file mode 100755 index 0000000..3b478ec --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/index.po @@ -0,0 +1,67 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../index.rst:7 +msgid "open_plan Documentation" +msgstr "open_plan Doku" + +#: ../../index.rst:14 +msgid "" +"open_plan is a Python-based, open-source energy system modeling tool " +"targeted at simulating energy cells e.g. energy systems for industry " +"parks and districts, or mini-grids." +msgstr "Das ist Lustig" + +#: ../../index.rst:16 +msgid "" +"It uses the `oemof `_ framework to describe and " +"optimize the energy system and will provide a user-friendly web-based " +"interface to intereact with python. This will enable users **without " +"python or programming knowledge** to use the tool and simulate energy " +"systems." +msgstr "" + +#: ../../index.rst:29 +msgid "Indices and tables" +msgstr "" + +#: ../../index.rst:31 +msgid ":ref:`genindex`" +msgstr "" + +#: ../../index.rst:32 +msgid ":ref:`modindex`" +msgstr "" + +#: ../../index.rst:33 +msgid ":ref:`search`" +msgstr "" + +#: ../../index.rst:38 +msgid "open_plan Resources" +msgstr "" + +#: ../../index.rst:44 +msgid "open_plan development is hosted at GitHub:" +msgstr "" + +#: ../../index.rst:46 +msgid "https://github.com/rl-institut/open_plan/" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/parameters.mo b/docs/locale/de/LC_MESSAGES/parameters.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/parameters.mo differ diff --git a/docs/locale/de/LC_MESSAGES/parameters.po b/docs/locale/de/LC_MESSAGES/parameters.po new file mode 100755 index 0000000..7dc9289 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/parameters.po @@ -0,0 +1,1010 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../parameters.rst:5 +msgid "Parameters" +msgstr "" + +#: ../../parameters.rst:8 +msgid "Inputs" +msgstr "" + +#: ../../parameters.rst:10 +msgid "Inputs are necessary values for the optimization." +msgstr "" + +#: ../../parameters.rst:11 +msgid "" +"All inputs have default values that can be replaced by the user if " +"desired." +msgstr "" + +#: ../../parameters.rst:13 ../../parameters.rst:37 +msgid "" +"It could also be a chance to specify for each input if it is a project " +"input or a scenario input. It could also be a chance to explain the " +"default value for each input in a short line. It could be nice to add the" +" name of the view-component they are part of." +msgstr "" + +#: ../../parameters.rst:20 ../../parameters.rst:44 +msgid "Table Title" +msgstr "" + +#: ../../_files/input_parameters_list_short.inc +#: ../../_files/output_parameters_list_short.inc +msgid "Name" +msgstr "" + +#: ../../_files/input_parameters_list.inc +#: ../../_files/input_parameters_list_short.inc +#: ../../_files/output_parameters_list.inc +#: ../../_files/output_parameters_list_short.inc +msgid "Unit" +msgstr "" + +#: ../../_files/input_parameters_list.inc +#: ../../_files/input_parameters_list_short.inc +#: ../../_files/output_parameters_list.inc +#: ../../_files/output_parameters_list_short.inc +msgid "Default" +msgstr "" + +#: ../../_files/input_parameters_list.inc +#: ../../_files/input_parameters_list_short.inc +#: ../../_files/output_parameters_list.inc +#: ../../_files/output_parameters_list_short.inc +msgid "Category" +msgstr "" + +#: ../../_files/input_parameters_list.inc +#: ../../_files/input_parameters_list_short.inc +#: ../../_files/output_parameters_list.inc +#: ../../_files/output_parameters_list_short.inc +msgid "Restrictions" +msgstr "" + +#: ../../_files/input_parameters_list.inc +#: ../../_files/input_parameters_list_short.inc +#: ../../_files/output_parameters_list.inc +#: ../../_files/output_parameters_list_short.inc +msgid "Definition" +msgstr "" + +#: ../../_files/input_parameters_list.inc:4 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Demand profile" +msgstr "" + +#: ../../_files/input_parameters_list.inc:9 +#: ../../_files/input_parameters_list.inc:22 +#: ../../_files/input_parameters_list.inc:35 +#: ../../_files/input_parameters_list.inc:48 +#: ../../_files/input_parameters_list.inc:74 +#: ../../_files/input_parameters_list.inc:87 +#: ../../_files/input_parameters_list.inc:100 +#: ../../_files/input_parameters_list.inc:113 +#: ../../_files/input_parameters_list.inc:139 +#: ../../_files/input_parameters_list.inc:334 +#: ../../_files/input_parameters_list.inc:347 +#: ../../_files/input_parameters_list.inc:360 +#: ../../_files/input_parameters_list.inc:373 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:126 +#: ../../_files/output_parameters_list.inc:139 +#: ../../_files/output_parameters_list.inc:152 +#: ../../_files/output_parameters_list.inc:165 +#: ../../_files/output_parameters_list.inc:178 +#: ../../_files/output_parameters_list.inc:204 +#: ../../_files/output_parameters_list.inc:217 +#: ../../_files/output_parameters_list.inc:243 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Technical" +msgstr "" + +#: ../../_files/input_parameters_list.inc:6 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"The energy demand time serie with timestep (if different energy types are" +" considered different profiles must be given)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:17 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Energy timeseries" +msgstr "" + +#: ../../_files/input_parameters_list.inc:20 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:176 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "kWh" +msgstr "" + +#: ../../_files/input_parameters_list.inc:23 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "between 0 and 1 (normalized with maximum)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:19 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"Specific timeseries of energy sources from a primary-secondary " +"transformation (e.g. PV, Wind)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:30 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Source power mix" +msgstr "" + +#: ../../_files/input_parameters_list.inc:33 +#: ../../_files/input_parameters_list.inc:46 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:46 +#: ../../_files/output_parameters_list.inc:124 +#: ../../_files/output_parameters_list.inc:137 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Percentage" +msgstr "" + +#: ../../_files/input_parameters_list.inc:32 +#: ../../_files/input_parameters_list_short.inc:1 +#, python-format +msgid "Percentage of each source of power (inclusive % from Grid)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:43 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Lower bound renewable energy share" +msgstr "" + +#: ../../_files/input_parameters_list.inc:47 +#: ../../_files/input_parameters_list.inc:60 +#: ../../_files/input_parameters_list.inc:73 +#: ../../_files/input_parameters_list.inc:86 +#: ../../_files/input_parameters_list.inc:99 +#: ../../_files/input_parameters_list.inc:112 +#: ../../_files/input_parameters_list.inc:125 +#: ../../_files/input_parameters_list.inc:138 +#: ../../_files/input_parameters_list.inc:151 +#: ../../_files/input_parameters_list.inc:177 +#: ../../_files/input_parameters_list.inc:190 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:8 +#: ../../_files/output_parameters_list.inc:21 +#: ../../_files/output_parameters_list.inc:34 +#: ../../_files/output_parameters_list.inc:47 +#: ../../_files/output_parameters_list.inc:60 +#: ../../_files/output_parameters_list.inc:73 +#: ../../_files/output_parameters_list.inc:86 +#: ../../_files/output_parameters_list.inc:98 +#: ../../_files/output_parameters_list.inc:111 +#: ../../_files/output_parameters_list.inc:125 +#: ../../_files/output_parameters_list.inc:138 +#: ../../_files/output_parameters_list.inc:151 +#: ../../_files/output_parameters_list.inc:164 +#: ../../_files/output_parameters_list.inc:177 +#: ../../_files/output_parameters_list.inc:189 +#: ../../_files/output_parameters_list.inc:203 +#: ../../_files/output_parameters_list.inc:216 +#: ../../_files/output_parameters_list.inc:228 +#: ../../_files/output_parameters_list.inc:242 +#: ../../_files/output_parameters_list.inc:254 +#: ../../_files/output_parameters_list.inc:268 +#: ../../_files/output_parameters_list.inc:280 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "None" +msgstr "" + +#: ../../_files/input_parameters_list.inc:45 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"A constraint that specifies the lower bound on the share of renewable " +"energies in the optimized output energy mix" +msgstr "" + +#: ../../_files/input_parameters_list.inc:56 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "CO2 upper limit" +msgstr "" + +#: ../../_files/input_parameters_list.inc:59 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "T of CO2" +msgstr "" + +#: ../../_files/input_parameters_list.inc:61 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:35 +#: ../../_files/output_parameters_list.inc:48 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Environmental" +msgstr "" + +#: ../../_files/input_parameters_list.inc:58 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "A constraint that specifies an upper bound on the CO2 emissions" +msgstr "" + +#: ../../_files/input_parameters_list.inc:69 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Energy sources capacities" +msgstr "" + +#: ../../_files/input_parameters_list.inc:72 +#: ../../_files/input_parameters_list.inc:85 +#: ../../_files/input_parameters_list.inc:98 +#: ../../_files/input_parameters_list.inc:111 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:150 +#: ../../_files/output_parameters_list.inc:163 +#: ../../_files/output_parameters_list.inc:241 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "kW" +msgstr "" + +#: ../../_files/input_parameters_list.inc:71 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Energy sources with their capacity open for optimization" +msgstr "" + +#: ../../_files/input_parameters_list.inc:82 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Storage units" +msgstr "" + +#: ../../_files/input_parameters_list.inc:84 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Energy storage units with their capacity and technology" +msgstr "" + +#: ../../_files/input_parameters_list.inc:95 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Existing energy source infrastructure" +msgstr "" + +#: ../../_files/input_parameters_list.inc:97 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"Existing energy infrastructure not up for optimization (with given " +"capacities)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:108 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Existing energy storage infrastructure" +msgstr "" + +#: ../../_files/input_parameters_list.inc:110 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"Existing storage infrastructure not up for optimization (with given " +"capacities)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:121 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "GPS coordinates" +msgstr "" + +#: ../../_files/input_parameters_list.inc:126 +#: ../../_files/input_parameters_list.inc:269 +#: ../../_files/input_parameters_list.inc:282 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "GIS" +msgstr "" + +#: ../../_files/input_parameters_list.inc:123 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"GPS coordinate of the location, to retrieve the weather conditions in " +"case of missing timeseries. Could be a point, a set of points, or a " +"polygon" +msgstr "" + +#: ../../_files/input_parameters_list.inc:134 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Grid parameters (v2.0 of the tool)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:136 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"Grid parameters such as: power, voltage, frequence, line length, line " +"impedance, transformers, topology" +msgstr "" + +#: ../../_files/input_parameters_list.inc:147 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:82 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Degree of Autonomy (DA)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:150 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:72 +#: ../../_files/output_parameters_list.inc:85 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "factor" +msgstr "" + +#: ../../_files/input_parameters_list.inc:152 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Constraint" +msgstr "" + +#: ../../_files/input_parameters_list.inc:153 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:75 +#: ../../_files/output_parameters_list.inc:88 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "between 0 and 1" +msgstr "" + +#: ../../_files/input_parameters_list.inc:149 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"Degree of Autonomy or self sufficiency wished (capability of the system " +"to sustain a certain part of the load)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:160 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Temporal resolution of simulation" +msgstr "" + +#: ../../_files/input_parameters_list.inc:165 +#: ../../_files/input_parameters_list.inc:397 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:267 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Time" +msgstr "" + +#: ../../_files/input_parameters_list.inc:162 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"Time step of the simulation. The user should be aware that a higher " +"resolution require more data and can lead to longer simulation times " +"(might be already in the provided timeseries)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:173 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Optimization goal" +msgstr "" + +#: ../../_files/input_parameters_list.inc:178 +#: ../../_files/input_parameters_list.inc:399 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Simulation" +msgstr "" + +#: ../../_files/input_parameters_list.inc:175 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"The quantities which govern the optimization (CO2, costs, renewable " +"maximization in energy mix, degree of autonomy, multi-objectives)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:186 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Maximum investment budget" +msgstr "" + +#: ../../_files/input_parameters_list.inc:189 +#: ../../_files/input_parameters_list.inc:202 +#: ../../_files/input_parameters_list.inc:215 +#: ../../_files/input_parameters_list.inc:228 +#: ../../_files/input_parameters_list.inc:241 +#: ../../_files/input_parameters_list.inc:254 +#: ../../_files/input_parameters_list.inc:384 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:7 +#: ../../_files/output_parameters_list.inc:20 +#: ../../_files/output_parameters_list.inc:59 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "EUR" +msgstr "" + +#: ../../_files/input_parameters_list.inc:191 +#: ../../_files/input_parameters_list.inc:204 +#: ../../_files/input_parameters_list.inc:217 +#: ../../_files/input_parameters_list.inc:230 +#: ../../_files/input_parameters_list.inc:243 +#: ../../_files/input_parameters_list.inc:256 +#: ../../_files/input_parameters_list.inc:386 +#: ../../_files/input_parameters_list_short.inc:1 +#: ../../_files/output_parameters_list.inc:9 +#: ../../_files/output_parameters_list.inc:22 +#: ../../_files/output_parameters_list.inc:61 +#: ../../_files/output_parameters_list.inc:269 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Financial" +msgstr "" + +#: ../../_files/input_parameters_list.inc:188 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Upper bound on the investment budget" +msgstr "" + +#: ../../_files/input_parameters_list.inc:199 +#: ../../_files/input_parameters_list.inc:201 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Current price of CO2 emission certificates" +msgstr "" + +#: ../../_files/input_parameters_list.inc:212 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Future price estimates for CO2 emission certificates" +msgstr "" + +#: ../../_files/input_parameters_list.inc:214 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"Timeseries of future price for CO2 emission certificates (values from " +"the EU-ETS and DE-ETS)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:225 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Interest rate" +msgstr "" + +#: ../../_files/input_parameters_list.inc:229 +#: ../../_files/input_parameters_list.inc:255 +#: ../../_files/input_parameters_list.inc:385 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Value provided" +msgstr "" + +#: ../../_files/input_parameters_list.inc:227 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"A guess of what the interest rate will be in during the project " +"lifetime. Could be provided as constant or timeseries." +msgstr "" + +#: ../../_files/input_parameters_list.inc:238 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Costs of replacement" +msgstr "" + +#: ../../_files/input_parameters_list.inc:242 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Value provided for each accepted asset type" +msgstr "" + +#: ../../_files/input_parameters_list.inc:240 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Costs of replacement/improvement of the current system components/assets" +msgstr "" + +#: ../../_files/input_parameters_list.inc:251 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Grid stability fee" +msgstr "" + +#: ../../_files/input_parameters_list.inc:253 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Fee/payment for contribution to grid stability" +msgstr "" + +#: ../../_files/input_parameters_list.inc:264 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Spatial resolution" +msgstr "" + +#: ../../_files/input_parameters_list.inc:266 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"Define the wished spatial resolution (it is wished that it can range from" +" building up to districts)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:277 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "New power plant available space" +msgstr "" + +#: ../../_files/input_parameters_list.inc:279 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Available space for new power plants (for PV installation for example)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:290 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Consumer requirements" +msgstr "" + +#: ../../_files/input_parameters_list.inc:295 +#: ../../_files/input_parameters_list.inc:308 +#: ../../_files/input_parameters_list.inc:321 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "GIS/Technical" +msgstr "" + +#: ../../_files/input_parameters_list.inc:292 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"consumer requirements such as a specific localisation and wished minimal " +"load profile (e.g. in an industry park)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:303 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Existing grid structure (v2.0 of the tool)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:305 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "GPS coordinates of current grid structure (lines and hubs)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:316 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Future grid structure (v2.0 of the tool)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:318 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "GPS coordinates of future grid structure (lines and hubs)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:329 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Security of supply" +msgstr "" + +#: ../../_files/input_parameters_list.inc:331 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "e.g. existence of back-up system" +msgstr "" + +#: ../../_files/input_parameters_list.inc:342 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Balancing ratio for anciliary services" +msgstr "" + +#: ../../_files/input_parameters_list.inc:344 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "" +"Balancing ratio for ancilliary services (need a more precise definition " +"as PF could not re-figure out what this means)" +msgstr "" + +#: ../../_files/input_parameters_list.inc:355 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Number of future extra users" +msgstr "" + +#: ../../_files/input_parameters_list.inc:357 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Number of future extra user in energy cell" +msgstr "" + +#: ../../_files/input_parameters_list.inc:368 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Load types" +msgstr "" + +#: ../../_files/input_parameters_list.inc:370 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Designation of flexible and non-flexible loads in the load profile" +msgstr "" + +#: ../../_files/input_parameters_list.inc:381 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Costs of asset use" +msgstr "" + +#: ../../_files/input_parameters_list.inc:383 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "The price of a liter of diesel or a kWh from the grid" +msgstr "" + +#: ../../_files/input_parameters_list.inc:394 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "Project lifetime" +msgstr "" + +#: ../../_files/input_parameters_list.inc:396 +#: ../../_files/input_parameters_list_short.inc:1 +msgid "The lifetime of the project (simulation time)" +msgstr "" + +#: ../../parameters.rst:24 ../../parameters.rst:48 +msgid "Another way to display the Inputs" +msgstr "" + +#: ../../_files/input_parameters_list.inc:7 +#: ../../_files/input_parameters_list.inc:8 +#: ../../_files/input_parameters_list.inc:10 +#: ../../_files/input_parameters_list.inc:21 +#: ../../_files/input_parameters_list.inc:34 +#: ../../_files/input_parameters_list.inc:36 +#: ../../_files/input_parameters_list.inc:49 +#: ../../_files/input_parameters_list.inc:62 +#: ../../_files/input_parameters_list.inc:75 +#: ../../_files/input_parameters_list.inc:88 +#: ../../_files/input_parameters_list.inc:101 +#: ../../_files/input_parameters_list.inc:114 +#: ../../_files/input_parameters_list.inc:124 +#: ../../_files/input_parameters_list.inc:127 +#: ../../_files/input_parameters_list.inc:137 +#: ../../_files/input_parameters_list.inc:140 +#: ../../_files/input_parameters_list.inc:163 +#: ../../_files/input_parameters_list.inc:164 +#: ../../_files/input_parameters_list.inc:166 +#: ../../_files/input_parameters_list.inc:176 +#: ../../_files/input_parameters_list.inc:179 +#: ../../_files/input_parameters_list.inc:192 +#: ../../_files/input_parameters_list.inc:203 +#: ../../_files/input_parameters_list.inc:205 +#: ../../_files/input_parameters_list.inc:216 +#: ../../_files/input_parameters_list.inc:218 +#: ../../_files/input_parameters_list.inc:231 +#: ../../_files/input_parameters_list.inc:244 +#: ../../_files/input_parameters_list.inc:257 +#: ../../_files/input_parameters_list.inc:267 +#: ../../_files/input_parameters_list.inc:268 +#: ../../_files/input_parameters_list.inc:270 +#: ../../_files/input_parameters_list.inc:280 +#: ../../_files/input_parameters_list.inc:281 +#: ../../_files/input_parameters_list.inc:283 +#: ../../_files/input_parameters_list.inc:293 +#: ../../_files/input_parameters_list.inc:294 +#: ../../_files/input_parameters_list.inc:296 +#: ../../_files/input_parameters_list.inc:306 +#: ../../_files/input_parameters_list.inc:307 +#: ../../_files/input_parameters_list.inc:309 +#: ../../_files/input_parameters_list.inc:319 +#: ../../_files/input_parameters_list.inc:320 +#: ../../_files/input_parameters_list.inc:322 +#: ../../_files/input_parameters_list.inc:332 +#: ../../_files/input_parameters_list.inc:333 +#: ../../_files/input_parameters_list.inc:335 +#: ../../_files/input_parameters_list.inc:345 +#: ../../_files/input_parameters_list.inc:346 +#: ../../_files/input_parameters_list.inc:348 +#: ../../_files/input_parameters_list.inc:358 +#: ../../_files/input_parameters_list.inc:359 +#: ../../_files/input_parameters_list.inc:361 +#: ../../_files/input_parameters_list.inc:371 +#: ../../_files/input_parameters_list.inc:372 +#: ../../_files/input_parameters_list.inc:374 +#: ../../_files/input_parameters_list.inc:387 +#: ../../_files/input_parameters_list.inc:398 +#: ../../_files/input_parameters_list.inc:400 +#: ../../_files/output_parameters_list.inc:10 +#: ../../_files/output_parameters_list.inc:99 +#: ../../_files/output_parameters_list.inc:101 +#: ../../_files/output_parameters_list.inc:112 +#: ../../_files/output_parameters_list.inc:114 +#: ../../_files/output_parameters_list.inc:127 +#: ../../_files/output_parameters_list.inc:140 +#: ../../_files/output_parameters_list.inc:153 +#: ../../_files/output_parameters_list.inc:166 +#: ../../_files/output_parameters_list.inc:179 +#: ../../_files/output_parameters_list.inc:190 +#: ../../_files/output_parameters_list.inc:192 +#: ../../_files/output_parameters_list.inc:202 +#: ../../_files/output_parameters_list.inc:205 +#: ../../_files/output_parameters_list.inc:218 +#: ../../_files/output_parameters_list.inc:229 +#: ../../_files/output_parameters_list.inc:231 +#: ../../_files/output_parameters_list.inc:244 +#: ../../_files/output_parameters_list.inc:255 +#: ../../_files/output_parameters_list.inc:257 +#: ../../_files/output_parameters_list.inc:281 +#: ../../_files/output_parameters_list.inc:283 +msgid "nan" +msgstr "" + +#: ../../parameters.rst:32 +msgid "Outputs" +msgstr "" + +#: ../../parameters.rst:34 +msgid "Outputs are necessary values for the optimization." +msgstr "" + +#: ../../parameters.rst:35 +msgid "" +"All outputs have default values that can be replaced by the user if " +"desired." +msgstr "" + +#: ../../_files/output_parameters_list.inc:4 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Costs for CO2 emission" +msgstr "" + +#: ../../_files/output_parameters_list.inc:6 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"Calculated costs for CO2 emission certificates (current and future) from " +"inputs" +msgstr "" + +#: ../../_files/output_parameters_list.inc:17 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "LCOE" +msgstr "" + +#: ../../_files/output_parameters_list.inc:23 +#: ../../_files/output_parameters_list.inc:36 +#: ../../_files/output_parameters_list.inc:49 +#: ../../_files/output_parameters_list.inc:62 +#: ../../_files/output_parameters_list.inc:270 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "0 or above" +msgstr "" + +#: ../../_files/output_parameters_list.inc:19 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Levelized costs of energy" +msgstr "" + +#: ../../_files/output_parameters_list.inc:30 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Emissions CO2eq" +msgstr "" + +#: ../../_files/output_parameters_list.inc:33 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "T of CO2eq" +msgstr "" + +#: ../../_files/output_parameters_list.inc:32 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Emissions of CO2eq (gCO2eq/kWh, TCO2eq emitted)" +msgstr "" + +#: ../../_files/output_parameters_list.inc:43 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Relative emissions CO2eq" +msgstr "" + +#: ../../_files/output_parameters_list.inc:45 +#: ../../_files/output_parameters_list_short.inc:1 +#, python-format +msgid "" +"Emissions of CO2eq relative to another scenario (% reduced emissions " +"compared to another scenario. E.g: BAU)" +msgstr "" + +#: ../../_files/output_parameters_list.inc:56 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Investment needed" +msgstr "" + +#: ../../_files/output_parameters_list.inc:58 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Total investment needed" +msgstr "" + +#: ../../_files/output_parameters_list.inc:69 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Degree of sector-coupling" +msgstr "" + +#: ../../_files/output_parameters_list.inc:74 +#: ../../_files/output_parameters_list.inc:87 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "KPI" +msgstr "" + +#: ../../_files/output_parameters_list.inc:71 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"A synergy index of the energy system expressed via the DOA defined in a " +"publication of RLI" +msgstr "" + +#: ../../_files/output_parameters_list.inc:84 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"Degree of Autonomy or self sufficiency obtained, typically a number " +"between 0 and 1" +msgstr "" + +#: ../../_files/output_parameters_list.inc:95 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Transformation pathway" +msgstr "" + +#: ../../_files/output_parameters_list.inc:100 +#: ../../_files/output_parameters_list.inc:113 +#: ../../_files/output_parameters_list.inc:191 +#: ../../_files/output_parameters_list.inc:230 +#: ../../_files/output_parameters_list.inc:256 +#: ../../_files/output_parameters_list.inc:282 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Report" +msgstr "" + +#: ../../_files/output_parameters_list.inc:97 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"Enable the user to carry out this analysis on how to get from current " +"situation to future situation from the other outputs. The pathway itself " +"shall not be output by the simulation as it depends on policies and human" +" political decisions as well" +msgstr "" + +#: ../../_files/output_parameters_list.inc:108 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Scenarios comparisons" +msgstr "" + +#: ../../_files/output_parameters_list.inc:110 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"Comparison of different energy systems and energy mixs (like RLI stemp-" +"mv tool). Could compare energy savings, costs savings, CO2 savings" +msgstr "" + +#: ../../_files/output_parameters_list.inc:121 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Energy mix" +msgstr "" + +#: ../../_files/output_parameters_list.inc:123 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Percentage of each asset for each energy type." +msgstr "" + +#: ../../_files/output_parameters_list.inc:134 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Renewable energy share" +msgstr "" + +#: ../../_files/output_parameters_list.inc:136 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "The share of renewable energy produced in the output energy mix" +msgstr "" + +#: ../../_files/output_parameters_list.inc:147 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Wasted energy" +msgstr "" + +#: ../../_files/output_parameters_list.inc:149 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"Energy which could not be stored, or was lost in Joule effect (heating), " +"i.e. losses in heat boilers" +msgstr "" + +#: ../../_files/output_parameters_list.inc:160 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Installed capacity" +msgstr "" + +#: ../../_files/output_parameters_list.inc:162 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"The minimal capacity that needs to be installed in order to meet peak " +"demand" +msgstr "" + +#: ../../_files/output_parameters_list.inc:173 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Installed power" +msgstr "" + +#: ../../_files/output_parameters_list.inc:175 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "The aggregated power that needs to be produced in order to meet demand" +msgstr "" + +#: ../../_files/output_parameters_list.inc:186 +#: ../../_files/output_parameters_list.inc:188 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Calculate network requirements or expansion possibilities" +msgstr "" + +#: ../../_files/output_parameters_list.inc:199 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Grid equipment requirements" +msgstr "" + +#: ../../_files/output_parameters_list.inc:201 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Number of new transformers (v2.0 of the tool)" +msgstr "" + +#: ../../_files/output_parameters_list.inc:212 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Grid cable requirements" +msgstr "" + +#: ../../_files/output_parameters_list.inc:215 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "km" +msgstr "" + +#: ../../_files/output_parameters_list.inc:214 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "length and size of new cables required (v2.0 of the tool)" +msgstr "" + +#: ../../_files/output_parameters_list.inc:225 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Available generation technologies" +msgstr "" + +#: ../../_files/output_parameters_list.inc:227 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"List of existing technologies which could fulfill the capacity without " +"exceeding the costs" +msgstr "" + +#: ../../_files/output_parameters_list.inc:238 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Required storage" +msgstr "" + +#: ../../_files/output_parameters_list.inc:240 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"Required size to sustain peak demands for each storage technology (only " +"if storage is part of input)" +msgstr "" + +#: ../../_files/output_parameters_list.inc:251 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Connection points" +msgstr "" + +#: ../../_files/output_parameters_list.inc:253 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"Transfer interfaces with existing supply structures " +"(gas/electricity/water/wastewater)" +msgstr "" + +#: ../../_files/output_parameters_list.inc:264 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "Amortisation period of system improvements" +msgstr "" + +#: ../../_files/output_parameters_list.inc:266 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"How many months/years should one wait to get back the money invested in " +"the components/assets" +msgstr "" + +#: ../../_files/output_parameters_list.inc:277 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "List of support programmes" +msgstr "" + +#: ../../_files/output_parameters_list.inc:279 +#: ../../_files/output_parameters_list_short.inc:1 +msgid "" +"List of support programmes (government, NGO, World Bank) which criteria " +"are fulfilled by the output energy system" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/project_description.mo b/docs/locale/de/LC_MESSAGES/project_description.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/project_description.mo differ diff --git a/docs/locale/de/LC_MESSAGES/project_description.po b/docs/locale/de/LC_MESSAGES/project_description.po new file mode 100755 index 0000000..46e2dcf --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/project_description.po @@ -0,0 +1,43 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../project_description.rst:6 +msgid "About the Project" +msgstr "" + +#: ../../project_description.rst:10 +msgid "Project open_plan" +msgstr "" + +#: ../../project_description.rst:12 +msgid "" +"`Official project description (German) `_" +msgstr "" + +#: ../../project_description.rst:14 +msgid "" +"`Official project description (English) `_" +msgstr "" + +#: ../../project_description.rst:16 +msgid "To Be Created: link to open_plan website" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/tool_interface.mo b/docs/locale/de/LC_MESSAGES/tool_interface.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/tool_interface.mo differ diff --git a/docs/locale/de/LC_MESSAGES/tool_interface.po b/docs/locale/de/LC_MESSAGES/tool_interface.po new file mode 100755 index 0000000..40c2e62 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/tool_interface.po @@ -0,0 +1,2950 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../tool_interface.rst:5 +msgid "Tool interface description" +msgstr "" + +#: ../../tool_interface.rst:7 +msgid "" +"The tool should enable its users to model a local energy system (like an " +"industry park or a district) with the possibility to include sector-" +"coupling. This web-based tool is thought for planning purposes and not " +"operation. It should allow the user to optimize the energy system model " +"subject to equality constraints." +msgstr "" + +#: ../../tool_interface.rst:9 +msgid "" +"The optimization is taken care of in the backend with the `oemof " +"`_ framework. The role of the interface is thus to " +"gather the necessary input parameters and to provide a vizualization of " +"the outputs." +msgstr "" + +#: ../../tool_interface.rst:11 +msgid "" +"It is wished that this interface helps several actors with different " +"perspectives and backgrounds to run scenarios or re-run scenarios " +"changing only a few input parameters, compare their results with other " +"scenarios and possibly engage in a dialogue." +msgstr "" + +#: ../../tool_interface.rst:13 +msgid "" +"One way to fullfill this wish, is to design the tool's interface " +"collaboratively: by inviting different actors in a dialogue about the " +"interface's functionalities before implementing the interface itself." +msgstr "" + +#: ../../tool_interface.rst:15 +msgid "" +"We start by defining a few :ref:`concepts` which come " +"handy when describing the interface and what the users will be able to " +"interact with and see. One of these concepts is the :ref:`view-component-" +"def`, it is analoguous to a building block we can use to describe (and " +"then implement) the user interface functionalities in a modular way." +msgstr "" + +#: ../../tool_interface.rst:18 +msgid "" +"It is possible to deploy an interactive presentation of the :ref:`views" +"` made with the help of the :ref:`view-component-def` by " +"following `these step `_" +msgstr "" + +#: ../../tool_interface.rst:20 +msgid "We welcome feedback." +msgstr "" + +#: ../../tool_interface.rst:25 +msgid "Concepts definition" +msgstr "" + +#: ../../tool_interface.rst:27 +msgid "" +"In order to describe the interface, a few definitions are required at " +"first." +msgstr "" + +#: ../../tool_interface.rst:33 +msgid "action" +msgstr "" + +#: ../../tool_interface.rst:34 +msgid "" +"An action describes what the user can do in a certain :ref:`view-def` or " +":ref:`view-component-def`. Each action has an index which is used to link" +" it to an :ref:`attribute-def`." +msgstr "" + +#: ../../tool_interface.rst:36 +msgid "Example: [index] The user can click on button B to trigger action C" +msgstr "" + +#: ../../tool_interface.rst:42 +msgid "attribute" +msgstr "" + +#: ../../tool_interface.rst:43 +msgid "" +"An attribute contains the essential information needed to characterize " +"and render a :ref:`view-def` or a :ref:`view-component-def`. An attribute" +" might be visible in the :ref:`view-def` or :ref:`view-component-def` but" +" it can also just be information. An attribute can be linked to a certain" +" number of :ref:`action-def` and to certain :ref:`requirement-def`." +msgstr "" + +#: ../../tool_interface.rst:49 +msgid "energy type" +msgstr "" + +#: ../../tool_interface.rst:50 +msgid "" +"An energy type is represented by a bus. It describes the energy carrier " +"for an energy sector: heat, electricity, gas, biomass, H2O." +msgstr "" + +#: ../../tool_interface.rst:56 +msgid "main window" +msgstr "" + +#: ../../tool_interface.rst:57 +msgid "" +"It is the window from which the user can interact with the open_plan tool" +" on their computer." +msgstr "" + +#: ../../tool_interface.rst:63 +msgid "project" +msgstr "" + +#: ../../tool_interface.rst:64 +msgid "" +"A project is a collection of one to n scenarios regrouping all the inputs" +" and a local copy in a folder of all necessary files for the " +"optimization. A project name and a project ID must be assigned when " +"creating it. A project can also be used for a simple scenario comparison." +msgstr "" + +#: ../../tool_interface.rst:70 +msgid "requirement" +msgstr "" + +#: ../../tool_interface.rst:71 +msgid "" +"A requirement describes specific conditions that need to be met. " +"Requirements can be used for a :ref:`view-def`, a :ref:`view-component-" +"def`, an :ref:`action-def` or an :ref:`attribute-def`. Each requirement " +"has an index to link with it's :ref:`attribute-def`." +msgstr "" + +#: ../../tool_interface.rst:77 +msgid "scenario" +msgstr "" + +#: ../../tool_interface.rst:78 +msgid "" +"A scenario holds all the input data for an energy system. Once the " +"optimization is done, the ouput data will be available in the same " +"scenario." +msgstr "" + +#: ../../tool_interface.rst:84 +msgid "view" +msgstr "" + +#: ../../tool_interface.rst:85 +msgid "" +"Description of a given state of the user interface: what should the user " +"be able to interact with in that *view*, which other *view* can the user " +"visit from the current *view*. The collection of *views* form together " +"the user interface. Note: the view does not describe how the interface " +"looks like to the user, this is described in the *view-rendering*." +msgstr "" + +#: ../../tool_interface.rst:91 +msgid "view-component" +msgstr "" + +#: ../../tool_interface.rst:92 +msgid "" +"A *view-component* is a part of a *view* which can be described " +"independently from the view and could be reused in different *views* (a " +"menu bar for example). A *view-component* is described in terms of its " +"attributes and its actions. For example a menu bar has a nested list of " +"items (each item can itself be a list of item: submenus). Each item, if " +"not itself a list, consists of a label (what the user will see) and an " +"action (what will be done upon clicking/selecting the item)." +msgstr "" + +#: ../../tool_interface.rst:98 +msgid "view-rendering" +msgstr "" + +#: ../../tool_interface.rst:99 +msgid "" +"Description of how a *view* or *component-view* will be rendered on the " +"screen. This belongs to frontend and is where the details about color, " +"size, font, placement on screen matter. For example a menu bar which is a" +" *view-component* can have many different *view-rendering* (horizontal " +"with buttons, expandable vertically only on hover, etc.)." +msgstr "" + +#: ../../tool_interface.rst:105 +msgid "widget" +msgstr "" + +#: ../../tool_interface.rst:106 +msgid "" +"Smaller window within the tool's :ref:`main-window-def`. A *widget* can " +"be moved around by the user within the :ref:`main-window-def` and " +"collapsed into another *widget* (then each *widget* is accessible via " +"tabs)." +msgstr "" + +#: ../../tool_interface.rst:112 +msgid "Views definition" +msgstr "" + +#: ../../views/landing.rst:2 +msgid "Landing" +msgstr "" + +#: ../../abstract_components/project.rst:8 +#: ../../abstract_components/scenario.rst:8 +#: ../../view_components/create_project.rst:9 +#: ../../view_components/create_scenario.rst:9 +#: ../../view_components/energy_system_component.rst:9 +#: ../../view_components/energy_system_network.rst:10 +#: ../../view_components/energy_system_sector_selector.rst:9 +#: ../../view_components/export_project.rst:9 +#: ../../view_components/input_parameter_field.rst:9 +#: ../../view_components/load_input_dataseries.rst:9 +#: ../../view_components/load_project.rst:9 +#: ../../view_components/load_scenario.rst:10 +#: ../../view_components/menu_bar.rst:9 +#: ../../view_components/progression_bar.rst:14 +#: ../../view_components/project_list.rst:9 +#: ../../view_components/project_location.rst:11 +#: ../../view_components/project_parameters.rst:10 +#: ../../view_components/read_write_files.rst:9 +#: ../../view_components/scenario_list.rst:9 +#: ../../view_components/scenario_parameters.rst:9 +#: ../../view_components/view_specific_documentation.rst:9 +#: ../../view_components/visualize_dataseries.rst:9 +#: ../../view_components/welcome.rst:10 ../../views/landing.rst:5 +#: ../../views/scenario_comparison.rst:7 +msgid "Attributes" +msgstr "" + +#: ../../views/landing.rst:6 +msgid "There are no attributes specific to the landing view." +msgstr "" + +#: ../../views/landing.rst:9 ../../views/scenario_comparison.rst:17 +msgid "Active view-components" +msgstr "" + +#: ../../view_components/create_scenario.rst:71 +#: ../../view_components/load_scenario.rst:70 +#: ../../view_components/progression_bar.rst:61 +#: ../../view_components/welcome.rst:59 ../../views/landing.rst:11 +#: ../../views/scenario_comparison.rst:19 +msgid ":ref:`menu_bar-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:89 ../../views/landing.rst:12 +msgid ":ref:`progression_bar-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:87 +#: ../../view_components/view_specific_documentation.rst:53 +#: ../../views/landing.rst:13 +msgid ":ref:`welcome-label`" +msgstr "" + +#: ../../abstract_components/project.rst:16 +#: ../../abstract_components/scenario.rst:15 +#: ../../view_components/create_project.rst:42 +#: ../../view_components/create_scenario.rst:35 +#: ../../view_components/energy_system_component.rst:46 +#: ../../view_components/energy_system_network.rst:95 +#: ../../view_components/energy_system_sector_selector.rst:36 +#: ../../view_components/export_project.rst:42 +#: ../../view_components/input_parameter_field.rst:75 +#: ../../view_components/load_input_dataseries.rst:43 +#: ../../view_components/load_project.rst:42 +#: ../../view_components/load_scenario.rst:35 +#: ../../view_components/menu_bar.rst:42 +#: ../../view_components/progression_bar.rst:40 +#: ../../view_components/project_list.rst:26 +#: ../../view_components/project_location.rst:21 +#: ../../view_components/project_parameters.rst:41 +#: ../../view_components/read_write_files.rst:40 +#: ../../view_components/scenario_list.rst:24 +#: ../../view_components/scenario_parameters.rst:26 +#: ../../view_components/view_specific_documentation.rst:34 +#: ../../view_components/visualize_dataseries.rst:23 +#: ../../view_components/welcome.rst:34 ../../views/landing.rst:17 +#: ../../views/scenario_comparison.rst:22 +msgid "Actions" +msgstr "" + +#: ../../views/landing.rst:18 +msgid "" +"There are no actions specific to the landing view, the possible actions " +"are already defined in the various view-components" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:42 +#: ../../view_components/menu_bar.rst:73 +#: ../../view_components/progression_bar.rst:46 +#: ../../view_components/project_parameters.rst:47 +#: ../../view_components/scenario_parameters.rst:32 +#: ../../view_components/welcome.rst:41 ../../views/landing.rst:21 +#: ../../views/scenario_comparison.rst:47 +msgid "Requirement" +msgstr "" + +#: ../../views/landing.rst:22 +msgid "" +"the very first time the user sees this view, the :ref:`welcome-label` " +"view-component should be displayed (popup, or integrated to the view)" +msgstr "" + +#: ../../view_components/welcome.rst:47 ../../views/landing.rst:25 +#: ../../views/scenario_comparison.rst:51 +msgid "Link with other views" +msgstr "" + +#: ../../views/landing.rst:26 +msgid "TBD" +msgstr "" + +#: ../../views/landing.rst:29 ../../views/scenario_comparison.rst:54 +msgid "Rendering of the view" +msgstr "" + +#: ../../views/landing.rst:30 +msgid "There are currently 2 types of rendering proposed:" +msgstr "" + +#: ../../views/landing.rst:33 +msgid "minimalistic:" +msgstr "" + +#: ../../views/landing.rst:33 +msgid "The user is only prompted to \"build your own energy cell\"" +msgstr "" + +#: ../../views/landing.rst:36 +msgid "expert mode:" +msgstr "" + +#: ../../views/landing.rst:36 +msgid "Most of the menu and flow charts are displayed in widget windows" +msgstr "" + +#: ../../views/scenario_comparison.rst:2 +msgid "Scenario Comparison" +msgstr "" + +#: ../../views/scenario_comparison.rst:4 +msgid "" +"*The output comparable on the \"scenario comparison view\" will be " +"determine with oemof and the input/output excel file*" +msgstr "" + +#: ../../views/scenario_comparison.rst:8 ../../views/scenario_comparison.rst:23 +msgid "**List of scenarios**" +msgstr "" + +#: ../../views/scenario_comparison.rst:10 +#: ../../views/scenario_comparison.rst:27 +msgid "**Different comparison points**" +msgstr "" + +#: ../../views/scenario_comparison.rst:12 +msgid "Technical" +msgstr "" + +#: ../../views/scenario_comparison.rst:13 +msgid "Financial" +msgstr "" + +#: ../../views/scenario_comparison.rst:14 +msgid "Ecological" +msgstr "" + +#: ../../views/scenario_comparison.rst:25 +msgid "The user can select which scenario he would like to compare." +msgstr "" + +#: ../../views/scenario_comparison.rst:29 +msgid "Technical: Based on the technical output of the simulation" +msgstr "" + +#: ../../views/scenario_comparison.rst:30 +msgid "Financial: Based on the financial output of the simulation" +msgstr "" + +#: ../../views/scenario_comparison.rst:31 +msgid "Ecological: Based on the ecological output of the simulation" +msgstr "" + +#: ../../views/scenario_comparison.rst:33 +msgid "**Save comparison**" +msgstr "" + +#: ../../views/scenario_comparison.rst:35 +msgid "Allows the user to save their comparison in the tool." +msgstr "" + +#: ../../views/scenario_comparison.rst:36 +msgid "" +"Makes a pop up appear where the user has to select a name for his " +"comparison." +msgstr "" + +#: ../../views/scenario_comparison.rst:38 +msgid "**Export comparison**" +msgstr "" + +#: ../../views/scenario_comparison.rst:40 +msgid "" +"Allows the user to save his comparison in different format (PDF, csv, " +"...?)" +msgstr "" + +#: ../../views/scenario_comparison.rst:42 +msgid "**Import scenario**" +msgstr "" + +#: ../../views/scenario_comparison.rst:44 +msgid "Allows the user to import one or more scenario" +msgstr "" + +#: ../../views/scenario_comparison.rst:56 +msgid "**Two possible views**" +msgstr "" + +#: ../../views/scenario_comparison.rst:58 +msgid "As a table" +msgstr "" + +#: ../../views/scenario_comparison.rst:59 +msgid "As a plot" +msgstr "" + +#: ../../tool_interface.rst:133 +msgid "View-components definition" +msgstr "" + +#: ../../view_components/welcome.rst:4 +msgid "Welcome page" +msgstr "" + +#: ../../view_components/welcome.rst:6 +msgid "" +"This view-component is an introduction for the first-time users. It " +"describes what they can expect from the tool." +msgstr "" + +#: ../../view_components/welcome.rst:13 +msgid "**Welcome message**" +msgstr "" + +#: ../../view_components/welcome.rst:13 +msgid "A text" +msgstr "" + +#: ../../view_components/welcome.rst:17 +msgid "**Video intro message**" +msgstr "" + +#: ../../view_components/welcome.rst:16 +msgid "" +"A short, 3 minute video clip that provides the important information such" +" as tool features, capabilities, where to find help, etc., very briefly." +msgstr "" + +#: ../../view_components/welcome.rst:17 +msgid "" +"This clip is embedded into the welcome pop-up. The user can view it on " +"YouTube (or Vimeo) on a separate tab of the browser by clicking on a link" +" on the video." +msgstr "" + +#: ../../view_components/welcome.rst:22 +msgid "**List of Hyperlinks**" +msgstr "" + +#: ../../view_components/welcome.rst:20 +msgid "" +"Clickable links to read more, documentation, examples, use-cases, video " +"tutorials, code-base (GitHub repo) and contact us." +msgstr "" + +#: ../../view_components/welcome.rst:22 +msgid "Action index: 1" +msgstr "" + +#: ../../view_components/welcome.rst:31 +msgid "**Check-box: do not show again**" +msgstr "" + +#: ../../view_components/welcome.rst:25 +msgid "" +"Disable/enable the display of the welcome view-component when tool is " +"started." +msgstr "" + +#: ../../view_components/create_project.rst:19 +#: ../../view_components/create_project.rst:33 +#: ../../view_components/energy_system_component.rst:29 +#: ../../view_components/energy_system_network.rst:18 +#: ../../view_components/energy_system_network.rst:29 +#: ../../view_components/energy_system_network.rst:40 +#: ../../view_components/energy_system_network.rst:50 +#: ../../view_components/energy_system_network.rst:59 +#: ../../view_components/energy_system_network.rst:69 +#: ../../view_components/energy_system_network.rst:80 +#: ../../view_components/energy_system_network.rst:92 +#: ../../view_components/energy_system_sector_selector.rst:17 +#: ../../view_components/energy_system_sector_selector.rst:25 +#: ../../view_components/energy_system_sector_selector.rst:33 +#: ../../view_components/export_project.rst:19 +#: ../../view_components/export_project.rst:33 +#: ../../view_components/input_parameter_field.rst:60 +#: ../../view_components/load_project.rst:19 +#: ../../view_components/load_project.rst:33 +#: ../../view_components/progression_bar.rst:29 +#: ../../view_components/read_write_files.rst:17 +#: ../../view_components/read_write_files.rst:31 +#: ../../view_components/visualize_dataseries.rst:14 +#: ../../view_components/visualize_dataseries.rst:20 +#: ../../view_components/welcome.rst:29 +msgid "Properties:" +msgstr "" + +#: ../../view_components/welcome.rst:28 +msgid "id `cb_welcome_show_again`" +msgstr "" + +#: ../../view_components/welcome.rst:29 +msgid "unticked by default" +msgstr "" + +#: ../../view_components/welcome.rst:31 +msgid "Action index: 2" +msgstr "" + +#: ../../view_components/welcome.rst:36 +msgid "" +"Clicking on the hyperlinks will open the respective topic in separate " +"tabs of the browser." +msgstr "" + +#: ../../view_components/welcome.rst:37 +msgid "" +"Checking the `Do not show again` check-box would disable the display of " +"this view component everytime the software is launched." +msgstr "" + +#: ../../view_components/welcome.rst:38 +msgid "" +"The user can close the welcome window by clicking the :guilabel:`&X` " +"button in the top right corner." +msgstr "" + +#: ../../view_components/welcome.rst:43 +msgid "" +"By default, the welcome view-component should be displayed to the user " +"everytime the software is started." +msgstr "" + +#: ../../view_components/welcome.rst:44 +msgid "" +"If the user ticks the check-box *Do not show again*, the welcome view-" +"component should not appear to the user during any subsequent launch of " +"the tool." +msgstr "" + +#: ../../view_components/welcome.rst:49 +msgid "" +"This window is displayed by default on top of everything every time the " +"tool is launched." +msgstr "" + +#: ../../abstract_components/project.rst:37 +#: ../../abstract_components/scenario.rst:36 +#: ../../view_components/create_project.rst:73 +#: ../../view_components/create_scenario.rst:66 +#: ../../view_components/energy_system_component.rst:69 +#: ../../view_components/energy_system_network.rst:113 +#: ../../view_components/energy_system_sector_selector.rst:48 +#: ../../view_components/export_project.rst:73 +#: ../../view_components/input_parameter_field.rst:95 +#: ../../view_components/load_input_dataseries.rst:69 +#: ../../view_components/load_project.rst:73 +#: ../../view_components/load_scenario.rst:65 +#: ../../view_components/menu_bar.rst:84 +#: ../../view_components/progression_bar.rst:59 +#: ../../view_components/project_list.rst:54 +#: ../../view_components/project_location.rst:41 +#: ../../view_components/project_parameters.rst:51 +#: ../../view_components/read_write_files.rst:71 +#: ../../view_components/scenario_list.rst:48 +#: ../../view_components/scenario_parameters.rst:36 +#: ../../view_components/view_specific_documentation.rst:50 +#: ../../view_components/visualize_dataseries.rst:41 +#: ../../view_components/welcome.rst:53 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/create_scenario.rst:57 +#: ../../view_components/load_scenario.rst:57 +#: ../../view_components/progression_bar.rst:56 +#: ../../view_components/project_list.rst:51 +#: ../../view_components/welcome.rst:55 +msgid ":ref:`landing-label`" +msgstr "" + +#: ../../view_components/welcome.rst:59 +msgid "" +"The user can later re-enable the appearance of the welcome view-" +"component by clicking *Display welcome view* in *Preferences* from the " +"menu." +msgstr "" + +#: ../../view_components/create_project.rst:83 +#: ../../view_components/create_scenario.rst:74 +#: ../../view_components/energy_system_component.rst:75 +#: ../../view_components/energy_system_network.rst:117 +#: ../../view_components/energy_system_sector_selector.rst:54 +#: ../../view_components/export_project.rst:83 +#: ../../view_components/input_parameter_field.rst:102 +#: ../../view_components/load_input_dataseries.rst:82 +#: ../../view_components/load_project.rst:83 +#: ../../view_components/load_scenario.rst:73 +#: ../../view_components/menu_bar.rst:99 +#: ../../view_components/progression_bar.rst:65 +#: ../../view_components/project_list.rst:64 +#: ../../view_components/project_location.rst:47 +#: ../../view_components/project_parameters.rst:54 +#: ../../view_components/read_write_files.rst:81 +#: ../../view_components/scenario_list.rst:57 +#: ../../view_components/scenario_parameters.rst:39 +#: ../../view_components/view_specific_documentation.rst:68 +#: ../../view_components/visualize_dataseries.rst:48 +#: ../../view_components/welcome.rst:62 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/welcome.rst:63 +msgid "" +"This view-component could be either a popup on top of the :ref:`landing-" +"view`, :ref:`widget-def` in the landing view or a :ref:`view-def` on its " +"own." +msgstr "" + +#: ../../view_components/welcome.rst:65 +msgid "" +"The welcome message should be centered and not contain very long text, " +"but rather bullet points with links to more detailed documentation. The " +"video should be placed on the top left of the view-component and start " +"automatically without the sound." +msgstr "" + +#: ../../view_components/welcome.rst:67 +msgid "Below the welcome message the hyperlinks could be listed and centered." +msgstr "" + +#: ../../view_components/welcome.rst:69 +msgid "" +"The *Do not show again* check-box can be displayed on the bottom of the " +"view-component (bottom-left?) with larger fontsize such that the user " +"cannot miss it. It should be unticked by default." +msgstr "" + +#: ../../view_components/progression_bar.rst:4 +msgid "Progression Bar" +msgstr "" + +#: ../../view_components/progression_bar.rst:6 +msgid "" +"The Progression Bar displays the sequential steps the user should go " +"through, in order to provide the input parameters required to describe an" +" energy system and a :ref:`scenario-label` to simulate with this energy " +"system model" +msgstr "" + +#: ../../view_components/progression_bar.rst:8 +msgid "This view-component allows the user to:" +msgstr "" + +#: ../../view_components/progression_bar.rst:10 +msgid "" +"Sequentially progress through the modeling and definition of their :ref" +":`scenario-label`" +msgstr "" + +#: ../../view_components/progression_bar.rst:11 +msgid "Jump directly to previous steps to edit input parameters" +msgstr "" + +#: ../../view_components/progression_bar.rst:31 +msgid "**List of steps**" +msgstr "" + +#: ../../view_components/progression_bar.rst:17 +msgid "For example the following steps:" +msgstr "" + +#: ../../view_components/progression_bar.rst:19 +msgid "Project Setup" +msgstr "" + +#: ../../view_components/progression_bar.rst:20 +msgid "Inputs" +msgstr "" + +#: ../../view_components/progression_bar.rst:21 +msgid "System Inputs" +msgstr "" + +#: ../../view_components/progression_bar.rst:22 +msgid "Visualization" +msgstr "" + +#: ../../view_components/progression_bar.rst:23 +msgid "Constraints" +msgstr "" + +#: ../../view_components/progression_bar.rst:24 +msgid "Simulations" +msgstr "" + +#: ../../view_components/progression_bar.rst:25 +msgid "Results" +msgstr "" + +#: ../../view_components/progression_bar.rst:28 +msgid "" +"Each step has an associated index (starting from 1), corresponding to its" +" position in the list of steps" +msgstr "" + +#: ../../view_components/progression_bar.rst:29 +msgid "Each step in the progression bar is a link to a :ref:`view `" +msgstr "" + +#: ../../view_components/progression_bar.rst:31 +msgid "Actions index: 1, 2" +msgstr "" + +#: ../../view_components/progression_bar.rst:37 +msgid "**Current step index**" +msgstr "" + +#: ../../view_components/progression_bar.rst:34 +msgid "The index of the currently selected step" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:18 +#: ../../view_components/input_parameter_field.rst:44 +#: ../../view_components/progression_bar.rst:36 +#: ../../view_components/project_location.rst:18 +msgid "Requirements index: 1" +msgstr "" + +#: ../../view_components/progression_bar.rst:42 +msgid "" +"Clicking on a step that has already been fulfilled, allows the user to " +"make modifications to the inputs within this field" +msgstr "" + +#: ../../view_components/progression_bar.rst:43 +msgid "" +"Clicking on a step which is disabled, make a small text bubble appear " +"next to the step explaining why the user cannot click on that step" +msgstr "" + +#: ../../view_components/progression_bar.rst:48 +msgid "" +"To enable the next step, the user has to fulfill the requirements of the " +"current step. Each step's requirements are defined in its respective " +":ref:`view `" +msgstr "" + +#: ../../abstract_components/project.rst:31 +#: ../../abstract_components/scenario.rst:30 +#: ../../view_components/create_project.rst:63 +#: ../../view_components/create_scenario.rst:52 +#: ../../view_components/energy_system_component.rst:64 +#: ../../view_components/export_project.rst:63 +#: ../../view_components/input_parameter_field.rst:90 +#: ../../view_components/load_input_dataseries.rst:60 +#: ../../view_components/load_project.rst:63 +#: ../../view_components/load_scenario.rst:52 +#: ../../view_components/menu_bar.rst:78 +#: ../../view_components/progression_bar.rst:51 +#: ../../view_components/project_list.rst:47 +#: ../../view_components/project_location.rst:31 +#: ../../view_components/read_write_files.rst:61 +#: ../../view_components/scenario_list.rst:44 +#: ../../view_components/view_specific_documentation.rst:46 +#: ../../view_components/visualize_dataseries.rst:32 +msgid "Link with views" +msgstr "" + +#: ../../view_components/progression_bar.rst:53 +msgid "Here will be a link to the views of each steps" +msgstr "" + +#: ../../view_components/progression_bar.rst:56 +msgid "" +"It is not sure yet whether this view-component should be visible from " +"start, join the on-going discussion `here `_" +msgstr "" + +#: ../../view_components/progression_bar.rst:67 +msgid "" +"Ribbon-like display of the progression bar where each step is delimited " +"by an individual blob, the structure is identical throughout the " +"different views. The term blob is employed to signify that the shape is " +"up to a decision (non-exhaustive list of examples: a rectangle, an " +"ellipse, a circle, an arrow)" +msgstr "" + +#: ../../view_components/progression_bar.rst:68 +msgid "" +"Indication of the steps order could be with arrow shaped blob, or with " +"arrow symbols between the blobs" +msgstr "" + +#: ../../view_components/progression_bar.rst:69 +msgid "" +"Color coding of the blobs backgrounds can be used to indicate whether the" +" step has already be visited, is not fulfilled yet, disabled or enabled" +msgstr "" + +#: ../../view_components/progression_bar.rst:70 +msgid "" +"The progression bar could be horizontal or vertical (it is assumed from " +"left to right and top to bottom, but this can be debated)" +msgstr "" + +#: ../../view_components/progression_bar.rst:72 +msgid "" +"Here is an example of one possible rendering, please note that this is " +"not a final design, only an example" +msgstr "" + +#: ../../view_components/menu_bar.rst:4 +msgid "Menu Bar" +msgstr "" + +#: ../../view_components/menu_bar.rst:6 +msgid "Menu bar is a set of options linked to actions, or submenus." +msgstr "" + +#: ../../view_components/menu_bar.rst:14 +msgid "**The following are the menus available in the menu bar:**" +msgstr "" + +#: ../../view_components/menu_bar.rst:12 ../../view_components/menu_bar.rst:51 +msgid "File" +msgstr "" + +#: ../../view_components/menu_bar.rst:13 ../../view_components/menu_bar.rst:57 +msgid "Scenarios" +msgstr "" + +#: ../../view_components/menu_bar.rst:14 ../../view_components/menu_bar.rst:61 +msgid "Preferences" +msgstr "" + +#: ../../view_components/menu_bar.rst:15 ../../view_components/menu_bar.rst:70 +msgid "Help" +msgstr "" + +#: ../../view_components/menu_bar.rst:21 +msgid "***File* has the following submenus or options:**" +msgstr "" + +#: ../../view_components/load_project.rst:4 +#: ../../view_components/menu_bar.rst:17 ../../view_components/menu_bar.rst:47 +msgid "Load project" +msgstr "" + +#: ../../view_components/menu_bar.rst:18 ../../view_components/menu_bar.rst:48 +msgid "New project" +msgstr "" + +#: ../../view_components/menu_bar.rst:19 ../../view_components/menu_bar.rst:49 +msgid "Save project" +msgstr "" + +#: ../../view_components/menu_bar.rst:20 ../../view_components/menu_bar.rst:50 +msgid "Save project as" +msgstr "" + +#: ../../view_components/export_project.rst:4 +#: ../../view_components/menu_bar.rst:21 +msgid "Export project" +msgstr "" + +#: ../../view_components/menu_bar.rst:22 ../../view_components/menu_bar.rst:52 +msgid "Exit open_plan" +msgstr "" + +#: ../../view_components/menu_bar.rst:27 +msgid "***Scenarios* has the following submenus:**" +msgstr "" + +#: ../../view_components/menu_bar.rst:24 +msgid "New scenario" +msgstr "" + +#: ../../view_components/menu_bar.rst:25 +msgid "Load scenario" +msgstr "" + +#: ../../view_components/menu_bar.rst:26 +msgid "Compare scenarios" +msgstr "" + +#: ../../view_components/menu_bar.rst:27 ../../view_components/menu_bar.rst:57 +msgid "---- (separating horizontal line)" +msgstr "" + +#: ../../view_components/menu_bar.rst:28 ../../view_components/menu_bar.rst:58 +msgid "List of scenarios in the system" +msgstr "" + +#: ../../view_components/menu_bar.rst:31 +msgid "***Preferences* has the following submenus:**" +msgstr "" + +#: ../../view_components/menu_bar.rst:30 +msgid "Language" +msgstr "" + +#: ../../view_components/menu_bar.rst:31 ../../view_components/menu_bar.rst:61 +msgid "Display" +msgstr "" + +#: ../../view_components/menu_bar.rst:32 +msgid "Display welcome view" +msgstr "" + +#: ../../view_components/menu_bar.rst:39 +msgid "***Help* has the following submenus:**" +msgstr "" + +#: ../../view_components/menu_bar.rst:34 +msgid "Read documentation" +msgstr "" + +#: ../../view_components/menu_bar.rst:35 +msgid "Examples and use cases" +msgstr "" + +#: ../../view_components/menu_bar.rst:36 +msgid "Contact developers" +msgstr "" + +#: ../../view_components/menu_bar.rst:37 +msgid "Feedback" +msgstr "" + +#: ../../view_components/menu_bar.rst:38 +msgid "License information" +msgstr "" + +#: ../../view_components/menu_bar.rst:39 +msgid "About open_plan..." +msgstr "" + +#: ../../view_components/menu_bar.rst:44 +msgid "" +"Clicking on any of the menus' option results in a drop-down list of sub-" +"menu's options if applicable, otherwise trigger an action" +msgstr "" + +#: ../../view_components/menu_bar.rst:51 +msgid "Export project: display :ref:`export_project-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:54 +msgid "New scenario: display :ref:`create_scenario-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:55 +msgid "Load scenario: display :ref:`load_scenario-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:56 +msgid "Compare scenarios: display view :ref:`scenario_comparison-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:60 +msgid "Language: not sure whether this will be implemented" +msgstr "" + +#: ../../view_components/menu_bar.rst:62 +msgid "Display welcome view: display :ref:`welcome-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:64 +msgid "" +"Read documentation: redirect to `ReadTheDocs documentation `_" +msgstr "" + +#: ../../view_components/menu_bar.rst:65 +msgid "Examples and use cases: redirect to ReadTheDocs usecases TODO: add link" +msgstr "" + +#: ../../view_components/menu_bar.rst:66 +msgid "" +"Contact developers: redirect to `Github issues `_" +msgstr "" + +#: ../../view_components/menu_bar.rst:67 +msgid "" +"Feedback redirect to `Github issues `_" +msgstr "" + +#: ../../view_components/menu_bar.rst:68 +msgid "" +"License information: redirect to `Github license `_" +msgstr "" + +#: ../../view_components/menu_bar.rst:69 +msgid "About open_plan...: redirect to open_plan website TODO: add link" +msgstr "" + +#: ../../view_components/menu_bar.rst:75 +msgid "" +"The menu/submenu's options that are not applicable are greyed out or " +"inactive and thus, nothing happens when clicked upon" +msgstr "" + +#: ../../view_components/menu_bar.rst:80 +msgid ":ref:`scenario_comparison-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:87 +msgid "" +"The welcome view-component can be re-enabled if it was disabled by the " +"user from appearing everytime the tool is launched." +msgstr "" + +#: ../../view_components/menu_bar.rst:91 +msgid ":ref:`export_project-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:93 +msgid ":ref:`create_scenario-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:95 +msgid ":ref:`load_scenario-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:101 +msgid "" +"Rectangular drop-down menu buttons present on a horizontal bar on top of " +"the :ref:`main-window-def`" +msgstr "" + +#: ../../view_components/menu_bar.rst:102 +msgid "Rendered on every view of the tool UI" +msgstr "" + +#: ../../view_components/menu_bar.rst:103 +msgid "" +"The current scenario is highlighted in the drop-down list which results " +"when the *Scenarios* menu is clicked" +msgstr "" + +#: ../../view_components/create_project.rst:4 +msgid "Create project" +msgstr "" + +#: ../../view_components/create_project.rst:6 +#: ../../view_components/export_project.rst:6 +#: ../../view_components/load_project.rst:6 +msgid "This is not described yet" +msgstr "" + +#: ../../view_components/create_project.rst:23 +#: ../../view_components/export_project.rst:23 +#: ../../view_components/load_project.rst:23 +#: ../../view_components/read_write_files.rst:21 +msgid "**Attribute A**" +msgstr "" + +#: ../../view_components/create_project.rst:14 +#: ../../view_components/create_project.rst:28 +#: ../../view_components/export_project.rst:14 +#: ../../view_components/export_project.rst:28 +#: ../../view_components/load_project.rst:14 +#: ../../view_components/load_project.rst:28 +#: ../../view_components/read_write_files.rst:12 +#: ../../view_components/read_write_files.rst:26 +msgid "Description" +msgstr "" + +#: ../../view_components/create_project.rst:17 +#: ../../view_components/create_project.rst:31 +#: ../../view_components/export_project.rst:17 +#: ../../view_components/export_project.rst:31 +#: ../../view_components/load_project.rst:17 +#: ../../view_components/load_project.rst:31 +#: ../../view_components/read_write_files.rst:15 +#: ../../view_components/read_write_files.rst:29 +msgid "Property 1" +msgstr "" + +#: ../../view_components/create_project.rst:18 +#: ../../view_components/create_project.rst:32 +#: ../../view_components/export_project.rst:18 +#: ../../view_components/export_project.rst:32 +#: ../../view_components/load_project.rst:18 +#: ../../view_components/load_project.rst:32 +#: ../../view_components/read_write_files.rst:16 +#: ../../view_components/read_write_files.rst:30 +msgid "..." +msgstr "" + +#: ../../view_components/create_project.rst:19 +#: ../../view_components/create_project.rst:33 +#: ../../view_components/export_project.rst:19 +#: ../../view_components/export_project.rst:33 +#: ../../view_components/load_project.rst:19 +#: ../../view_components/load_project.rst:33 +#: ../../view_components/read_write_files.rst:17 +#: ../../view_components/read_write_files.rst:31 +msgid "Property n" +msgstr "" + +#: ../../view_components/create_project.rst:21 +#: ../../view_components/create_project.rst:35 +#: ../../view_components/energy_system_component.rst:31 +#: ../../view_components/export_project.rst:21 +#: ../../view_components/export_project.rst:35 +#: ../../view_components/load_project.rst:21 +#: ../../view_components/load_project.rst:35 +#: ../../view_components/read_write_files.rst:19 +#: ../../view_components/read_write_files.rst:33 +msgid "Actions index:" +msgstr "" + +#: ../../view_components/create_project.rst:23 +#: ../../view_components/create_project.rst:37 +#: ../../view_components/energy_system_component.rst:33 +#: ../../view_components/energy_system_network.rst:22 +#: ../../view_components/energy_system_network.rst:33 +#: ../../view_components/energy_system_network.rst:44 +#: ../../view_components/energy_system_network.rst:63 +#: ../../view_components/energy_system_network.rst:73 +#: ../../view_components/energy_system_network.rst:84 +#: ../../view_components/export_project.rst:23 +#: ../../view_components/export_project.rst:37 +#: ../../view_components/load_input_dataseries.rst:18 +#: ../../view_components/load_input_dataseries.rst:30 +#: ../../view_components/load_input_dataseries.rst:35 +#: ../../view_components/load_project.rst:23 +#: ../../view_components/load_project.rst:37 +#: ../../view_components/read_write_files.rst:21 +#: ../../view_components/read_write_files.rst:35 +#: ../../view_components/view_specific_documentation.rst:16 +#: ../../view_components/view_specific_documentation.rst:31 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/create_project.rst:37 +#: ../../view_components/export_project.rst:37 +#: ../../view_components/load_project.rst:37 +#: ../../view_components/read_write_files.rst:35 +msgid "**Attribute B**" +msgstr "" + +#: ../../view_components/create_project.rst:47 +#: ../../view_components/export_project.rst:47 +#: ../../view_components/load_project.rst:47 +#: ../../view_components/project_list.rst:31 +#: ../../view_components/read_write_files.rst:45 +msgid "Action 1" +msgstr "" + +#: ../../view_components/create_project.rst:48 +#: ../../view_components/export_project.rst:48 +#: ../../view_components/load_project.rst:48 +#: ../../view_components/project_list.rst:32 +#: ../../view_components/read_write_files.rst:46 +msgid "Action 2" +msgstr "" + +#: ../../abstract_components/project.rst:24 +#: ../../abstract_components/scenario.rst:23 +#: ../../view_components/create_project.rst:51 +#: ../../view_components/create_scenario.rst:42 +#: ../../view_components/energy_system_component.rst:51 +#: ../../view_components/energy_system_network.rst:105 +#: ../../view_components/export_project.rst:51 +#: ../../view_components/input_parameter_field.rst:82 +#: ../../view_components/load_input_dataseries.rst:51 +#: ../../view_components/load_project.rst:51 +#: ../../view_components/load_scenario.rst:42 +#: ../../view_components/project_list.rst:35 +#: ../../view_components/project_location.rst:26 +#: ../../view_components/read_write_files.rst:49 +#: ../../view_components/scenario_list.rst:32 +#: ../../view_components/view_specific_documentation.rst:41 +#: ../../view_components/visualize_dataseries.rst:27 +msgid "Requirements" +msgstr "" + +#: ../../view_components/create_project.rst:59 +#: ../../view_components/export_project.rst:59 +#: ../../view_components/load_project.rst:59 +#: ../../view_components/project_list.rst:43 +#: ../../view_components/read_write_files.rst:57 +#: ../../view_components/scenario_list.rst:40 +msgid "Requirement 1" +msgstr "" + +#: ../../view_components/create_project.rst:60 +#: ../../view_components/export_project.rst:60 +#: ../../view_components/load_project.rst:60 +#: ../../view_components/project_list.rst:44 +#: ../../view_components/read_write_files.rst:58 +#: ../../view_components/scenario_list.rst:41 +msgid "Requirement 2" +msgstr "" + +#: ../../view_components/create_project.rst:67 +#: ../../view_components/create_scenario.rst:63 +#: ../../view_components/export_project.rst:67 +#: ../../view_components/load_input_dataseries.rst:63 +#: ../../view_components/load_project.rst:67 +#: ../../view_components/load_scenario.rst:62 +#: ../../view_components/read_write_files.rst:65 +#: ../../view_components/visualize_dataseries.rst:35 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/create_project.rst:67 +#: ../../view_components/create_project.rst:70 +#: ../../view_components/create_project.rst:77 +#: ../../view_components/create_project.rst:80 +#: ../../view_components/export_project.rst:67 +#: ../../view_components/export_project.rst:70 +#: ../../view_components/export_project.rst:77 +#: ../../view_components/export_project.rst:80 +#: ../../view_components/load_input_dataseries.rst:63 +#: ../../view_components/load_input_dataseries.rst:66 +#: ../../view_components/load_project.rst:67 +#: ../../view_components/load_project.rst:70 +#: ../../view_components/load_project.rst:77 +#: ../../view_components/load_project.rst:80 +#: ../../view_components/project_location.rst:38 +#: ../../view_components/project_location.rst:44 +#: ../../view_components/read_write_files.rst:65 +#: ../../view_components/read_write_files.rst:68 +#: ../../view_components/read_write_files.rst:75 +#: ../../view_components/read_write_files.rst:78 +#: ../../view_components/view_specific_documentation.rst:59 +#: ../../view_components/visualize_dataseries.rst:35 +#: ../../view_components/visualize_dataseries.rst:38 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/create_project.rst:70 +#: ../../view_components/export_project.rst:70 +#: ../../view_components/load_input_dataseries.rst:66 +#: ../../view_components/load_project.rst:70 +#: ../../view_components/read_write_files.rst:68 +#: ../../view_components/visualize_dataseries.rst:38 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/create_project.rst:77 +#: ../../view_components/export_project.rst:77 +#: ../../view_components/load_project.rst:77 +#: ../../view_components/project_location.rst:44 +#: ../../view_components/read_write_files.rst:75 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/create_project.rst:80 +#: ../../view_components/export_project.rst:80 +#: ../../view_components/load_input_dataseries.rst:76 +#: ../../view_components/load_project.rst:80 +#: ../../view_components/read_write_files.rst:78 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/create_scenario.rst:4 +msgid "Create Scenario" +msgstr "" + +#: ../../view_components/create_scenario.rst:6 +msgid "" +"This view-component enables the user to create a new :ref:`scenario-" +"label`." +msgstr "" + +#: ../../view_components/create_scenario.rst:16 +#: ../../view_components/load_scenario.rst:17 +msgid "**Scenario name text input**" +msgstr "" + +#: ../../view_components/create_scenario.rst:12 +msgid "The user can provide a file path for the scenario they want to create" +msgstr "" + +#: ../../view_components/create_scenario.rst:14 +#: ../../view_components/input_parameter_field.rst:62 +#: ../../view_components/input_parameter_field.rst:67 +#: ../../view_components/load_input_dataseries.rst:28 +#: ../../view_components/load_scenario.rst:15 +#: ../../view_components/view_specific_documentation.rst:21 +msgid "Actions index: 2" +msgstr "" + +#: ../../view_components/create_scenario.rst:16 +#: ../../view_components/create_scenario.rst:23 +#: ../../view_components/load_scenario.rst:17 +#: ../../view_components/load_scenario.rst:24 +msgid "Requirements index: 1, 2, 3" +msgstr "" + +#: ../../view_components/create_scenario.rst:24 +#: ../../view_components/load_scenario.rst:25 +msgid "**button** :guilabel:`&Browse`" +msgstr "" + +#: ../../view_components/create_scenario.rst:19 +#: ../../view_components/load_scenario.rst:20 +msgid "" +"Triggers the selection the scenario name text input via a graphical file " +"structure" +msgstr "" + +#: ../../view_components/create_scenario.rst:21 +#: ../../view_components/input_parameter_field.rst:49 +#: ../../view_components/load_input_dataseries.rst:16 +#: ../../view_components/load_input_dataseries.rst:23 +#: ../../view_components/load_scenario.rst:22 +#: ../../view_components/project_location.rst:16 +#: ../../view_components/view_specific_documentation.rst:14 +msgid "Actions index: 1" +msgstr "" + +#: ../../view_components/create_scenario.rst:32 +msgid "**button** :guilabel:`&Create`" +msgstr "" + +#: ../../view_components/create_scenario.rst:27 +#: ../../view_components/load_scenario.rst:28 +msgid "The user triggers the creation of the scenario" +msgstr "" + +#: ../../view_components/create_scenario.rst:29 +#: ../../view_components/input_parameter_field.rst:54 +#: ../../view_components/load_input_dataseries.rst:33 +#: ../../view_components/load_scenario.rst:30 +#: ../../view_components/view_specific_documentation.rst:29 +msgid "Actions index: 3" +msgstr "" + +#: ../../view_components/create_scenario.rst:31 +#: ../../view_components/load_scenario.rst:32 +msgid "Requirements index: 4, 5, 6" +msgstr "" + +#: ../../view_components/create_scenario.rst:37 +#: ../../view_components/load_scenario.rst:37 +msgid "" +"User can navigate through the file system either graphically to input " +"scenario name by clicking on :guilabel:`&Browse`" +msgstr "" + +#: ../../view_components/create_scenario.rst:38 +#: ../../view_components/load_scenario.rst:38 +msgid "User can input scenario name in the input text" +msgstr "" + +#: ../../view_components/create_scenario.rst:39 +msgid "" +"After clicking on :guilabel:`&Create`, a scenario is created in the " +"backend, in the file system and the user is redirected to the view " +"corresponding to the first step in the :ref:`progression_bar-label`" +msgstr "" + +#: ../../view_components/create_scenario.rst:44 +msgid "" +"If user only provided a name and not a file path, then the scenario " +"file/folder is created in a default location" +msgstr "" + +#: ../../view_components/create_scenario.rst:45 +msgid "" +"If user provided a scenario file/folder path which does not exist yet, " +"the missing folders in the path should be created" +msgstr "" + +#: ../../view_components/create_scenario.rst:46 +#: ../../view_components/load_scenario.rst:45 +msgid "" +"If user provided a scenario file/folder path which exists already, it " +"should be warned and given the option ot overwrite or not" +msgstr "" + +#: ../../view_components/create_scenario.rst:47 +msgid "" +"After the user clicked on :guilabel:`&Create`, they must still be able to" +" create another scenario through this view-component if they wish it" +msgstr "" + +#: ../../view_components/create_scenario.rst:48 +msgid "" +"When a new scenario is created, it should be assigned a unique id in the " +"backend" +msgstr "" + +#: ../../view_components/create_scenario.rst:49 +msgid "" +"When a new scenario is created, it should be possible for the user to " +"access and edit its input parameters" +msgstr "" + +#: ../../view_components/create_scenario.rst:56 +#: ../../view_components/load_scenario.rst:56 +msgid "" +"It should be possible to trigger the display of this view-component from " +"the landing view" +msgstr "" + +#: ../../view_components/create_scenario.rst:60 +msgid "" +"After clicking on :guilabel:`&Create`, the user is redirected to the view" +" corresponding to the first step in the :ref:`progression_bar-label` TODO" +" add link to this view" +msgstr "" + +#: ../../view_components/create_scenario.rst:70 +#: ../../view_components/load_scenario.rst:69 +msgid "" +"It should be possible to trigger the display of this view-component from " +"a sub-menu of the :ref:`menu_bar-label`" +msgstr "" + +#: ../../view_components/create_scenario.rst:75 +msgid "" +":guilabel:`&Browse` is on the right of the text input, the " +":guilabel:`&Create` is centered on the next line below" +msgstr "" + +#: ../../view_components/load_scenario.rst:4 +msgid "Load Scenario" +msgstr "" + +#: ../../view_components/load_scenario.rst:6 +msgid "This view-component enables the user to load a :ref:`scenario-label`." +msgstr "" + +#: ../../view_components/load_scenario.rst:13 +msgid "The user must provide a file path for the scenario they want to load" +msgstr "" + +#: ../../view_components/load_scenario.rst:32 +msgid "**button** :guilabel:`&Load`" +msgstr "" + +#: ../../view_components/load_scenario.rst:39 +msgid "" +"After clicking on :guilabel:`&Load`, a scenario is created in the backend" +" with loaded parameters. The user is redirected to the view corresponding" +" to the last step before running the simulation in the :ref" +":`progression_bar-label`" +msgstr "" + +#: ../../view_components/load_scenario.rst:44 +msgid "" +"If user provided a scenario file/folder path which does not exist yet, an" +" error message should be displayed" +msgstr "" + +#: ../../view_components/load_scenario.rst:46 +msgid "" +"After the user clicked on :guilabel:`&Load`, they must still be able to " +"load another scenario through this view-component if they wish it" +msgstr "" + +#: ../../view_components/load_scenario.rst:47 +msgid "" +"When a scenario is loaded, it should be assigned a unique id in the " +"backend" +msgstr "" + +#: ../../view_components/load_scenario.rst:48 +msgid "" +"When a scenario is loaded, it should be possible for the user to access " +"and edit its input parameters" +msgstr "" + +#: ../../view_components/load_scenario.rst:60 +msgid "" +"After clicking on :guilabel:`&Load`, the user is redirected to the view " +"corresponding to the last step before running the simulation in the :ref" +":`progression_bar-label` TODO add link to this view" +msgstr "" + +#: ../../view_components/load_scenario.rst:75 +msgid "" +":guilabel:`&Browse` is on the right of the text input, the " +":guilabel:`&Load` is centered on the next line below" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:4 +msgid "Input Parameter Field" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:6 +msgid "" +"This view-component enables the user input appropriate data in different " +"views." +msgstr "" + +#: ../../view_components/input_parameter_field.rst:13 +#: ../../view_components/load_input_dataseries.rst:13 +msgid "**Label**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:12 +#: ../../view_components/load_input_dataseries.rst:12 +msgid "Name of the parameter which would be displayed close to the input field" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:18 +msgid "**Input Type**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:16 +msgid "" +"Type of input parameter. One of int, float, str, array of int, float or " +"str, matrix of int or float, timeseries (an array with timestamp mapped " +"to each values), csv file" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:25 +#: ../../view_components/load_input_dataseries.rst:25 +msgid "**Input Unit**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:21 +#: ../../view_components/load_input_dataseries.rst:21 +msgid "Unit of the input parameter" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:23 +msgid "Actions index: 4" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:25 +msgid "Requirements index: 5" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:44 +msgid "**Input Field**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:28 +msgid "" +"An interactive GUI element via which the user can provide a value to the " +"input parameter." +msgstr "" + +#: ../../view_components/input_parameter_field.rst:30 +msgid "It depends on input type in the following way" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:32 +msgid "Numbers" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +#: ../../view_components/project_parameters.rst:17 +#: ../../view_components/scenario_parameters.rst:16 +msgid "Input type" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "Input field" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "int" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "Text input" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "float" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "str" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "array" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +#: ../../view_components/visualize_dataseries.rst:45 +msgid ":ref:`load_input_dataseries-label`" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "matrix" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "timeseries" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "csv file" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:49 +msgid "**Default/Placeholder Value**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:47 +msgid "The default value provided for each input parameter" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:54 +msgid "**Link to Documentation**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:52 +msgid "" +"Hyperlink that leads the user to the full documentation of the input " +"parameter TODO: add link to RTD here" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:62 +msgid "**Helper icon**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:57 +msgid "An image which can be used for rendering of this attribute" +msgstr "" + +#: ../../view_components/energy_system_component.rst:29 +#: ../../view_components/input_parameter_field.rst:60 +msgid "path to the icon file" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:67 +msgid "**Helper Text**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:65 +msgid "" +"A brief description of the parameter with the type of inputs and " +"specifications, if any." +msgstr "" + +#: ../../view_components/input_parameter_field.rst:72 +#: ../../view_components/load_input_dataseries.rst:40 +msgid "**Boolean Mandatory Input**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:70 +#: ../../view_components/load_input_dataseries.rst:38 +msgid "If true, the parameter must be defined by the user" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:72 +msgid "Requirements index: 2, 3" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:76 +msgid "" +"User can overwrite the default/placeholder value in the input field by a " +"simple click" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:77 +msgid "" +"User can get brief information about the input parameter by hovering on " +"the helper icon" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:78 +msgid "" +"User can directly navigate to the relevant sections of the documentation " +"by clicking on the documentation link below the helper text (action 2. " +"need to be performed before this one)" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:79 +#: ../../view_components/load_input_dataseries.rst:48 +msgid "" +"User can choose unit amongst a list of generic units, or input it by " +"typing it in. (this is known as an editable combo box)" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:83 +msgid "" +"The field must change depending on the type of the input. Some inputs " +"could just be one numeric value, while others might be a series of values" +" in the form a CSV file" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:84 +#: ../../view_components/load_input_dataseries.rst:55 +msgid "" +"For mandatory input fields, the fields must be denoted by an asterisk " +"adjacent to the field" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:85 +#: ../../view_components/load_input_dataseries.rst:56 +msgid "" +"If the user does not provide input for a mandatory field and tries to " +"proceed further, the field should be highlighted so as to alert the user" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:86 +msgid "" +"The default/placeholder values for which the user has not provided any " +"own-input must be rendered differently than the values in input fields " +"with input objects supplied by the user" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:87 +#: ../../view_components/load_input_dataseries.rst:54 +msgid "" +"The physical units which are commonly used for energy and power should be" +" available there (then converted internally to Joule and Watt)" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:97 +#: ../../view_components/project_location.rst:35 +#: ../../view_components/view_specific_documentation.rst:65 +msgid ":ref:`project_parameters-label`" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:99 +#: ../../view_components/view_specific_documentation.rst:62 +msgid ":ref:`scenario_parameters-label`" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:104 +msgid "" +"The label is placed above the input field and the helper icon to the " +"right of the label. The helper text is displayed in a tooltip when user " +"hover over the helper icon. The link to documentation should be at the " +"bottom of the tooltip with the text \"More details...\". The rendering of" +" the input field is either a text input or a :ref:`load_input_dataseries-" +"label`. The parameter unit editable combobox is placed next to the input " +"field. An asterisk is placed next to the label (between label and helper " +"icon) if the parameter input is mandatory." +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:4 +msgid "Load input data-series" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:6 +msgid "" +"User loads a file containing a data-series as input for a relevant " +"parameter and is able to quickly visualize the data." +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:18 +msgid "**Input field**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:25 +msgid "Requirements index: 2" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:30 +msgid "**Load File button**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:35 +msgid "**Visualize Data button**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:40 +msgid "Requirements index: 3, 4" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:45 +msgid "" +"User can directly provide the path of the file to be loaded as text in " +"the text field" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:46 +msgid "" +"Clicking on Load File button will open a pop-up window **(link the vc " +"(TBD) link here)**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:47 +msgid "" +"Clicking on the Visualize Data button will open a pop-up window with a " +"table and plot of the data-series :ref:`visualize_dataseries-label`" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:53 +msgid "" +"All parameters that require a data-series must be given input through " +"this view-component" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:57 +msgid "" +"The Load File and Visualize Data buttons should be present adjacent to " +"the Input Field" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:73 +#: ../../view_components/view_specific_documentation.rst:56 +msgid ":ref:`input_parameter_field-label`" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:73 +msgid "Both the view-components share some attributes" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:79 +msgid ":ref:`visualize_dataseries-label`" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:79 +msgid "" +"A pop-up window displaying a sample of the input data-series file with a " +"plot of the data alongside" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:4 +msgid "Scenario parameters" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:5 +msgid "" +"Inputs parameters to describe a :ref:`scenario-label`. They do not " +"contain the information about the energy system, which is defined in the " +":ref:`es_network` view-component." +msgstr "" + +#: ../../view_components/project_parameters.rst:12 +#: ../../view_components/scenario_parameters.rst:11 +msgid "**List of input parameters**" +msgstr "" + +#: ../../view_components/project_parameters.rst:14 +#: ../../view_components/scenario_parameters.rst:13 +msgid "" +"Each input parameter will be available to the user via :ref" +":`input_parameter_field-label`" +msgstr "" + +#: ../../view_components/project_parameters.rst:22 +#: ../../view_components/scenario_parameters.rst:21 +msgid "Properties of each input:" +msgstr "" + +#: ../../view_components/project_parameters.rst:18 +#: ../../view_components/scenario_parameters.rst:17 +msgid "Input default value" +msgstr "" + +#: ../../view_components/project_parameters.rst:19 +#: ../../view_components/scenario_parameters.rst:18 +msgid "Help text" +msgstr "" + +#: ../../view_components/project_parameters.rst:20 +#: ../../view_components/scenario_parameters.rst:19 +msgid "If it is mandatory or optional" +msgstr "" + +#: ../../view_components/project_parameters.rst:21 +#: ../../view_components/scenario_parameters.rst:20 +msgid "Link in documentation" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:23 +msgid "" +"You can browse through the list of different :ref:`input " +"parameters`" +msgstr "" + +#: ../../view_components/project_parameters.rst:42 +#: ../../view_components/scenario_parameters.rst:27 +msgid "User can edit the value of the input parameters manually." +msgstr "" + +#: ../../view_components/scenario_parameters.rst:28 +msgid "" +"User can edit the value of the input parameters by loading a scenario " +"from :ref:`load_scenario-label`" +msgstr "" + +#: ../../view_components/project_parameters.rst:48 +#: ../../view_components/scenario_parameters.rst:33 +msgid "" +"The requirements of :ref:`input_parameter_field-label` apply for each " +"input parameter" +msgstr "" + +#: ../../view_components/project_parameters.rst:55 +#: ../../view_components/scenario_parameters.rst:40 +msgid "" +"The rendering of :ref:`input_parameter_field-label` apply for each input " +"parameter" +msgstr "" + +#: ../../view_components/project_parameters.rst:4 +msgid "Project parameters" +msgstr "" + +#: ../../view_components/project_parameters.rst:6 +msgid "Inputs parameters to set the context of the project." +msgstr "" + +#: ../../view_components/project_parameters.rst:24 +msgid "" +"As the parameters in this list should also be accessible in a more " +"general parameter documentation in ReadTheDocs, they will be " +"automatically listed here from either a .yml or csv file." +msgstr "" + +#: ../../view_components/project_parameters.rst:26 +msgid "The following inputs stay here for the moment and will be reformated then" +msgstr "" + +#: ../../view_components/project_parameters.rst:29 +msgid "Localisation" +msgstr "" + +#: ../../view_components/project_parameters.rst +msgid "The geographical localisation of the project." +msgstr "" + +#: ../../view_components/project_parameters.rst +msgid "This can allow to download appropriate dataset." +msgstr "" + +#: ../../view_components/project_parameters.rst:31 +msgid "Project lifetime" +msgstr "" + +#: ../../view_components/project_parameters.rst:32 +#: ../../view_components/project_parameters.rst:34 +msgid "This can be used for calculations?" +msgstr "" + +#: ../../view_components/project_parameters.rst:33 +msgid "Weighted Average Cost of Capital" +msgstr "" + +#: ../../view_components/project_parameters.rst:35 +msgid "Project name" +msgstr "" + +#: ../../view_components/project_parameters.rst:36 +msgid "Give a name to that project." +msgstr "" + +#: ../../view_components/project_parameters.rst:38 +msgid "Project description (optional)" +msgstr "" + +#: ../../view_components/project_parameters.rst:38 +msgid "Give a short description of the project" +msgstr "" + +#: ../../view_components/project_parameters.rst:43 +msgid "" +"User can edit the value of the input parameters by loading a project from" +" :ref:`load_project-label`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:4 +msgid "Energy sector selector" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:6 +msgid "" +"The user can choose which :ref:`energy-type-def` they would like to use " +"in their energy system. This choice will impact which components of the " +"energy system model are available." +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:17 +msgid "**list of available energy sectors**" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:12 +msgid "Contains the possible energy sectors a user can choose from" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:15 +msgid "id `es_sector_avail_list`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:16 +#: ../../view_components/energy_system_sector_selector.rst:24 +msgid "each sector has an associated :ref:`energy-type-def`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:17 +#: ../../view_components/energy_system_sector_selector.rst:25 +msgid "each sector has an associated icon" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:25 +msgid "**list of selected energy sectors**" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:20 +msgid "Contains the choices selected by the user from the `es_sector_avail_list`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:23 +msgid "id `es_sector_select_list`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:33 +msgid "**list of connection between selected energy sectors**" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:28 +msgid "Indicates whether there is a coupling between two sectors" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:31 +msgid "id `es_sector_coupling_list`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:32 +msgid "each element is a list of two interconnected sectors" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:33 +msgid "an empty list means that all sectors are independent from each other" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:38 +msgid "" +"The user can select the sector they want to include in their energy " +"system model from the `es_sector_avail_list` by clicking on the list item" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:39 +msgid "" +"The user should be able to indicate if two sectors are interconnected " +"(could be clicking on greyed-out line connecting sectors visually)" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:44 +msgid "" +"Any `es_sector_select_list` item has to be an item of " +"`es_sector_avail_list`." +msgstr "" + +#: ../../view_components/energy_system_component.rst:72 +#: ../../view_components/energy_system_sector_selector.rst:51 +msgid ":ref:`es_network-label`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:51 +msgid "" +"Only :ref:`es_component` compatible with the selected energy sectors can " +"be included in the energy system" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:55 +msgid "" +"Each sector in the list is represented by its icon. The energy sectors in" +" the `es_sector_select_list` are rendered in color and the remaining " +"energy sectors (in `es_sector_avail_list` but not in " +"`es_sector_select_list`) are rendered in shades of grey. Each sector is " +"visually connected to all the other sectors by a greyed-out line (no " +"active sector coupling). If the line is display in bright color (e.g. " +"after an activating click on it by the user) it means the two sectors are" +" interconnected directly." +msgstr "" + +#: ../../view_components/energy_system_network.rst:4 +msgid "Energy System network" +msgstr "" + +#: ../../view_components/energy_system_network.rst:6 +msgid "This view-component will help the user to define their energy system model" +msgstr "" + +#: ../../view_components/energy_system_network.rst:22 +msgid "**list of energy busses**" +msgstr "" + +#: ../../view_components/energy_system_network.rst:13 +msgid "A list of energy busses" +msgstr "" + +#: ../../view_components/energy_system_network.rst:16 +msgid "id: `es_bus_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:17 +msgid "each bus has a unique id" +msgstr "" + +#: ../../view_components/energy_system_network.rst:18 +msgid "each bus has an associated :ref:`energy-type-def`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:20 +#: ../../view_components/energy_system_network.rst:52 +msgid "Actions index: 1, 2, 4" +msgstr "" + +#: ../../view_components/energy_system_network.rst:24 +msgid "**button** :guilabel:`&Add bus`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:26 +msgid "Linked to the action of adding a bus to the `es_bus_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:29 +msgid "id `add_es_bus`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:31 +#: ../../view_components/energy_system_network.rst:61 +msgid "Actions index: 1, 5, 6" +msgstr "" + +#: ../../view_components/energy_system_network.rst:35 +msgid "**button** :guilabel:`&Remove bus`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:37 +msgid "Linked to the action of removing a bus from the `es_bus_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:40 +msgid "id `remove_es_bus`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:42 +#: ../../view_components/energy_system_network.rst:71 +msgid "Actions index: 2, 3" +msgstr "" + +#: ../../view_components/energy_system_network.rst:53 +msgid "**list of energy system component**" +msgstr "" + +#: ../../view_components/energy_system_network.rst:47 +msgid "A list of *energy system components*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:50 +msgid "id: `es_component_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:63 +msgid "**button** :guilabel:`&Add component`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:56 +msgid "" +"Linked to the action of adding an energy system component to the " +"`es_component_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:59 +msgid "id `add_es_component`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:73 +msgid "**button** :guilabel:`&Remove component`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:66 +msgid "" +"Linked to the action of removing an energy system component from the " +"`es_component_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:69 +msgid "id `remove_es_component`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:85 +msgid "**Draw area**" +msgstr "" + +#: ../../view_components/energy_system_network.rst:76 +msgid "" +"Area where the user could drag and drop components and connect them, or " +"simply see a rendering of the energy system graph withtout being able to " +"interact with it" +msgstr "" + +#: ../../view_components/energy_system_network.rst:80 +msgid "id `network_schema`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:82 +msgid "Actions index: 4." +msgstr "" + +#: ../../view_components/energy_system_network.rst:92 +msgid "**Text area**" +msgstr "" + +#: ../../view_components/energy_system_network.rst:88 +msgid "" +"Displays potential error messages arising from wrong configuration of " +"*energy system network* or single *energy system component*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:91 +msgid "id `error_log`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:97 +msgid "" +"Clicking on the `add es_bus`/`add es_component` button adds a *Bus* or an" +" *energy system component* to the `es_bus_list`/`es_component_list`, " +"respectively." +msgstr "" + +#: ../../view_components/energy_system_network.rst:98 +msgid "" +"Clicking on the `remove_es_bus`/`remove_es_component` button removes the " +"currently selected *Bus* or *energy system component* from the " +"`es_bus_list`/`es_component_list`, respectively." +msgstr "" + +#: ../../view_components/energy_system_network.rst:99 +msgid "" +"Clicking on the `remove_es_bus`/`remove_es_component` button when no " +"*Bus* or *energy system component* is currently selected sends a log " +"message to the `error_log`." +msgstr "" + +#: ../../view_components/energy_system_network.rst:100 +msgid "" +"Selecting a bus or an energy system component in `es_bus_list`, " +"`es_component_list` or in `network_schema` allows the user to visualise " +"and/or edit its properties in another view-component." +msgstr "" + +#: ../../view_components/energy_system_network.rst:101 +msgid "" +"When a the user add a *Bus* or *energy system component* by clicking on " +"the `add_es_bus`/`add_es_component`, they can visualise and/or edit its " +"properties in another view-component." +msgstr "" + +#: ../../view_components/energy_system_network.rst:102 +msgid "" +"When a the user add a *Bus* or *energy system component* by clicking on " +"the `add_es_bus`/`add_es_component`, they can to see it in the " +"`network_schema`." +msgstr "" + +#: ../../view_components/energy_system_network.rst:107 +msgid "" +"If not defined by the user, an additional Sink component to dump excess " +"energy flow is defined and connected automatically to one *Bus* in the " +"*energy system network*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:108 +msgid "" +"If not defined by the user, an additional Source component to provide " +"slack energy flow is defined and connected automatically to one *Bus* in " +"the *energy system network*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:109 +msgid "" +"notifications informing the user about potential problems with their " +"energy system model should be displayed in the `error_log` text area. " +"Problems could be such as a failure to meet any of the other " +"requirements, an undefined property value of an *energy system " +"component*, or a *Bus* without connection to another *energy system " +"component*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:114 +msgid ":ref:`es_component-label`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:119 +msgid "" +"The buttons need to be visible at all time, as the selection of *energy " +"system components* or *Busses* can be done either from the lists " +"`es_bus_list`, `es_component_list` or from `network_schema`, they do not " +"necessarily need to be seen at the same time (they could be side by side " +"or accessible via tabs)" +msgstr "" + +#: ../../view_components/energy_system_component.rst:4 +msgid "Energy system component" +msgstr "" + +#: ../../view_components/energy_system_component.rst:6 +msgid "" +"Define the view a user has when creating or editing a component of its " +"energy system" +msgstr "" + +#: ../../view_components/energy_system_component.rst:15 +msgid "**Energy type**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:14 +msgid "" +"ref:`energy-type-def` linked to the different energy sectors (e.g. heat, " +"electricity, ...)" +msgstr "" + +#: ../../view_components/energy_system_component.rst:19 +msgid "**Component type**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:18 +msgid "Can be one of [Source, Sink, Transformer, Storage, Bus]" +msgstr "" + +#: ../../view_components/energy_system_component.rst:23 +msgid "**Unique id**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:22 +msgid "" +"A positive integer number to identify the component uniquely within the " +"list of energy system components of the :ref:`es_network-label`" +msgstr "" + +#: ../../view_components/energy_system_component.rst:33 +msgid "**Icon**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:26 +msgid "An image which can be used for rendering of the view-component" +msgstr "" + +#: ../../view_components/energy_system_component.rst:38 +msgid "**Input energy flow**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:36 +msgid "" +"A list of other components's ids which are connected to this component " +"and provide it with energy" +msgstr "" + +#: ../../view_components/energy_system_component.rst:38 +#: ../../view_components/energy_system_component.rst:43 +msgid "Requirements index: 1, 5, 6" +msgstr "" + +#: ../../view_components/energy_system_component.rst:43 +msgid "**Output energy flow**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:41 +msgid "" +"A list of other components's ids which are connected to this component " +"and drain energy from it" +msgstr "" + +#: ../../view_components/energy_system_component.rst:48 +msgid "" +"Double-clicking on the rendering of the *energy system component* allow " +"the user to edit its attributes (except id)" +msgstr "" + +#: ../../view_components/energy_system_component.rst:53 +msgid "" +"As long as the *energy system component* is not connected correctly to " +"another *energy system component* the Icon-frame is displayed in another " +"colour" +msgstr "" + +#: ../../view_components/energy_system_component.rst:55 +msgid "" +"An *energy system component* which is not of *component type* Bus can not" +" be connected to another *energy system component*, which is not of " +"*component type* Bus" +msgstr "" + +#: ../../view_components/energy_system_component.rst:57 +msgid "" +"An *energy system component* which is not of *component type* Bus, should" +" have at least one connection to an *energy system component* of " +"*component type* Bus" +msgstr "" + +#: ../../view_components/energy_system_component.rst:59 +msgid "" +"An *energy system component* of *component type* Sink has a connection to" +" *Input energy flow*, but no connection to *Output energy flow*" +msgstr "" + +#: ../../view_components/energy_system_component.rst:61 +msgid "" +"An *energy system component* of *component type* Source has a connection " +"*Output Energy flow*, but no connection to *Input energy flow*" +msgstr "" + +#: ../../view_components/energy_system_component.rst:66 +msgid "It is currently not directly linked to a view" +msgstr "" + +#: ../../view_components/energy_system_component.rst:72 +msgid "" +"The component is inserted within the energy system model described in " +"this other view-component" +msgstr "" + +#: ../../view_components/energy_system_component.rst:76 +msgid "" +"This *energy system component* can be rendered as a list item within :ref" +":`es_network-label`'s `es_component_list` attribute or via its icon " +"within :ref:`es_network-label`'s `network_schema` attribute." +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:4 +msgid "View Specific Documentation" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:6 +msgid "" +"This view-component lets the user access the specific sections of the " +"documentation directly from within the tool UI. It serves as a tooltip " +"for input parameters." +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:16 +msgid "**Scroll Bar**" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:12 +msgid "This bar lets the user navigate the documentation content" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:21 +msgid "**Side navigation pane**" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:19 +msgid "" +"This navigation pane is akin to a table of contents and lets the user " +"jump to other sections of the documentation quickly" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:24 +msgid "**Content**" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:24 +msgid "" +"Content of the documentation such as text, images, hyperlinks, etc., to " +"be rendered" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:31 +msgid "**button** :guilabel:`&Download PDF`" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:27 +msgid "Clicking this triggers the download of a pdf of the documentation" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:36 +msgid "User can scroll through the documentation using the scroll bar" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:37 +msgid "" +"User can jump to other sections of the documentation using the links in " +"the navigation pane" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:38 +msgid "" +"User can click on the Download PDF button to obtain a local copy of the " +"documentation" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:43 +msgid "" +"User must be able to open this view-component through clicking on links " +"next to various elements in other views/view-components" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:53 +msgid "" +"First view-component on the landing view of the tool, seen by the user. " +"Contains link to documentation" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:56 +msgid "" +"Generic view-component that describes the fields where user inputs are " +"necessary" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:59 +msgid ":ref:`load_input_parameter-label`" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:62 +msgid "View-component where the user inputs the scenario-specific parameters" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:65 +msgid "View-component where the user inputs the project parameters" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:70 +msgid "" +"This view-component could either be a pop-up on top of the view the user " +"is currently in, or as a new tab on a browser window opening relevant " +"sections of readthedocs directly" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:4 +msgid "Visualize data-series" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:6 +msgid "" +"This view-component helps the user visualize the dataset they load into " +"the tool in order to cross-check for any issues with the provided " +"dataset." +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:11 +msgid "**Head of the data-series**" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:14 +msgid "" +"First few rows and columns of the data-series are displayed in a tabular " +"form" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:16 +msgid "**Plot of the data-series**" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:19 +msgid "" +"Rendered as an image alongside the table showing the first few columns " +"and rows of the data-series" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:29 +msgid "" +"User should be able to close the pop-up window and re-open it by clicking" +" on \"Visualize Data\" button in view-component :ref" +":`load_input_dataseries-label`" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:44 +msgid "" +"Current view-component is only accessible through attributes of the " +"linked view-component" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:50 +msgid "Rendered as a pop-up window" +msgstr "" + +#: ../../view_components/project_location.rst:4 +msgid "Map with Project Location" +msgstr "" + +#: ../../view_components/project_location.rst:6 +msgid "A rectangular container that contains an interactive map." +msgstr "" + +#: ../../view_components/project_location.rst:8 +msgid "This can be implemented for eg., with Leaflet or Folium libraries." +msgstr "" + +#: ../../view_components/project_location.rst:18 +msgid "**Project area highlighted**" +msgstr "" + +#: ../../view_components/project_location.rst:14 +msgid "" +"The project area, obtained using coordinates supplied by the user and " +"energy cell area, should be highlighted on the map as a polygon." +msgstr "" + +#: ../../view_components/project_location.rst:23 +msgid "User can zoom in, zoom out, pan around using the input from their mouse" +msgstr "" + +#: ../../view_components/project_location.rst:28 +msgid "" +"User must provide the project location coordinates and energy cell area " +"parameters in :ref:`load_project_parameters-label`" +msgstr "" + +#: ../../view_components/project_location.rst:35 +msgid "" +"The parameters necessary to generate the project location map view-" +"component are input by the user through this view-component" +msgstr "" + +#: ../../view_components/project_location.rst:38 +msgid ":ref:`load_project_parameters-label`" +msgstr "" + +#: ../../view_components/project_location.rst:49 +msgid "" +"As a rectangular container displaying an interactive map of the project " +"location highlighted as either a point or as a polygonal area on the map." +msgstr "" + +#: ../../view_components/read_write_files.rst:4 +msgid "Read/Write Files" +msgstr "" + +#: ../../view_components/read_write_files.rst:6 +msgid "File explorer to read and write files to the system storage." +msgstr "" + +#: ../../view_components/read_write_files.rst:83 +msgid "Rendered as a pop-up" +msgstr "" + +#: ../../view_components/project_list.rst:4 +msgid "List of Projects" +msgstr "" + +#: ../../view_components/project_list.rst:6 +msgid "" +"This view-component displays a list of open_plan project (or project " +"files in accepted formats) objects one of which can can be loaded as the " +"current project." +msgstr "" + +#: ../../view_components/project_list.rst:14 +#: ../../view_components/scenario_list.rst:12 +msgid "**Select**" +msgstr "" + +#: ../../view_components/project_list.rst:14 +msgid "" +"Allows the user to select the project object to be loaded as the current " +"project" +msgstr "" + +#: ../../view_components/project_list.rst:17 +#: ../../view_components/scenario_list.rst:15 +msgid "**Delete**" +msgstr "" + +#: ../../view_components/project_list.rst:17 +msgid "Allows the user to delete the saved project object from the disk" +msgstr "" + +#: ../../view_components/project_list.rst:20 +#: ../../view_components/scenario_list.rst:18 +msgid "**Show**" +msgstr "" + +#: ../../view_components/project_list.rst:20 +msgid "Allows the user to quickly preview the project object selected" +msgstr "" + +#: ../../view_components/project_list.rst:23 +#: ../../view_components/scenario_list.rst:21 +msgid "**Edit**" +msgstr "" + +#: ../../view_components/project_list.rst:23 +msgid "Allows the user to quickly edit the main project parameters" +msgstr "" + +#: ../../view_components/project_list.rst:51 +msgid "Landing page view of which this view-component is a part of" +msgstr "" + +#: ../../view_components/project_list.rst:57 +msgid ":ref:`project-label`" +msgstr "" + +#: ../../view_components/project_list.rst:57 +msgid "The abstract component describing the project object" +msgstr "" + +#: ../../abstract_components/project.rst:33 +#: ../../abstract_components/project.rst:40 +#: ../../view_components/project_list.rst:61 +#: ../../view_components/scenario_list.rst:54 +msgid ":ref:`read_write_files-label`" +msgstr "" + +#: ../../view_components/project_list.rst:60 +#: ../../view_components/scenario_list.rst:54 +msgid "" +"VIew-component through which the project objects could be loaded from the" +" disk or written to the disk" +msgstr "" + +#: ../../view_components/project_list.rst:66 +msgid "" +"Rendered as a list which displays all the project objects already saved " +"in the system or currently created" +msgstr "" + +#: ../../view_components/project_list.rst:68 +msgid "Currently selected project is highlighted separately" +msgstr "" + +#: ../../view_components/scenario_list.rst:4 +msgid "List of Scenarios" +msgstr "" + +#: ../../view_components/scenario_list.rst:6 +msgid "" +"This view-component shows the list of scenario objects, both created " +"through the tool within the current project or loaded from file, " +"available for further steps in the simulation." +msgstr "" + +#: ../../view_components/scenario_list.rst:12 +msgid "" +"Allows the user to select the scenario object to be loaded as the current" +" project" +msgstr "" + +#: ../../view_components/scenario_list.rst:15 +msgid "Allows the user to delete the saved scenario object from the disk" +msgstr "" + +#: ../../view_components/scenario_list.rst:18 +msgid "Allows the user to quickly preview the scenario object selected" +msgstr "" + +#: ../../view_components/scenario_list.rst:21 +msgid "Allows the user to quickly edit the main scenario parameters" +msgstr "" + +#: ../../view_components/scenario_list.rst:26 +msgid "Select the current scenario object" +msgstr "" + +#: ../../view_components/scenario_list.rst:27 +msgid "" +"Show the main parameters of any scenario object that the user selects in " +"the list of scenarios" +msgstr "" + +#: ../../view_components/scenario_list.rst:28 +msgid "" +"View the list of scenarios objects created in the present project or " +"available on the disk" +msgstr "" + +#: ../../view_components/scenario_list.rst:29 +msgid "Delete a scenario object, both saved and unsaved ones" +msgstr "" + +#: ../../view_components/scenario_list.rst:51 +msgid ":ref:`scenario-label`" +msgstr "" + +#: ../../view_components/scenario_list.rst:51 +msgid "" +"The abstract component describing the scenario objects part of this view-" +"component" +msgstr "" + +#: ../../view_components/scenario_list.rst:59 +msgid "" +"Rendered as a list which displays all the scenario objects loaded and/or " +"created in the current project" +msgstr "" + +#: ../../view_components/scenario_list.rst:61 +msgid "Currently selected scenario is highlighted separately" +msgstr "" + +#: ../../tool_interface.rst:271 +msgid "Abstract-components Definition" +msgstr "" + +#: ../../abstract_components/scenario.rst:2 +msgid "Scenario" +msgstr "" + +#: ../../abstract_components/scenario.rst:12 +msgid "**Scenario as an object**" +msgstr "" + +#: ../../abstract_components/scenario.rst:11 +msgid "" +"Scenario is an object that exists in the computer's temporary memory " +"(RAM). It can be considered as the a concept that wraps an instance of " +"the energy system class plus the inputs. However, it could be saved to " +"the permanent memory by saving the data the object holds to disk as a " +"file of an appropriate format." +msgstr "" + +#: ../../abstract_components/scenario.rst:17 +msgid "" +"Scenario can be saved to disk through the *load scenario* view component " +"in the Scenarios view" +msgstr "" + +#: ../../abstract_components/scenario.rst:18 +msgid "" +"Multiple scenario objects can be created during the simulation using the " +"*create scenario* view component in the Scenarios view" +msgstr "" + +#: ../../abstract_components/scenario.rst:19 +msgid "" +"Multiple scenario objects can be compared in the *scenario comparison* " +"view" +msgstr "" + +#: ../../abstract_components/project.rst:26 +#: ../../abstract_components/scenario.rst:25 +msgid "The objects must be accessible to other relevant view components" +msgstr "" + +#: ../../abstract_components/scenario.rst:26 +msgid "" +"External scenario objects created in other software that are to be " +"imported into open_plan should adhere to the data standards" +msgstr "" + +#: ../../abstract_components/scenario.rst:27 +msgid "" +"Should be saved to disk in an appropriate format before exiting the tool " +"in order to be accessible later" +msgstr "" + +#: ../../abstract_components/scenario.rst:32 +msgid "*placeholder* *placeholder2*" +msgstr "" + +#: ../../abstract_components/scenario.rst:38 +msgid "*placeholder*" +msgstr "" + +#: ../../abstract_components/project.rst:2 +msgid "Project" +msgstr "" + +#: ../../abstract_components/project.rst:13 +msgid "**Project as an object**" +msgstr "" + +#: ../../abstract_components/project.rst:11 +msgid "" +"Project is an object that exists in the computer's temporary memory " +"(RAM). It can be considered as the a concept that holds one or more " +"scenarios of the energy system simulation sharing some common " +"characteristics." +msgstr "" + +#: ../../abstract_components/project.rst:13 +msgid "" +"It could be saved to the permanent memory by saving the data the object " +"holds to disk as a file of an appropriate format." +msgstr "" + +#: ../../abstract_components/project.rst:18 +msgid "" +"Existing project object can be loaded through the *load_project* view " +"component in the Landing Page view" +msgstr "" + +#: ../../abstract_components/project.rst:19 +msgid "" +"New project object can be created through the UI of the tool using the " +"*create_project* view component in the Landing Page view" +msgstr "" + +#: ../../abstract_components/project.rst:20 +msgid "" +"Current project object can be saved to the disk by the user through the " +"*Save Project* button that connects to the *read_write_files* view-" +"component" +msgstr "" + +#: ../../abstract_components/project.rst:27 +msgid "" +"External project objects created in other software that are to be " +"imported into open_plan should adhere to the data standards" +msgstr "" + +#: ../../abstract_components/project.rst:28 +msgid "" +"The project object be saved to disk in an appropriate format before " +"exiting the tool in order to be accessible later" +msgstr "" + +#: ../../abstract_components/project.rst:40 +msgid "" +"This view-component is required to read and write files from and to the " +"disk respectively" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/create_project.mo b/docs/locale/de/LC_MESSAGES/view_components/create_project.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/create_project.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/create_project.po b/docs/locale/de/LC_MESSAGES/view_components/create_project.po new file mode 100755 index 0000000..3f00b04 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/create_project.po @@ -0,0 +1,133 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/create_project.rst:4 +msgid "Create project" +msgstr "" + +#: ../../view_components/create_project.rst:6 +msgid "This is not described yet" +msgstr "" + +#: ../../view_components/create_project.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/create_project.rst:23 +msgid "**Attribute A**" +msgstr "" + +#: ../../view_components/create_project.rst:14 +#: ../../view_components/create_project.rst:28 +msgid "Description" +msgstr "" + +#: ../../view_components/create_project.rst:19 +#: ../../view_components/create_project.rst:33 +msgid "Properties:" +msgstr "" + +#: ../../view_components/create_project.rst:17 +#: ../../view_components/create_project.rst:31 +msgid "Property 1" +msgstr "" + +#: ../../view_components/create_project.rst:18 +#: ../../view_components/create_project.rst:32 +msgid "..." +msgstr "" + +#: ../../view_components/create_project.rst:19 +#: ../../view_components/create_project.rst:33 +msgid "Property n" +msgstr "" + +#: ../../view_components/create_project.rst:21 +#: ../../view_components/create_project.rst:35 +msgid "Actions index:" +msgstr "" + +#: ../../view_components/create_project.rst:23 +#: ../../view_components/create_project.rst:37 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/create_project.rst:37 +msgid "**Attribute B**" +msgstr "" + +#: ../../view_components/create_project.rst:42 +msgid "Actions" +msgstr "" + +#: ../../view_components/create_project.rst:47 +msgid "Action 1" +msgstr "" + +#: ../../view_components/create_project.rst:48 +msgid "Action 2" +msgstr "" + +#: ../../view_components/create_project.rst:51 +msgid "Requirements" +msgstr "" + +#: ../../view_components/create_project.rst:59 +msgid "Requirement 1" +msgstr "" + +#: ../../view_components/create_project.rst:60 +msgid "Requirement 2" +msgstr "" + +#: ../../view_components/create_project.rst:63 +msgid "Link with views" +msgstr "" + +#: ../../view_components/create_project.rst:67 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/create_project.rst:67 +#: ../../view_components/create_project.rst:70 +#: ../../view_components/create_project.rst:77 +#: ../../view_components/create_project.rst:80 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/create_project.rst:70 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/create_project.rst:73 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/create_project.rst:77 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/create_project.rst:80 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/create_project.rst:83 +msgid "Rendering of the view-component" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/create_scenario.mo b/docs/locale/de/LC_MESSAGES/view_components/create_scenario.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/create_scenario.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/create_scenario.po b/docs/locale/de/LC_MESSAGES/view_components/create_scenario.po new file mode 100755 index 0000000..12789c4 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/create_scenario.po @@ -0,0 +1,190 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/create_scenario.rst:4 +msgid "Create Scenario" +msgstr "" + +#: ../../view_components/create_scenario.rst:6 +msgid "" +"This view-component enables the user to create a new :ref:`scenario-" +"label`." +msgstr "" + +#: ../../view_components/create_scenario.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/create_scenario.rst:16 +msgid "**Scenario name text input**" +msgstr "" + +#: ../../view_components/create_scenario.rst:12 +msgid "The user can provide a file path for the scenario they want to create" +msgstr "" + +#: ../../view_components/create_scenario.rst:14 +msgid "Actions index: 2" +msgstr "" + +#: ../../view_components/create_scenario.rst:16 +#: ../../view_components/create_scenario.rst:23 +msgid "Requirements index: 1, 2, 3" +msgstr "" + +#: ../../view_components/create_scenario.rst:24 +msgid "**button** :guilabel:`&Browse`" +msgstr "" + +#: ../../view_components/create_scenario.rst:19 +msgid "" +"Triggers the selection the scenario name text input via a graphical file " +"structure" +msgstr "" + +#: ../../view_components/create_scenario.rst:21 +msgid "Actions index: 1" +msgstr "" + +#: ../../view_components/create_scenario.rst:32 +msgid "**button** :guilabel:`&Create`" +msgstr "" + +#: ../../view_components/create_scenario.rst:27 +msgid "The user triggers the creation of the scenario" +msgstr "" + +#: ../../view_components/create_scenario.rst:29 +msgid "Actions index: 3" +msgstr "" + +#: ../../view_components/create_scenario.rst:31 +msgid "Requirements index: 4, 5, 6" +msgstr "" + +#: ../../view_components/create_scenario.rst:35 +msgid "Actions" +msgstr "" + +#: ../../view_components/create_scenario.rst:37 +msgid "" +"User can navigate through the file system either graphically to input " +"scenario name by clicking on :guilabel:`&Browse`" +msgstr "" + +#: ../../view_components/create_scenario.rst:38 +msgid "User can input scenario name in the input text" +msgstr "" + +#: ../../view_components/create_scenario.rst:39 +msgid "" +"After clicking on :guilabel:`&Create`, a scenario is created in the " +"backend, in the file system and the user is redirected to the view " +"corresponding to the first step in the :ref:`progression_bar-label`" +msgstr "" + +#: ../../view_components/create_scenario.rst:42 +msgid "Requirements" +msgstr "" + +#: ../../view_components/create_scenario.rst:44 +msgid "" +"If user only provided a name and not a file path, then the scenario " +"file/folder is created in a default location" +msgstr "" + +#: ../../view_components/create_scenario.rst:45 +msgid "" +"If user provided a scenario file/folder path which does not exist yet, " +"the missing folders in the path should be created" +msgstr "" + +#: ../../view_components/create_scenario.rst:46 +msgid "" +"If user provided a scenario file/folder path which exists already, it " +"should be warned and given the option ot overwrite or not" +msgstr "" + +#: ../../view_components/create_scenario.rst:47 +msgid "" +"After the user clicked on :guilabel:`&Create`, they must still be able to" +" create another scenario through this view-component if they wish it" +msgstr "" + +#: ../../view_components/create_scenario.rst:48 +msgid "" +"When a new scenario is created, it should be assigned a unique id in the " +"backend" +msgstr "" + +#: ../../view_components/create_scenario.rst:49 +msgid "" +"When a new scenario is created, it should be possible for the user to " +"access and edit its input parameters" +msgstr "" + +#: ../../view_components/create_scenario.rst:52 +msgid "Link with views" +msgstr "" + +#: ../../view_components/create_scenario.rst:57 +msgid ":ref:`landing-label`" +msgstr "" + +#: ../../view_components/create_scenario.rst:56 +msgid "" +"It should be possible to trigger the display of this view-component from " +"the landing view" +msgstr "" + +#: ../../view_components/create_scenario.rst:63 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/create_scenario.rst:60 +msgid "" +"After clicking on :guilabel:`&Create`, the user is redirected to the view" +" corresponding to the first step in the :ref:`progression_bar-label` TODO" +" add link to this view" +msgstr "" + +#: ../../view_components/create_scenario.rst:66 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/create_scenario.rst:71 +msgid ":ref:`menu_bar-label`" +msgstr "" + +#: ../../view_components/create_scenario.rst:70 +msgid "" +"It should be possible to trigger the display of this view-component from " +"a sub-menu of the :ref:`menu_bar-label`" +msgstr "" + +#: ../../view_components/create_scenario.rst:74 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/create_scenario.rst:75 +msgid "" +":guilabel:`&Browse` is on the right of the text input, the " +":guilabel:`&Create` is centered on the next line below" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/energy_system_component.mo b/docs/locale/de/LC_MESSAGES/view_components/energy_system_component.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/energy_system_component.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/energy_system_component.po b/docs/locale/de/LC_MESSAGES/view_components/energy_system_component.po new file mode 100755 index 0000000..bb39562 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/energy_system_component.po @@ -0,0 +1,190 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/energy_system_component.rst:4 +msgid "Energy system component" +msgstr "" + +#: ../../view_components/energy_system_component.rst:6 +msgid "" +"Define the view a user has when creating or editing a component of its " +"energy system" +msgstr "" + +#: ../../view_components/energy_system_component.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/energy_system_component.rst:15 +msgid "**Energy type**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:14 +msgid "" +"ref:`energy-type-def` linked to the different energy sectors (e.g. heat, " +"electricity, ...)" +msgstr "" + +#: ../../view_components/energy_system_component.rst:19 +msgid "**Component type**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:18 +msgid "Can be one of [Source, Sink, Transformer, Storage, Bus]" +msgstr "" + +#: ../../view_components/energy_system_component.rst:23 +msgid "**Unique id**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:22 +msgid "" +"A positive integer number to identify the component uniquely within the " +"list of energy system components of the :ref:`es_network-label`" +msgstr "" + +#: ../../view_components/energy_system_component.rst:33 +msgid "**Icon**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:26 +msgid "An image which can be used for rendering of the view-component" +msgstr "" + +#: ../../view_components/energy_system_component.rst:29 +msgid "Properties:" +msgstr "" + +#: ../../view_components/energy_system_component.rst:29 +msgid "path to the icon file" +msgstr "" + +#: ../../view_components/energy_system_component.rst:31 +msgid "Actions index:" +msgstr "" + +#: ../../view_components/energy_system_component.rst:33 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/energy_system_component.rst:38 +msgid "**Input energy flow**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:36 +msgid "" +"A list of other components's ids which are connected to this component " +"and provide it with energy" +msgstr "" + +#: ../../view_components/energy_system_component.rst:38 +#: ../../view_components/energy_system_component.rst:43 +msgid "Requirements index: 1, 5, 6" +msgstr "" + +#: ../../view_components/energy_system_component.rst:43 +msgid "**Output energy flow**" +msgstr "" + +#: ../../view_components/energy_system_component.rst:41 +msgid "" +"A list of other components's ids which are connected to this component " +"and drain energy from it" +msgstr "" + +#: ../../view_components/energy_system_component.rst:46 +msgid "Actions" +msgstr "" + +#: ../../view_components/energy_system_component.rst:48 +msgid "" +"Double-clicking on the rendering of the *energy system component* allow " +"the user to edit its attributes (except id)" +msgstr "" + +#: ../../view_components/energy_system_component.rst:51 +msgid "Requirements" +msgstr "" + +#: ../../view_components/energy_system_component.rst:53 +msgid "" +"As long as the *energy system component* is not connected correctly to " +"another *energy system component* the Icon-frame is displayed in another " +"colour" +msgstr "" + +#: ../../view_components/energy_system_component.rst:55 +msgid "" +"An *energy system component* which is not of *component type* Bus can not" +" be connected to another *energy system component*, which is not of " +"*component type* Bus" +msgstr "" + +#: ../../view_components/energy_system_component.rst:57 +msgid "" +"An *energy system component* which is not of *component type* Bus, should" +" have at least one connection to an *energy system component* of " +"*component type* Bus" +msgstr "" + +#: ../../view_components/energy_system_component.rst:59 +msgid "" +"An *energy system component* of *component type* Sink has a connection to" +" *Input energy flow*, but no connection to *Output energy flow*" +msgstr "" + +#: ../../view_components/energy_system_component.rst:61 +msgid "" +"An *energy system component* of *component type* Source has a connection " +"*Output Energy flow*, but no connection to *Input energy flow*" +msgstr "" + +#: ../../view_components/energy_system_component.rst:64 +msgid "Link with views" +msgstr "" + +#: ../../view_components/energy_system_component.rst:66 +msgid "It is currently not directly linked to a view" +msgstr "" + +#: ../../view_components/energy_system_component.rst:69 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/energy_system_component.rst:72 +msgid ":ref:`es_network-label`" +msgstr "" + +#: ../../view_components/energy_system_component.rst:72 +msgid "" +"The component is inserted within the energy system model described in " +"this other view-component" +msgstr "" + +#: ../../view_components/energy_system_component.rst:75 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/energy_system_component.rst:76 +msgid "" +"This *energy system component* can be rendered as a list item within :ref" +":`es_network-label`'s `es_component_list` attribute or via its icon " +"within :ref:`es_network-label`'s `network_schema` attribute." +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/energy_system_network.mo b/docs/locale/de/LC_MESSAGES/view_components/energy_system_network.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/energy_system_network.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/energy_system_network.po b/docs/locale/de/LC_MESSAGES/view_components/energy_system_network.po new file mode 100755 index 0000000..c4d95e0 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/energy_system_network.po @@ -0,0 +1,278 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/energy_system_network.rst:4 +msgid "Energy System network" +msgstr "" + +#: ../../view_components/energy_system_network.rst:6 +msgid "This view-component will help the user to define their energy system model" +msgstr "" + +#: ../../view_components/energy_system_network.rst:10 +msgid "Attributes" +msgstr "" + +#: ../../view_components/energy_system_network.rst:22 +msgid "**list of energy busses**" +msgstr "" + +#: ../../view_components/energy_system_network.rst:13 +msgid "A list of energy busses" +msgstr "" + +#: ../../view_components/energy_system_network.rst:18 +#: ../../view_components/energy_system_network.rst:29 +#: ../../view_components/energy_system_network.rst:40 +#: ../../view_components/energy_system_network.rst:50 +#: ../../view_components/energy_system_network.rst:59 +#: ../../view_components/energy_system_network.rst:69 +#: ../../view_components/energy_system_network.rst:80 +#: ../../view_components/energy_system_network.rst:92 +msgid "Properties:" +msgstr "" + +#: ../../view_components/energy_system_network.rst:16 +msgid "id: `es_bus_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:17 +msgid "each bus has a unique id" +msgstr "" + +#: ../../view_components/energy_system_network.rst:18 +msgid "each bus has an associated :ref:`energy-type-def`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:20 +#: ../../view_components/energy_system_network.rst:52 +msgid "Actions index: 1, 2, 4" +msgstr "" + +#: ../../view_components/energy_system_network.rst:22 +#: ../../view_components/energy_system_network.rst:33 +#: ../../view_components/energy_system_network.rst:44 +#: ../../view_components/energy_system_network.rst:63 +#: ../../view_components/energy_system_network.rst:73 +#: ../../view_components/energy_system_network.rst:84 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/energy_system_network.rst:24 +msgid "**button** :guilabel:`&Add bus`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:26 +msgid "Linked to the action of adding a bus to the `es_bus_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:29 +msgid "id `add_es_bus`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:31 +#: ../../view_components/energy_system_network.rst:61 +msgid "Actions index: 1, 5, 6" +msgstr "" + +#: ../../view_components/energy_system_network.rst:35 +msgid "**button** :guilabel:`&Remove bus`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:37 +msgid "Linked to the action of removing a bus from the `es_bus_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:40 +msgid "id `remove_es_bus`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:42 +#: ../../view_components/energy_system_network.rst:71 +msgid "Actions index: 2, 3" +msgstr "" + +#: ../../view_components/energy_system_network.rst:53 +msgid "**list of energy system component**" +msgstr "" + +#: ../../view_components/energy_system_network.rst:47 +msgid "A list of *energy system components*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:50 +msgid "id: `es_component_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:63 +msgid "**button** :guilabel:`&Add component`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:56 +msgid "" +"Linked to the action of adding an energy system component to the " +"`es_component_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:59 +msgid "id `add_es_component`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:73 +msgid "**button** :guilabel:`&Remove component`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:66 +msgid "" +"Linked to the action of removing an energy system component from the " +"`es_component_list`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:69 +msgid "id `remove_es_component`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:85 +msgid "**Draw area**" +msgstr "" + +#: ../../view_components/energy_system_network.rst:76 +msgid "" +"Area where the user could drag and drop components and connect them, or " +"simply see a rendering of the energy system graph withtout being able to " +"interact with it" +msgstr "" + +#: ../../view_components/energy_system_network.rst:80 +msgid "id `network_schema`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:82 +msgid "Actions index: 4." +msgstr "" + +#: ../../view_components/energy_system_network.rst:92 +msgid "**Text area**" +msgstr "" + +#: ../../view_components/energy_system_network.rst:88 +msgid "" +"Displays potential error messages arising from wrong configuration of " +"*energy system network* or single *energy system component*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:91 +msgid "id `error_log`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:95 +msgid "Actions" +msgstr "" + +#: ../../view_components/energy_system_network.rst:97 +msgid "" +"Clicking on the `add es_bus`/`add es_component` button adds a *Bus* or an" +" *energy system component* to the `es_bus_list`/`es_component_list`, " +"respectively." +msgstr "" + +#: ../../view_components/energy_system_network.rst:98 +msgid "" +"Clicking on the `remove_es_bus`/`remove_es_component` button removes the " +"currently selected *Bus* or *energy system component* from the " +"`es_bus_list`/`es_component_list`, respectively." +msgstr "" + +#: ../../view_components/energy_system_network.rst:99 +msgid "" +"Clicking on the `remove_es_bus`/`remove_es_component` button when no " +"*Bus* or *energy system component* is currently selected sends a log " +"message to the `error_log`." +msgstr "" + +#: ../../view_components/energy_system_network.rst:100 +msgid "" +"Selecting a bus or an energy system component in `es_bus_list`, " +"`es_component_list` or in `network_schema` allows the user to visualise " +"and/or edit its properties in another view-component." +msgstr "" + +#: ../../view_components/energy_system_network.rst:101 +msgid "" +"When a the user add a *Bus* or *energy system component* by clicking on " +"the `add_es_bus`/`add_es_component`, they can visualise and/or edit its " +"properties in another view-component." +msgstr "" + +#: ../../view_components/energy_system_network.rst:102 +msgid "" +"When a the user add a *Bus* or *energy system component* by clicking on " +"the `add_es_bus`/`add_es_component`, they can to see it in the " +"`network_schema`." +msgstr "" + +#: ../../view_components/energy_system_network.rst:105 +msgid "Requirements" +msgstr "" + +#: ../../view_components/energy_system_network.rst:107 +msgid "" +"If not defined by the user, an additional Sink component to dump excess " +"energy flow is defined and connected automatically to one *Bus* in the " +"*energy system network*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:108 +msgid "" +"If not defined by the user, an additional Source component to provide " +"slack energy flow is defined and connected automatically to one *Bus* in " +"the *energy system network*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:109 +msgid "" +"notifications informing the user about potential problems with their " +"energy system model should be displayed in the `error_log` text area. " +"Problems could be such as a failure to meet any of the other " +"requirements, an undefined property value of an *energy system " +"component*, or a *Bus* without connection to another *energy system " +"component*" +msgstr "" + +#: ../../view_components/energy_system_network.rst:113 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/energy_system_network.rst:114 +msgid ":ref:`es_component-label`" +msgstr "" + +#: ../../view_components/energy_system_network.rst:117 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/energy_system_network.rst:119 +msgid "" +"The buttons need to be visible at all time, as the selection of *energy " +"system components* or *Busses* can be done either from the lists " +"`es_bus_list`, `es_component_list` or from `network_schema`, they do not " +"necessarily need to be seen at the same time (they could be side by side " +"or accessible via tabs)" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/energy_system_sector_selector.mo b/docs/locale/de/LC_MESSAGES/view_components/energy_system_sector_selector.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/energy_system_sector_selector.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/energy_system_sector_selector.po b/docs/locale/de/LC_MESSAGES/view_components/energy_system_sector_selector.po new file mode 100755 index 0000000..916726e --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/energy_system_sector_selector.po @@ -0,0 +1,150 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/energy_system_sector_selector.rst:4 +msgid "Energy sector selector" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:6 +msgid "" +"The user can choose which :ref:`energy-type-def` they would like to use " +"in their energy system. This choice will impact which components of the " +"energy system model are available." +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:17 +msgid "**list of available energy sectors**" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:12 +msgid "Contains the possible energy sectors a user can choose from" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:17 +#: ../../view_components/energy_system_sector_selector.rst:25 +#: ../../view_components/energy_system_sector_selector.rst:33 +msgid "Properties:" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:15 +msgid "id `es_sector_avail_list`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:16 +#: ../../view_components/energy_system_sector_selector.rst:24 +msgid "each sector has an associated :ref:`energy-type-def`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:17 +#: ../../view_components/energy_system_sector_selector.rst:25 +msgid "each sector has an associated icon" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:25 +msgid "**list of selected energy sectors**" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:20 +msgid "Contains the choices selected by the user from the `es_sector_avail_list`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:23 +msgid "id `es_sector_select_list`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:33 +msgid "**list of connection between selected energy sectors**" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:28 +msgid "Indicates whether there is a coupling between two sectors" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:31 +msgid "id `es_sector_coupling_list`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:32 +msgid "each element is a list of two interconnected sectors" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:33 +msgid "an empty list means that all sectors are independent from each other" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:36 +msgid "Actions" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:38 +msgid "" +"The user can select the sector they want to include in their energy " +"system model from the `es_sector_avail_list` by clicking on the list item" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:39 +msgid "" +"The user should be able to indicate if two sectors are interconnected " +"(could be clicking on greyed-out line connecting sectors visually)" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:42 +msgid "Requirement" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:44 +msgid "" +"Any `es_sector_select_list` item has to be an item of " +"`es_sector_avail_list`." +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:48 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:51 +msgid ":ref:`es_network-label`" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:51 +msgid "" +"Only :ref:`es_component` compatible with the selected energy sectors can " +"be included in the energy system" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:54 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/energy_system_sector_selector.rst:55 +msgid "" +"Each sector in the list is represented by its icon. The energy sectors in" +" the `es_sector_select_list` are rendered in color and the remaining " +"energy sectors (in `es_sector_avail_list` but not in " +"`es_sector_select_list`) are rendered in shades of grey. Each sector is " +"visually connected to all the other sectors by a greyed-out line (no " +"active sector coupling). If the line is display in bright color (e.g. " +"after an activating click on it by the user) it means the two sectors are" +" interconnected directly." +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/export_project.mo b/docs/locale/de/LC_MESSAGES/view_components/export_project.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/export_project.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/export_project.po b/docs/locale/de/LC_MESSAGES/view_components/export_project.po new file mode 100755 index 0000000..f4e9cb3 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/export_project.po @@ -0,0 +1,133 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/export_project.rst:4 +msgid "Export project" +msgstr "" + +#: ../../view_components/export_project.rst:6 +msgid "This is not described yet" +msgstr "" + +#: ../../view_components/export_project.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/export_project.rst:23 +msgid "**Attribute A**" +msgstr "" + +#: ../../view_components/export_project.rst:14 +#: ../../view_components/export_project.rst:28 +msgid "Description" +msgstr "" + +#: ../../view_components/export_project.rst:19 +#: ../../view_components/export_project.rst:33 +msgid "Properties:" +msgstr "" + +#: ../../view_components/export_project.rst:17 +#: ../../view_components/export_project.rst:31 +msgid "Property 1" +msgstr "" + +#: ../../view_components/export_project.rst:18 +#: ../../view_components/export_project.rst:32 +msgid "..." +msgstr "" + +#: ../../view_components/export_project.rst:19 +#: ../../view_components/export_project.rst:33 +msgid "Property n" +msgstr "" + +#: ../../view_components/export_project.rst:21 +#: ../../view_components/export_project.rst:35 +msgid "Actions index:" +msgstr "" + +#: ../../view_components/export_project.rst:23 +#: ../../view_components/export_project.rst:37 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/export_project.rst:37 +msgid "**Attribute B**" +msgstr "" + +#: ../../view_components/export_project.rst:42 +msgid "Actions" +msgstr "" + +#: ../../view_components/export_project.rst:47 +msgid "Action 1" +msgstr "" + +#: ../../view_components/export_project.rst:48 +msgid "Action 2" +msgstr "" + +#: ../../view_components/export_project.rst:51 +msgid "Requirements" +msgstr "" + +#: ../../view_components/export_project.rst:59 +msgid "Requirement 1" +msgstr "" + +#: ../../view_components/export_project.rst:60 +msgid "Requirement 2" +msgstr "" + +#: ../../view_components/export_project.rst:63 +msgid "Link with views" +msgstr "" + +#: ../../view_components/export_project.rst:67 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/export_project.rst:67 +#: ../../view_components/export_project.rst:70 +#: ../../view_components/export_project.rst:77 +#: ../../view_components/export_project.rst:80 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/export_project.rst:70 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/export_project.rst:73 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/export_project.rst:77 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/export_project.rst:80 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/export_project.rst:83 +msgid "Rendering of the view-component" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/input_parameter_field.mo b/docs/locale/de/LC_MESSAGES/view_components/input_parameter_field.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/input_parameter_field.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/input_parameter_field.po b/docs/locale/de/LC_MESSAGES/view_components/input_parameter_field.po new file mode 100755 index 0000000..fa1b361 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/input_parameter_field.po @@ -0,0 +1,301 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/input_parameter_field.rst:4 +msgid "Input Parameter Field" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:6 +msgid "" +"This view-component enables the user input appropriate data in different " +"views." +msgstr "" + +#: ../../view_components/input_parameter_field.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:13 +msgid "**Label**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:12 +msgid "Name of the parameter which would be displayed close to the input field" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:18 +msgid "**Input Type**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:16 +msgid "" +"Type of input parameter. One of int, float, str, array of int, float or " +"str, matrix of int or float, timeseries (an array with timestamp mapped " +"to each values), csv file" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:18 +#: ../../view_components/input_parameter_field.rst:44 +msgid "Requirements index: 1" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:25 +msgid "**Input Unit**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:21 +msgid "Unit of the input parameter" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:23 +msgid "Actions index: 4" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:25 +msgid "Requirements index: 5" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:44 +msgid "**Input Field**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:28 +msgid "" +"An interactive GUI element via which the user can provide a value to the " +"input parameter." +msgstr "" + +#: ../../view_components/input_parameter_field.rst:30 +msgid "It depends on input type in the following way" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:32 +msgid "Numbers" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "Input type" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "Input field" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "int" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "Text input" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "float" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "str" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "array" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid ":ref:`load_input_dataseries-label`" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "matrix" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "timeseries" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:1 +msgid "csv file" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:49 +msgid "**Default/Placeholder Value**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:47 +msgid "The default value provided for each input parameter" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:49 +msgid "Actions index: 1" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:54 +msgid "**Link to Documentation**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:52 +msgid "" +"Hyperlink that leads the user to the full documentation of the input " +"parameter TODO: add link to RTD here" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:54 +msgid "Actions index: 3" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:62 +msgid "**Helper icon**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:57 +msgid "An image which can be used for rendering of this attribute" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:60 +msgid "Properties:" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:60 +msgid "path to the icon file" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:62 +#: ../../view_components/input_parameter_field.rst:67 +msgid "Actions index: 2" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:67 +msgid "**Helper Text**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:65 +msgid "" +"A brief description of the parameter with the type of inputs and " +"specifications, if any." +msgstr "" + +#: ../../view_components/input_parameter_field.rst:72 +msgid "**Boolean Mandatory Input**" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:70 +msgid "If true, the parameter must be defined by the user" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:72 +msgid "Requirements index: 2, 3" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:75 +msgid "Actions" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:76 +msgid "" +"User can overwrite the default/placeholder value in the input field by a " +"simple click" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:77 +msgid "" +"User can get brief information about the input parameter by hovering on " +"the helper icon" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:78 +msgid "" +"User can directly navigate to the relevant sections of the documentation " +"by clicking on the documentation link below the helper text (action 2. " +"need to be performed before this one)" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:79 +msgid "" +"User can choose unit amongst a list of generic units, or input it by " +"typing it in. (this is known as an editable combo box)" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:82 +msgid "Requirements" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:83 +msgid "" +"The field must change depending on the type of the input. Some inputs " +"could just be one numeric value, while others might be a series of values" +" in the form a CSV file" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:84 +msgid "" +"For mandatory input fields, the fields must be denoted by an asterisk " +"adjacent to the field" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:85 +msgid "" +"If the user does not provide input for a mandatory field and tries to " +"proceed further, the field should be highlighted so as to alert the user" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:86 +msgid "" +"The default/placeholder values for which the user has not provided any " +"own-input must be rendered differently than the values in input fields " +"with input objects supplied by the user" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:87 +msgid "" +"The physical units which are commonly used for energy and power should be" +" available there (then converted internally to Joule and Watt)" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:90 +msgid "Link with views" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:95 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:97 +msgid ":ref:`project_parameters-label`" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:99 +msgid ":ref:`scenario_parameters-label`" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:102 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/input_parameter_field.rst:104 +msgid "" +"The label is placed above the input field and the helper icon to the " +"right of the label. The helper text is displayed in a tooltip when user " +"hover over the helper icon. The link to documentation should be at the " +"bottom of the tooltip with the text \"More details...\". The rendering of" +" the input field is either a text input or a :ref:`load_input_dataseries-" +"label`. The parameter unit editable combobox is placed next to the input " +"field. An asterisk is placed next to the label (between label and helper " +"icon) if the parameter input is mandatory." +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/load_input_dataseries.mo b/docs/locale/de/LC_MESSAGES/view_components/load_input_dataseries.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/load_input_dataseries.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/load_input_dataseries.po b/docs/locale/de/LC_MESSAGES/view_components/load_input_dataseries.po new file mode 100755 index 0000000..bcb52ea --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/load_input_dataseries.po @@ -0,0 +1,205 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/load_input_dataseries.rst:4 +msgid "Load input data-series" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:6 +msgid "" +"User loads a file containing a data-series as input for a relevant " +"parameter and is able to quickly visualize the data." +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:13 +msgid "**Label**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:12 +msgid "Name of the parameter which would be displayed close to the input field" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:18 +msgid "**Input field**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:16 +#: ../../view_components/load_input_dataseries.rst:23 +msgid "Actions index: 1" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:18 +#: ../../view_components/load_input_dataseries.rst:30 +#: ../../view_components/load_input_dataseries.rst:35 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:25 +msgid "**Input Unit**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:21 +msgid "Unit of the input parameter" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:25 +msgid "Requirements index: 2" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:30 +msgid "**Load File button**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:28 +msgid "Actions index: 2" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:35 +msgid "**Visualize Data button**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:33 +msgid "Actions index: 3" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:40 +msgid "**Boolean Mandatory Input**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:38 +msgid "If true, the parameter must be defined by the user" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:40 +msgid "Requirements index: 3, 4" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:43 +msgid "Actions" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:45 +msgid "" +"User can directly provide the path of the file to be loaded as text in " +"the text field" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:46 +msgid "" +"Clicking on Load File button will open a pop-up window **(link the vc " +"(TBD) link here)**" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:47 +msgid "" +"Clicking on the Visualize Data button will open a pop-up window with a " +"table and plot of the data-series :ref:`visualize_dataseries-label`" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:48 +msgid "" +"User can choose unit amongst a list of generic units, or input it by " +"typing it in. (this is known as an editable combo box)" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:51 +msgid "Requirements" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:53 +msgid "" +"All parameters that require a data-series must be given input through " +"this view-component" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:54 +msgid "" +"The physical units which are commonly used for energy and power should be" +" available there (then converted internally to Joule and Watt)" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:55 +msgid "" +"For mandatory input fields, the fields must be denoted by an asterisk " +"adjacent to the field" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:56 +msgid "" +"If the user does not provide input for a mandatory field and tries to " +"proceed further, the field should be highlighted so as to alert the user" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:57 +msgid "" +"The Load File and Visualize Data buttons should be present adjacent to " +"the Input Field" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:60 +msgid "Link with views" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:63 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:63 +#: ../../view_components/load_input_dataseries.rst:66 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:66 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:69 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:73 +msgid ":ref:`input_parameter_field-label`" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:73 +msgid "Both the view-components share some attributes" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:76 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:79 +msgid ":ref:`visualize_dataseries-label`" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:79 +msgid "" +"A pop-up window displaying a sample of the input data-series file with a " +"plot of the data alongside" +msgstr "" + +#: ../../view_components/load_input_dataseries.rst:82 +msgid "Rendering of the view-component" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/load_project.mo b/docs/locale/de/LC_MESSAGES/view_components/load_project.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/load_project.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/load_project.po b/docs/locale/de/LC_MESSAGES/view_components/load_project.po new file mode 100755 index 0000000..2521bb7 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/load_project.po @@ -0,0 +1,133 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/load_project.rst:4 +msgid "Load project" +msgstr "" + +#: ../../view_components/load_project.rst:6 +msgid "This is not described yet" +msgstr "" + +#: ../../view_components/load_project.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/load_project.rst:23 +msgid "**Attribute A**" +msgstr "" + +#: ../../view_components/load_project.rst:14 +#: ../../view_components/load_project.rst:28 +msgid "Description" +msgstr "" + +#: ../../view_components/load_project.rst:19 +#: ../../view_components/load_project.rst:33 +msgid "Properties:" +msgstr "" + +#: ../../view_components/load_project.rst:17 +#: ../../view_components/load_project.rst:31 +msgid "Property 1" +msgstr "" + +#: ../../view_components/load_project.rst:18 +#: ../../view_components/load_project.rst:32 +msgid "..." +msgstr "" + +#: ../../view_components/load_project.rst:19 +#: ../../view_components/load_project.rst:33 +msgid "Property n" +msgstr "" + +#: ../../view_components/load_project.rst:21 +#: ../../view_components/load_project.rst:35 +msgid "Actions index:" +msgstr "" + +#: ../../view_components/load_project.rst:23 +#: ../../view_components/load_project.rst:37 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/load_project.rst:37 +msgid "**Attribute B**" +msgstr "" + +#: ../../view_components/load_project.rst:42 +msgid "Actions" +msgstr "" + +#: ../../view_components/load_project.rst:47 +msgid "Action 1" +msgstr "" + +#: ../../view_components/load_project.rst:48 +msgid "Action 2" +msgstr "" + +#: ../../view_components/load_project.rst:51 +msgid "Requirements" +msgstr "" + +#: ../../view_components/load_project.rst:59 +msgid "Requirement 1" +msgstr "" + +#: ../../view_components/load_project.rst:60 +msgid "Requirement 2" +msgstr "" + +#: ../../view_components/load_project.rst:63 +msgid "Link with views" +msgstr "" + +#: ../../view_components/load_project.rst:67 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/load_project.rst:67 +#: ../../view_components/load_project.rst:70 +#: ../../view_components/load_project.rst:77 +#: ../../view_components/load_project.rst:80 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/load_project.rst:70 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/load_project.rst:73 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/load_project.rst:77 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/load_project.rst:80 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/load_project.rst:83 +msgid "Rendering of the view-component" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/load_scenario.mo b/docs/locale/de/LC_MESSAGES/view_components/load_scenario.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/load_scenario.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/load_scenario.po b/docs/locale/de/LC_MESSAGES/view_components/load_scenario.po new file mode 100755 index 0000000..8932bd4 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/load_scenario.po @@ -0,0 +1,183 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/load_scenario.rst:4 +msgid "Load Scenario" +msgstr "" + +#: ../../view_components/load_scenario.rst:6 +msgid "This view-component enables the user to load a :ref:`scenario-label`." +msgstr "" + +#: ../../view_components/load_scenario.rst:10 +msgid "Attributes" +msgstr "" + +#: ../../view_components/load_scenario.rst:17 +msgid "**Scenario name text input**" +msgstr "" + +#: ../../view_components/load_scenario.rst:13 +msgid "The user must provide a file path for the scenario they want to load" +msgstr "" + +#: ../../view_components/load_scenario.rst:15 +msgid "Actions index: 2" +msgstr "" + +#: ../../view_components/load_scenario.rst:17 +#: ../../view_components/load_scenario.rst:24 +msgid "Requirements index: 1, 2, 3" +msgstr "" + +#: ../../view_components/load_scenario.rst:25 +msgid "**button** :guilabel:`&Browse`" +msgstr "" + +#: ../../view_components/load_scenario.rst:20 +msgid "" +"Triggers the selection the scenario name text input via a graphical file " +"structure" +msgstr "" + +#: ../../view_components/load_scenario.rst:22 +msgid "Actions index: 1" +msgstr "" + +#: ../../view_components/load_scenario.rst:32 +msgid "**button** :guilabel:`&Load`" +msgstr "" + +#: ../../view_components/load_scenario.rst:28 +msgid "The user triggers the creation of the scenario" +msgstr "" + +#: ../../view_components/load_scenario.rst:30 +msgid "Actions index: 3" +msgstr "" + +#: ../../view_components/load_scenario.rst:32 +msgid "Requirements index: 4, 5, 6" +msgstr "" + +#: ../../view_components/load_scenario.rst:35 +msgid "Actions" +msgstr "" + +#: ../../view_components/load_scenario.rst:37 +msgid "" +"User can navigate through the file system either graphically to input " +"scenario name by clicking on :guilabel:`&Browse`" +msgstr "" + +#: ../../view_components/load_scenario.rst:38 +msgid "User can input scenario name in the input text" +msgstr "" + +#: ../../view_components/load_scenario.rst:39 +msgid "" +"After clicking on :guilabel:`&Load`, a scenario is created in the backend" +" with loaded parameters. The user is redirected to the view corresponding" +" to the last step before running the simulation in the :ref" +":`progression_bar-label`" +msgstr "" + +#: ../../view_components/load_scenario.rst:42 +msgid "Requirements" +msgstr "" + +#: ../../view_components/load_scenario.rst:44 +msgid "" +"If user provided a scenario file/folder path which does not exist yet, an" +" error message should be displayed" +msgstr "" + +#: ../../view_components/load_scenario.rst:45 +msgid "" +"If user provided a scenario file/folder path which exists already, it " +"should be warned and given the option ot overwrite or not" +msgstr "" + +#: ../../view_components/load_scenario.rst:46 +msgid "" +"After the user clicked on :guilabel:`&Load`, they must still be able to " +"load another scenario through this view-component if they wish it" +msgstr "" + +#: ../../view_components/load_scenario.rst:47 +msgid "" +"When a scenario is loaded, it should be assigned a unique id in the " +"backend" +msgstr "" + +#: ../../view_components/load_scenario.rst:48 +msgid "" +"When a scenario is loaded, it should be possible for the user to access " +"and edit its input parameters" +msgstr "" + +#: ../../view_components/load_scenario.rst:52 +msgid "Link with views" +msgstr "" + +#: ../../view_components/load_scenario.rst:57 +msgid ":ref:`landing-label`" +msgstr "" + +#: ../../view_components/load_scenario.rst:56 +msgid "" +"It should be possible to trigger the display of this view-component from " +"the landing view" +msgstr "" + +#: ../../view_components/load_scenario.rst:62 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/load_scenario.rst:60 +msgid "" +"After clicking on :guilabel:`&Load`, the user is redirected to the view " +"corresponding to the last step before running the simulation in the :ref" +":`progression_bar-label` TODO add link to this view" +msgstr "" + +#: ../../view_components/load_scenario.rst:65 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/load_scenario.rst:70 +msgid ":ref:`menu_bar-label`" +msgstr "" + +#: ../../view_components/load_scenario.rst:69 +msgid "" +"It should be possible to trigger the display of this view-component from " +"a sub-menu of the :ref:`menu_bar-label`" +msgstr "" + +#: ../../view_components/load_scenario.rst:73 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/load_scenario.rst:75 +msgid "" +":guilabel:`&Browse` is on the right of the text input, the " +":guilabel:`&Load` is centered on the next line below" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/menu_bar.mo b/docs/locale/de/LC_MESSAGES/view_components/menu_bar.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/menu_bar.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/menu_bar.po b/docs/locale/de/LC_MESSAGES/view_components/menu_bar.po new file mode 100755 index 0000000..a3bc8d0 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/menu_bar.po @@ -0,0 +1,281 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/menu_bar.rst:4 +msgid "Menu Bar" +msgstr "" + +#: ../../view_components/menu_bar.rst:6 +msgid "Menu bar is a set of options linked to actions, or submenus." +msgstr "" + +#: ../../view_components/menu_bar.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/menu_bar.rst:14 +msgid "**The following are the menus available in the menu bar:**" +msgstr "" + +#: ../../view_components/menu_bar.rst:12 ../../view_components/menu_bar.rst:51 +msgid "File" +msgstr "" + +#: ../../view_components/menu_bar.rst:13 ../../view_components/menu_bar.rst:57 +msgid "Scenarios" +msgstr "" + +#: ../../view_components/menu_bar.rst:14 ../../view_components/menu_bar.rst:61 +msgid "Preferences" +msgstr "" + +#: ../../view_components/menu_bar.rst:15 ../../view_components/menu_bar.rst:70 +msgid "Help" +msgstr "" + +#: ../../view_components/menu_bar.rst:21 +msgid "***File* has the following submenus or options:**" +msgstr "" + +#: ../../view_components/menu_bar.rst:17 ../../view_components/menu_bar.rst:47 +msgid "Load project" +msgstr "" + +#: ../../view_components/menu_bar.rst:18 ../../view_components/menu_bar.rst:48 +msgid "New project" +msgstr "" + +#: ../../view_components/menu_bar.rst:19 ../../view_components/menu_bar.rst:49 +msgid "Save project" +msgstr "" + +#: ../../view_components/menu_bar.rst:20 ../../view_components/menu_bar.rst:50 +msgid "Save project as" +msgstr "" + +#: ../../view_components/menu_bar.rst:21 +msgid "Export project" +msgstr "" + +#: ../../view_components/menu_bar.rst:22 ../../view_components/menu_bar.rst:52 +msgid "Exit open_plan" +msgstr "" + +#: ../../view_components/menu_bar.rst:27 +msgid "***Scenarios* has the following submenus:**" +msgstr "" + +#: ../../view_components/menu_bar.rst:24 +msgid "New scenario" +msgstr "" + +#: ../../view_components/menu_bar.rst:25 +msgid "Load scenario" +msgstr "" + +#: ../../view_components/menu_bar.rst:26 +msgid "Compare scenarios" +msgstr "" + +#: ../../view_components/menu_bar.rst:27 ../../view_components/menu_bar.rst:57 +msgid "---- (separating horizontal line)" +msgstr "" + +#: ../../view_components/menu_bar.rst:28 ../../view_components/menu_bar.rst:58 +msgid "List of scenarios in the system" +msgstr "" + +#: ../../view_components/menu_bar.rst:31 +msgid "***Preferences* has the following submenus:**" +msgstr "" + +#: ../../view_components/menu_bar.rst:30 +msgid "Language" +msgstr "" + +#: ../../view_components/menu_bar.rst:31 ../../view_components/menu_bar.rst:61 +msgid "Display" +msgstr "" + +#: ../../view_components/menu_bar.rst:32 +msgid "Display welcome view" +msgstr "" + +#: ../../view_components/menu_bar.rst:39 +msgid "***Help* has the following submenus:**" +msgstr "" + +#: ../../view_components/menu_bar.rst:34 +msgid "Read documentation" +msgstr "" + +#: ../../view_components/menu_bar.rst:35 +msgid "Examples and use cases" +msgstr "" + +#: ../../view_components/menu_bar.rst:36 +msgid "Contact developers" +msgstr "" + +#: ../../view_components/menu_bar.rst:37 +msgid "Feedback" +msgstr "" + +#: ../../view_components/menu_bar.rst:38 +msgid "License information" +msgstr "" + +#: ../../view_components/menu_bar.rst:39 +msgid "About open_plan..." +msgstr "" + +#: ../../view_components/menu_bar.rst:42 +msgid "Actions" +msgstr "" + +#: ../../view_components/menu_bar.rst:44 +msgid "" +"Clicking on any of the menus' option results in a drop-down list of sub-" +"menu's options if applicable, otherwise trigger an action" +msgstr "" + +#: ../../view_components/menu_bar.rst:51 +msgid "Export project: display :ref:`export_project-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:54 +msgid "New scenario: display :ref:`create_scenario-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:55 +msgid "Load scenario: display :ref:`load_scenario-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:56 +msgid "Compare scenarios: display view :ref:`scenario_comparison-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:60 +msgid "Language: not sure whether this will be implemented" +msgstr "" + +#: ../../view_components/menu_bar.rst:62 +msgid "Display welcome view: display :ref:`welcome-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:64 +msgid "" +"Read documentation: redirect to `ReadTheDocs documentation `_" +msgstr "" + +#: ../../view_components/menu_bar.rst:65 +msgid "Examples and use cases: redirect to ReadTheDocs usecases TODO: add link" +msgstr "" + +#: ../../view_components/menu_bar.rst:66 +msgid "" +"Contact developers: redirect to `Github issues `_" +msgstr "" + +#: ../../view_components/menu_bar.rst:67 +msgid "" +"Feedback redirect to `Github issues `_" +msgstr "" + +#: ../../view_components/menu_bar.rst:68 +msgid "" +"License information: redirect to `Github license `_" +msgstr "" + +#: ../../view_components/menu_bar.rst:69 +msgid "About open_plan...: redirect to open_plan website TODO: add link" +msgstr "" + +#: ../../view_components/menu_bar.rst:73 +msgid "Requirement" +msgstr "" + +#: ../../view_components/menu_bar.rst:75 +msgid "" +"The menu/submenu's options that are not applicable are greyed out or " +"inactive and thus, nothing happens when clicked upon" +msgstr "" + +#: ../../view_components/menu_bar.rst:78 +msgid "Link with views" +msgstr "" + +#: ../../view_components/menu_bar.rst:80 +msgid ":ref:`scenario_comparison-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:84 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/menu_bar.rst:87 +msgid ":ref:`welcome-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:87 +msgid "" +"The welcome view-component can be re-enabled if it was disabled by the " +"user from appearing everytime the tool is launched." +msgstr "" + +#: ../../view_components/menu_bar.rst:89 +msgid ":ref:`progression_bar-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:91 +msgid ":ref:`export_project-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:93 +msgid ":ref:`create_scenario-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:95 +msgid ":ref:`load_scenario-label`" +msgstr "" + +#: ../../view_components/menu_bar.rst:99 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/menu_bar.rst:101 +msgid "" +"Rectangular drop-down menu buttons present on a horizontal bar on top of " +"the :ref:`main-window-def`" +msgstr "" + +#: ../../view_components/menu_bar.rst:102 +msgid "Rendered on every view of the tool UI" +msgstr "" + +#: ../../view_components/menu_bar.rst:103 +msgid "" +"The current scenario is highlighted in the drop-down list which results " +"when the *Scenarios* menu is clicked" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/progression_bar.mo b/docs/locale/de/LC_MESSAGES/view_components/progression_bar.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/progression_bar.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/progression_bar.po b/docs/locale/de/LC_MESSAGES/view_components/progression_bar.po new file mode 100755 index 0000000..5c3e605 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/progression_bar.po @@ -0,0 +1,206 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/progression_bar.rst:4 +msgid "Progression Bar" +msgstr "" + +#: ../../view_components/progression_bar.rst:6 +msgid "" +"The Progression Bar displays the sequential steps the user should go " +"through, in order to provide the input parameters required to describe an" +" energy system and a :ref:`scenario-label` to simulate with this energy " +"system model" +msgstr "" + +#: ../../view_components/progression_bar.rst:8 +msgid "This view-component allows the user to:" +msgstr "" + +#: ../../view_components/progression_bar.rst:10 +msgid "" +"Sequentially progress through the modeling and definition of their :ref" +":`scenario-label`" +msgstr "" + +#: ../../view_components/progression_bar.rst:11 +msgid "Jump directly to previous steps to edit input parameters" +msgstr "" + +#: ../../view_components/progression_bar.rst:14 +msgid "Attributes" +msgstr "" + +#: ../../view_components/progression_bar.rst:31 +msgid "**List of steps**" +msgstr "" + +#: ../../view_components/progression_bar.rst:17 +msgid "For example the following steps:" +msgstr "" + +#: ../../view_components/progression_bar.rst:19 +msgid "Project Setup" +msgstr "" + +#: ../../view_components/progression_bar.rst:20 +msgid "Inputs" +msgstr "" + +#: ../../view_components/progression_bar.rst:21 +msgid "System Inputs" +msgstr "" + +#: ../../view_components/progression_bar.rst:22 +msgid "Visualization" +msgstr "" + +#: ../../view_components/progression_bar.rst:23 +msgid "Constraints" +msgstr "" + +#: ../../view_components/progression_bar.rst:24 +msgid "Simulations" +msgstr "" + +#: ../../view_components/progression_bar.rst:25 +msgid "Results" +msgstr "" + +#: ../../view_components/progression_bar.rst:29 +msgid "Properties:" +msgstr "" + +#: ../../view_components/progression_bar.rst:28 +msgid "" +"Each step has an associated index (starting from 1), corresponding to its" +" position in the list of steps" +msgstr "" + +#: ../../view_components/progression_bar.rst:29 +msgid "Each step in the progression bar is a link to a :ref:`view `" +msgstr "" + +#: ../../view_components/progression_bar.rst:31 +msgid "Actions index: 1, 2" +msgstr "" + +#: ../../view_components/progression_bar.rst:37 +msgid "**Current step index**" +msgstr "" + +#: ../../view_components/progression_bar.rst:34 +msgid "The index of the currently selected step" +msgstr "" + +#: ../../view_components/progression_bar.rst:36 +msgid "Requirements index: 1" +msgstr "" + +#: ../../view_components/progression_bar.rst:40 +msgid "Actions" +msgstr "" + +#: ../../view_components/progression_bar.rst:42 +msgid "" +"Clicking on a step that has already been fulfilled, allows the user to " +"make modifications to the inputs within this field" +msgstr "" + +#: ../../view_components/progression_bar.rst:43 +msgid "" +"Clicking on a step which is disabled, make a small text bubble appear " +"next to the step explaining why the user cannot click on that step" +msgstr "" + +#: ../../view_components/progression_bar.rst:46 +msgid "Requirement" +msgstr "" + +#: ../../view_components/progression_bar.rst:48 +msgid "" +"To enable the next step, the user has to fulfill the requirements of the " +"current step. Each step's requirements are defined in its respective " +":ref:`view `" +msgstr "" + +#: ../../view_components/progression_bar.rst:51 +msgid "Link with views" +msgstr "" + +#: ../../view_components/progression_bar.rst:53 +msgid "Here will be a link to the views of each steps" +msgstr "" + +#: ../../view_components/progression_bar.rst:56 +msgid ":ref:`landing-label`" +msgstr "" + +#: ../../view_components/progression_bar.rst:56 +msgid "" +"It is not sure yet whether this view-component should be visible from " +"start, join the on-going discussion `here `_" +msgstr "" + +#: ../../view_components/progression_bar.rst:59 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/progression_bar.rst:61 +msgid ":ref:`menu_bar-label`" +msgstr "" + +#: ../../view_components/progression_bar.rst:65 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/progression_bar.rst:67 +msgid "" +"Ribbon-like display of the progression bar where each step is delimited " +"by an individual blob, the structure is identical throughout the " +"different views. The term blob is employed to signify that the shape is " +"up to a decision (non-exhaustive list of examples: a rectangle, an " +"ellipse, a circle, an arrow)" +msgstr "" + +#: ../../view_components/progression_bar.rst:68 +msgid "" +"Indication of the steps order could be with arrow shaped blob, or with " +"arrow symbols between the blobs" +msgstr "" + +#: ../../view_components/progression_bar.rst:69 +msgid "" +"Color coding of the blobs backgrounds can be used to indicate whether the" +" step has already be visited, is not fulfilled yet, disabled or enabled" +msgstr "" + +#: ../../view_components/progression_bar.rst:70 +msgid "" +"The progression bar could be horizontal or vertical (it is assumed from " +"left to right and top to bottom, but this can be debated)" +msgstr "" + +#: ../../view_components/progression_bar.rst:72 +msgid "" +"Here is an example of one possible rendering, please note that this is " +"not a final design, only an example" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/project_list.mo b/docs/locale/de/LC_MESSAGES/view_components/project_list.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/project_list.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/project_list.po b/docs/locale/de/LC_MESSAGES/view_components/project_list.po new file mode 100755 index 0000000..8ee70ac --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/project_list.po @@ -0,0 +1,140 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/project_list.rst:4 +msgid "List of Projects" +msgstr "" + +#: ../../view_components/project_list.rst:6 +msgid "" +"This view-component displays a list of open_plan project (or project " +"files in accepted formats) objects one of which can can be loaded as the " +"current project." +msgstr "" + +#: ../../view_components/project_list.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/project_list.rst:14 +msgid "**Select**" +msgstr "" + +#: ../../view_components/project_list.rst:14 +msgid "" +"Allows the user to select the project object to be loaded as the current " +"project" +msgstr "" + +#: ../../view_components/project_list.rst:17 +msgid "**Delete**" +msgstr "" + +#: ../../view_components/project_list.rst:17 +msgid "Allows the user to delete the saved project object from the disk" +msgstr "" + +#: ../../view_components/project_list.rst:20 +msgid "**Show**" +msgstr "" + +#: ../../view_components/project_list.rst:20 +msgid "Allows the user to quickly preview the project object selected" +msgstr "" + +#: ../../view_components/project_list.rst:23 +msgid "**Edit**" +msgstr "" + +#: ../../view_components/project_list.rst:23 +msgid "Allows the user to quickly edit the main project parameters" +msgstr "" + +#: ../../view_components/project_list.rst:26 +msgid "Actions" +msgstr "" + +#: ../../view_components/project_list.rst:31 +msgid "Action 1" +msgstr "" + +#: ../../view_components/project_list.rst:32 +msgid "Action 2" +msgstr "" + +#: ../../view_components/project_list.rst:35 +msgid "Requirements" +msgstr "" + +#: ../../view_components/project_list.rst:43 +msgid "Requirement 1" +msgstr "" + +#: ../../view_components/project_list.rst:44 +msgid "Requirement 2" +msgstr "" + +#: ../../view_components/project_list.rst:47 +msgid "Link with views" +msgstr "" + +#: ../../view_components/project_list.rst:51 +msgid ":ref:`landing-label`" +msgstr "" + +#: ../../view_components/project_list.rst:51 +msgid "Landing page view of which this view-component is a part of" +msgstr "" + +#: ../../view_components/project_list.rst:54 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/project_list.rst:57 +msgid ":ref:`project-label`" +msgstr "" + +#: ../../view_components/project_list.rst:57 +msgid "The abstract component describing the project object" +msgstr "" + +#: ../../view_components/project_list.rst:61 +msgid ":ref:`read_write_files-label`" +msgstr "" + +#: ../../view_components/project_list.rst:60 +msgid "" +"VIew-component through which the project objects could be loaded from the" +" disk or written to the disk" +msgstr "" + +#: ../../view_components/project_list.rst:64 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/project_list.rst:66 +msgid "" +"Rendered as a list which displays all the project objects already saved " +"in the system or currently created" +msgstr "" + +#: ../../view_components/project_list.rst:68 +msgid "Currently selected project is highlighted separately" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/project_location.mo b/docs/locale/de/LC_MESSAGES/view_components/project_location.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/project_location.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/project_location.po b/docs/locale/de/LC_MESSAGES/view_components/project_location.po new file mode 100755 index 0000000..af42c0c --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/project_location.po @@ -0,0 +1,112 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/project_location.rst:4 +msgid "Map with Project Location" +msgstr "" + +#: ../../view_components/project_location.rst:6 +msgid "A rectangular container that contains an interactive map." +msgstr "" + +#: ../../view_components/project_location.rst:8 +msgid "This can be implemented for eg., with Leaflet or Folium libraries." +msgstr "" + +#: ../../view_components/project_location.rst:11 +msgid "Attributes" +msgstr "" + +#: ../../view_components/project_location.rst:18 +msgid "**Project area highlighted**" +msgstr "" + +#: ../../view_components/project_location.rst:14 +msgid "" +"The project area, obtained using coordinates supplied by the user and " +"energy cell area, should be highlighted on the map as a polygon." +msgstr "" + +#: ../../view_components/project_location.rst:16 +msgid "Actions index: 1" +msgstr "" + +#: ../../view_components/project_location.rst:18 +msgid "Requirements index: 1" +msgstr "" + +#: ../../view_components/project_location.rst:21 +msgid "Actions" +msgstr "" + +#: ../../view_components/project_location.rst:23 +msgid "User can zoom in, zoom out, pan around using the input from their mouse" +msgstr "" + +#: ../../view_components/project_location.rst:26 +msgid "Requirements" +msgstr "" + +#: ../../view_components/project_location.rst:28 +msgid "" +"User must provide the project location coordinates and energy cell area " +"parameters in :ref:`load_project_parameters-label`" +msgstr "" + +#: ../../view_components/project_location.rst:31 +msgid "Link with views" +msgstr "" + +#: ../../view_components/project_location.rst:35 +msgid ":ref:`project_parameters-label`" +msgstr "" + +#: ../../view_components/project_location.rst:35 +msgid "" +"The parameters necessary to generate the project location map view-" +"component are input by the user through this view-component" +msgstr "" + +#: ../../view_components/project_location.rst:38 +msgid ":ref:`load_project_parameters-label`" +msgstr "" + +#: ../../view_components/project_location.rst:38 +#: ../../view_components/project_location.rst:44 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/project_location.rst:41 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/project_location.rst:44 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/project_location.rst:47 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/project_location.rst:49 +msgid "" +"As a rectangular container displaying an interactive map of the project " +"location highlighted as either a point or as a polygonal area on the map." +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/project_parameters.mo b/docs/locale/de/LC_MESSAGES/view_components/project_parameters.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/project_parameters.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/project_parameters.po b/docs/locale/de/LC_MESSAGES/view_components/project_parameters.po new file mode 100755 index 0000000..89ee866 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/project_parameters.po @@ -0,0 +1,155 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/project_parameters.rst:4 +msgid "Project parameters" +msgstr "" + +#: ../../view_components/project_parameters.rst:6 +msgid "Inputs parameters to set the context of the project." +msgstr "" + +#: ../../view_components/project_parameters.rst:10 +msgid "Attributes" +msgstr "" + +#: ../../view_components/project_parameters.rst:12 +msgid "**List of input parameters**" +msgstr "" + +#: ../../view_components/project_parameters.rst:14 +msgid "" +"Each input parameter will be available to the user via :ref" +":`input_parameter_field-label`" +msgstr "" + +#: ../../view_components/project_parameters.rst:22 +msgid "Properties of each input:" +msgstr "" + +#: ../../view_components/project_parameters.rst:17 +msgid "Input type" +msgstr "" + +#: ../../view_components/project_parameters.rst:18 +msgid "Input default value" +msgstr "" + +#: ../../view_components/project_parameters.rst:19 +msgid "Help text" +msgstr "" + +#: ../../view_components/project_parameters.rst:20 +msgid "If it is mandatory or optional" +msgstr "" + +#: ../../view_components/project_parameters.rst:21 +msgid "Link in documentation" +msgstr "" + +#: ../../view_components/project_parameters.rst:24 +msgid "" +"As the parameters in this list should also be accessible in a more " +"general parameter documentation in ReadTheDocs, they will be " +"automatically listed here from either a .yml or csv file." +msgstr "" + +#: ../../view_components/project_parameters.rst:26 +msgid "The following inputs stay here for the moment and will be reformated then" +msgstr "" + +#: ../../view_components/project_parameters.rst:29 +msgid "Localisation" +msgstr "" + +#: ../../view_components/project_parameters.rst +msgid "The geographical localisation of the project." +msgstr "" + +#: ../../view_components/project_parameters.rst +msgid "This can allow to download appropriate dataset." +msgstr "" + +#: ../../view_components/project_parameters.rst:31 +msgid "Project lifetime" +msgstr "" + +#: ../../view_components/project_parameters.rst:32 +#: ../../view_components/project_parameters.rst:34 +msgid "This can be used for calculations?" +msgstr "" + +#: ../../view_components/project_parameters.rst:33 +msgid "Weighted Average Cost of Capital" +msgstr "" + +#: ../../view_components/project_parameters.rst:35 +msgid "Project name" +msgstr "" + +#: ../../view_components/project_parameters.rst:36 +msgid "Give a name to that project." +msgstr "" + +#: ../../view_components/project_parameters.rst:38 +msgid "Project description (optional)" +msgstr "" + +#: ../../view_components/project_parameters.rst:38 +msgid "Give a short description of the project" +msgstr "" + +#: ../../view_components/project_parameters.rst:41 +msgid "Actions" +msgstr "" + +#: ../../view_components/project_parameters.rst:42 +msgid "User can edit the value of the input parameters manually." +msgstr "" + +#: ../../view_components/project_parameters.rst:43 +msgid "" +"User can edit the value of the input parameters by loading a project from" +" :ref:`load_project-label`" +msgstr "" + +#: ../../view_components/project_parameters.rst:47 +msgid "Requirement" +msgstr "" + +#: ../../view_components/project_parameters.rst:48 +msgid "" +"The requirements of :ref:`input_parameter_field-label` apply for each " +"input parameter" +msgstr "" + +#: ../../view_components/project_parameters.rst:51 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/project_parameters.rst:54 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/project_parameters.rst:55 +msgid "" +"The rendering of :ref:`input_parameter_field-label` apply for each input " +"parameter" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/read_write_files.mo b/docs/locale/de/LC_MESSAGES/view_components/read_write_files.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/read_write_files.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/read_write_files.po b/docs/locale/de/LC_MESSAGES/view_components/read_write_files.po new file mode 100755 index 0000000..ae3596c --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/read_write_files.po @@ -0,0 +1,137 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/read_write_files.rst:4 +msgid "Read/Write Files" +msgstr "" + +#: ../../view_components/read_write_files.rst:6 +msgid "File explorer to read and write files to the system storage." +msgstr "" + +#: ../../view_components/read_write_files.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/read_write_files.rst:21 +msgid "**Attribute A**" +msgstr "" + +#: ../../view_components/read_write_files.rst:12 +#: ../../view_components/read_write_files.rst:26 +msgid "Description" +msgstr "" + +#: ../../view_components/read_write_files.rst:17 +#: ../../view_components/read_write_files.rst:31 +msgid "Properties:" +msgstr "" + +#: ../../view_components/read_write_files.rst:15 +#: ../../view_components/read_write_files.rst:29 +msgid "Property 1" +msgstr "" + +#: ../../view_components/read_write_files.rst:16 +#: ../../view_components/read_write_files.rst:30 +msgid "..." +msgstr "" + +#: ../../view_components/read_write_files.rst:17 +#: ../../view_components/read_write_files.rst:31 +msgid "Property n" +msgstr "" + +#: ../../view_components/read_write_files.rst:19 +#: ../../view_components/read_write_files.rst:33 +msgid "Actions index:" +msgstr "" + +#: ../../view_components/read_write_files.rst:21 +#: ../../view_components/read_write_files.rst:35 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/read_write_files.rst:35 +msgid "**Attribute B**" +msgstr "" + +#: ../../view_components/read_write_files.rst:40 +msgid "Actions" +msgstr "" + +#: ../../view_components/read_write_files.rst:45 +msgid "Action 1" +msgstr "" + +#: ../../view_components/read_write_files.rst:46 +msgid "Action 2" +msgstr "" + +#: ../../view_components/read_write_files.rst:49 +msgid "Requirements" +msgstr "" + +#: ../../view_components/read_write_files.rst:57 +msgid "Requirement 1" +msgstr "" + +#: ../../view_components/read_write_files.rst:58 +msgid "Requirement 2" +msgstr "" + +#: ../../view_components/read_write_files.rst:61 +msgid "Link with views" +msgstr "" + +#: ../../view_components/read_write_files.rst:65 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/read_write_files.rst:65 +#: ../../view_components/read_write_files.rst:68 +#: ../../view_components/read_write_files.rst:75 +#: ../../view_components/read_write_files.rst:78 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/read_write_files.rst:68 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/read_write_files.rst:71 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/read_write_files.rst:75 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/read_write_files.rst:78 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/read_write_files.rst:81 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/read_write_files.rst:83 +msgid "Rendered as a pop-up" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/scenario_list.mo b/docs/locale/de/LC_MESSAGES/view_components/scenario_list.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/scenario_list.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/scenario_list.po b/docs/locale/de/LC_MESSAGES/view_components/scenario_list.po new file mode 100755 index 0000000..6d3903a --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/scenario_list.po @@ -0,0 +1,146 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/scenario_list.rst:4 +msgid "List of Scenarios" +msgstr "" + +#: ../../view_components/scenario_list.rst:6 +msgid "" +"This view-component shows the list of scenario objects, both created " +"through the tool within the current project or loaded from file, " +"available for further steps in the simulation." +msgstr "" + +#: ../../view_components/scenario_list.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/scenario_list.rst:12 +msgid "**Select**" +msgstr "" + +#: ../../view_components/scenario_list.rst:12 +msgid "" +"Allows the user to select the scenario object to be loaded as the current" +" project" +msgstr "" + +#: ../../view_components/scenario_list.rst:15 +msgid "**Delete**" +msgstr "" + +#: ../../view_components/scenario_list.rst:15 +msgid "Allows the user to delete the saved scenario object from the disk" +msgstr "" + +#: ../../view_components/scenario_list.rst:18 +msgid "**Show**" +msgstr "" + +#: ../../view_components/scenario_list.rst:18 +msgid "Allows the user to quickly preview the scenario object selected" +msgstr "" + +#: ../../view_components/scenario_list.rst:21 +msgid "**Edit**" +msgstr "" + +#: ../../view_components/scenario_list.rst:21 +msgid "Allows the user to quickly edit the main scenario parameters" +msgstr "" + +#: ../../view_components/scenario_list.rst:24 +msgid "Actions" +msgstr "" + +#: ../../view_components/scenario_list.rst:26 +msgid "Select the current scenario object" +msgstr "" + +#: ../../view_components/scenario_list.rst:27 +msgid "" +"Show the main parameters of any scenario object that the user selects in " +"the list of scenarios" +msgstr "" + +#: ../../view_components/scenario_list.rst:28 +msgid "" +"View the list of scenarios objects created in the present project or " +"available on the disk" +msgstr "" + +#: ../../view_components/scenario_list.rst:29 +msgid "Delete a scenario object, both saved and unsaved ones" +msgstr "" + +#: ../../view_components/scenario_list.rst:32 +msgid "Requirements" +msgstr "" + +#: ../../view_components/scenario_list.rst:40 +msgid "Requirement 1" +msgstr "" + +#: ../../view_components/scenario_list.rst:41 +msgid "Requirement 2" +msgstr "" + +#: ../../view_components/scenario_list.rst:44 +msgid "Link with views" +msgstr "" + +#: ../../view_components/scenario_list.rst:48 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/scenario_list.rst:51 +msgid ":ref:`scenario-label`" +msgstr "" + +#: ../../view_components/scenario_list.rst:51 +msgid "" +"The abstract component describing the scenario objects part of this view-" +"component" +msgstr "" + +#: ../../view_components/scenario_list.rst:54 +msgid ":ref:`read_write_files-label`" +msgstr "" + +#: ../../view_components/scenario_list.rst:54 +msgid "" +"VIew-component through which the project objects could be loaded from the" +" disk or written to the disk" +msgstr "" + +#: ../../view_components/scenario_list.rst:57 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/scenario_list.rst:59 +msgid "" +"Rendered as a list which displays all the scenario objects loaded and/or " +"created in the current project" +msgstr "" + +#: ../../view_components/scenario_list.rst:61 +msgid "Currently selected scenario is highlighted separately" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/scenario_parameters.mo b/docs/locale/de/LC_MESSAGES/view_components/scenario_parameters.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/scenario_parameters.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/scenario_parameters.po b/docs/locale/de/LC_MESSAGES/view_components/scenario_parameters.po new file mode 100755 index 0000000..4ef3a27 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/scenario_parameters.po @@ -0,0 +1,112 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/scenario_parameters.rst:4 +msgid "Scenario parameters" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:5 +msgid "" +"Inputs parameters to describe a :ref:`scenario-label`. They do not " +"contain the information about the energy system, which is defined in the " +":ref:`es_network` view-component." +msgstr "" + +#: ../../view_components/scenario_parameters.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:11 +msgid "**List of input parameters**" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:13 +msgid "" +"Each input parameter will be available to the user via :ref" +":`input_parameter_field-label`" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:21 +msgid "Properties of each input:" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:16 +msgid "Input type" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:17 +msgid "Input default value" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:18 +msgid "Help text" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:19 +msgid "If it is mandatory or optional" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:20 +msgid "Link in documentation" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:23 +msgid "" +"You can browse through the list of different :ref:`input " +"parameters`" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:26 +msgid "Actions" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:27 +msgid "User can edit the value of the input parameters manually." +msgstr "" + +#: ../../view_components/scenario_parameters.rst:28 +msgid "" +"User can edit the value of the input parameters by loading a scenario " +"from :ref:`load_scenario-label`" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:32 +msgid "Requirement" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:33 +msgid "" +"The requirements of :ref:`input_parameter_field-label` apply for each " +"input parameter" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:36 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:39 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/scenario_parameters.rst:40 +msgid "" +"The rendering of :ref:`input_parameter_field-label` apply for each input " +"parameter" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/view_component_template.mo b/docs/locale/de/LC_MESSAGES/view_components/view_component_template.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/view_component_template.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/view_component_template.po b/docs/locale/de/LC_MESSAGES/view_components/view_component_template.po new file mode 100755 index 0000000..e81a8eb --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/view_component_template.po @@ -0,0 +1,129 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/view_component_template.rst:17 +msgid "" +msgstr "" + +#: ../../view_components/view_component_template.rst:20 +msgid "Attributes" +msgstr "" + +#: ../../view_components/view_component_template.rst:34 +msgid "**Attribute A**" +msgstr "" + +#: ../../view_components/view_component_template.rst:25 +#: ../../view_components/view_component_template.rst:39 +msgid "Description" +msgstr "" + +#: ../../view_components/view_component_template.rst:30 +#: ../../view_components/view_component_template.rst:44 +msgid "Properties:" +msgstr "" + +#: ../../view_components/view_component_template.rst:28 +#: ../../view_components/view_component_template.rst:42 +msgid "Property 1" +msgstr "" + +#: ../../view_components/view_component_template.rst:29 +#: ../../view_components/view_component_template.rst:43 +msgid "..." +msgstr "" + +#: ../../view_components/view_component_template.rst:30 +#: ../../view_components/view_component_template.rst:44 +msgid "Property n" +msgstr "" + +#: ../../view_components/view_component_template.rst:32 +#: ../../view_components/view_component_template.rst:46 +msgid "Actions index:" +msgstr "" + +#: ../../view_components/view_component_template.rst:34 +#: ../../view_components/view_component_template.rst:48 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/view_component_template.rst:48 +msgid "**Attribute B**" +msgstr "" + +#: ../../view_components/view_component_template.rst:53 +msgid "Actions" +msgstr "" + +#: ../../view_components/view_component_template.rst:58 +msgid "Action 1" +msgstr "" + +#: ../../view_components/view_component_template.rst:59 +msgid "Action 2" +msgstr "" + +#: ../../view_components/view_component_template.rst:62 +msgid "Requirements" +msgstr "" + +#: ../../view_components/view_component_template.rst:70 +msgid "Requirement 1" +msgstr "" + +#: ../../view_components/view_component_template.rst:71 +msgid "Requirement 2" +msgstr "" + +#: ../../view_components/view_component_template.rst:74 +msgid "Link with views" +msgstr "" + +#: ../../view_components/view_component_template.rst:78 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/view_component_template.rst:78 +#: ../../view_components/view_component_template.rst:81 +#: ../../view_components/view_component_template.rst:88 +#: ../../view_components/view_component_template.rst:91 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/view_component_template.rst:81 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/view_component_template.rst:84 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/view_component_template.rst:88 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/view_component_template.rst:91 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/view_component_template.rst:94 +msgid "Rendering of the view-component" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/view_specific_documentation.mo b/docs/locale/de/LC_MESSAGES/view_components/view_specific_documentation.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/view_specific_documentation.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/view_specific_documentation.po b/docs/locale/de/LC_MESSAGES/view_components/view_specific_documentation.po new file mode 100755 index 0000000..f1b2b2c --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/view_specific_documentation.po @@ -0,0 +1,180 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/view_specific_documentation.rst:4 +msgid "View Specific Documentation" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:6 +msgid "" +"This view-component lets the user access the specific sections of the " +"documentation directly from within the tool UI. It serves as a tooltip " +"for input parameters." +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:16 +msgid "**Scroll Bar**" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:12 +msgid "This bar lets the user navigate the documentation content" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:14 +msgid "Actions index: 1" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:16 +#: ../../view_components/view_specific_documentation.rst:31 +msgid "Requirements index:" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:21 +msgid "**Side navigation pane**" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:19 +msgid "" +"This navigation pane is akin to a table of contents and lets the user " +"jump to other sections of the documentation quickly" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:21 +msgid "Actions index: 2" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:24 +msgid "**Content**" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:24 +msgid "" +"Content of the documentation such as text, images, hyperlinks, etc., to " +"be rendered" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:31 +msgid "**button** :guilabel:`&Download PDF`" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:27 +msgid "Clicking this triggers the download of a pdf of the documentation" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:29 +msgid "Actions index: 3" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:34 +msgid "Actions" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:36 +msgid "User can scroll through the documentation using the scroll bar" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:37 +msgid "" +"User can jump to other sections of the documentation using the links in " +"the navigation pane" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:38 +msgid "" +"User can click on the Download PDF button to obtain a local copy of the " +"documentation" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:41 +msgid "Requirements" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:43 +msgid "" +"User must be able to open this view-component through clicking on links " +"next to various elements in other views/view-components" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:46 +msgid "Link with views" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:50 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:53 +msgid ":ref:`welcome-label`" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:53 +msgid "" +"First view-component on the landing view of the tool, seen by the user. " +"Contains link to documentation" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:56 +msgid ":ref:`input_parameter_field-label`" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:56 +msgid "" +"Generic view-component that describes the fields where user inputs are " +"necessary" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:59 +msgid ":ref:`load_input_parameter-label`" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:59 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:62 +msgid ":ref:`scenario_parameters-label`" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:62 +msgid "View-component where the user inputs the scenario-specific parameters" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:65 +msgid ":ref:`project_parameters-label`" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:65 +msgid "View-component where the user inputs the project parameters" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:68 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/view_specific_documentation.rst:70 +msgid "" +"This view-component could either be a pop-up on top of the view the user " +"is currently in, or as a new tab on a browser window opening relevant " +"sections of readthedocs directly" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/visualize_dataseries.mo b/docs/locale/de/LC_MESSAGES/view_components/visualize_dataseries.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/visualize_dataseries.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/visualize_dataseries.po b/docs/locale/de/LC_MESSAGES/view_components/visualize_dataseries.po new file mode 100755 index 0000000..e2e5276 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/visualize_dataseries.po @@ -0,0 +1,113 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/visualize_dataseries.rst:4 +msgid "Visualize data-series" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:6 +msgid "" +"This view-component helps the user visualize the dataset they load into " +"the tool in order to cross-check for any issues with the provided " +"dataset." +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:9 +msgid "Attributes" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:11 +msgid "**Head of the data-series**" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:14 +#: ../../view_components/visualize_dataseries.rst:20 +msgid "Properties:" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:14 +msgid "" +"First few rows and columns of the data-series are displayed in a tabular " +"form" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:16 +msgid "**Plot of the data-series**" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:19 +msgid "" +"Rendered as an image alongside the table showing the first few columns " +"and rows of the data-series" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:23 +msgid "Actions" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:27 +msgid "Requirements" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:29 +msgid "" +"User should be able to close the pop-up window and re-open it by clicking" +" on \"Visualize Data\" button in view-component :ref" +":`load_input_dataseries-label`" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:32 +msgid "Link with views" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:35 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:35 +#: ../../view_components/visualize_dataseries.rst:38 +msgid "Description of the link" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:38 +msgid ":ref:`-label`" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:41 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:45 +msgid ":ref:`load_input_dataseries-label`" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:44 +msgid "" +"Current view-component is only accessible through attributes of the " +"linked view-component" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:48 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/visualize_dataseries.rst:50 +msgid "Rendered as a pop-up window" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/view_components/welcome.mo b/docs/locale/de/LC_MESSAGES/view_components/welcome.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/view_components/welcome.mo differ diff --git a/docs/locale/de/LC_MESSAGES/view_components/welcome.po b/docs/locale/de/LC_MESSAGES/view_components/welcome.po new file mode 100755 index 0000000..79050b3 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/view_components/welcome.po @@ -0,0 +1,196 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../view_components/welcome.rst:4 +msgid "Welcome page" +msgstr "" + +#: ../../view_components/welcome.rst:6 +msgid "" +"This view-component is an introduction for the first-time users. It " +"describes what they can expect from the tool." +msgstr "" + +#: ../../view_components/welcome.rst:10 +msgid "Attributes" +msgstr "" + +#: ../../view_components/welcome.rst:13 +msgid "**Welcome message**" +msgstr "" + +#: ../../view_components/welcome.rst:13 +msgid "A text" +msgstr "" + +#: ../../view_components/welcome.rst:17 +msgid "**Video intro message**" +msgstr "" + +#: ../../view_components/welcome.rst:16 +msgid "" +"A short, 3 minute video clip that provides the important information such" +" as tool features, capabilities, where to find help, etc., very briefly." +msgstr "" + +#: ../../view_components/welcome.rst:17 +msgid "" +"This clip is embedded into the welcome pop-up. The user can view it on " +"YouTube (or Vimeo) on a separate tab of the browser by clicking on a link" +" on the video." +msgstr "" + +#: ../../view_components/welcome.rst:22 +msgid "**List of Hyperlinks**" +msgstr "" + +#: ../../view_components/welcome.rst:20 +msgid "" +"Clickable links to read more, documentation, examples, use-cases, video " +"tutorials, code-base (GitHub repo) and contact us." +msgstr "" + +#: ../../view_components/welcome.rst:22 +msgid "Action index: 1" +msgstr "" + +#: ../../view_components/welcome.rst:31 +msgid "**Check-box: do not show again**" +msgstr "" + +#: ../../view_components/welcome.rst:25 +msgid "" +"Disable/enable the display of the welcome view-component when tool is " +"started." +msgstr "" + +#: ../../view_components/welcome.rst:29 +msgid "Properties:" +msgstr "" + +#: ../../view_components/welcome.rst:28 +msgid "id `cb_welcome_show_again`" +msgstr "" + +#: ../../view_components/welcome.rst:29 +msgid "unticked by default" +msgstr "" + +#: ../../view_components/welcome.rst:31 +msgid "Action index: 2" +msgstr "" + +#: ../../view_components/welcome.rst:34 +msgid "Actions" +msgstr "" + +#: ../../view_components/welcome.rst:36 +msgid "" +"Clicking on the hyperlinks will open the respective topic in separate " +"tabs of the browser." +msgstr "" + +#: ../../view_components/welcome.rst:37 +msgid "" +"Checking the `Do not show again` check-box would disable the display of " +"this view component everytime the software is launched." +msgstr "" + +#: ../../view_components/welcome.rst:38 +msgid "" +"The user can close the welcome window by clicking the :guilabel:`&X` " +"button in the top right corner." +msgstr "" + +#: ../../view_components/welcome.rst:41 +msgid "Requirement" +msgstr "" + +#: ../../view_components/welcome.rst:43 +msgid "" +"By default, the welcome view-component should be displayed to the user " +"everytime the software is started." +msgstr "" + +#: ../../view_components/welcome.rst:44 +msgid "" +"If the user ticks the check-box *Do not show again*, the welcome view-" +"component should not appear to the user during any subsequent launch of " +"the tool." +msgstr "" + +#: ../../view_components/welcome.rst:47 +msgid "Link with other views" +msgstr "" + +#: ../../view_components/welcome.rst:49 +msgid "" +"This window is displayed by default on top of everything every time the " +"tool is launched." +msgstr "" + +#: ../../view_components/welcome.rst:53 +msgid "Link with other view-components" +msgstr "" + +#: ../../view_components/welcome.rst:55 +msgid ":ref:`landing-label`" +msgstr "" + +#: ../../view_components/welcome.rst:59 +msgid ":ref:`menu_bar-label`" +msgstr "" + +#: ../../view_components/welcome.rst:59 +msgid "" +"The user can later re-enable the appearance of the welcome view-" +"component by clicking *Display welcome view* in *Preferences* from the " +"menu." +msgstr "" + +#: ../../view_components/welcome.rst:62 +msgid "Rendering of the view-component" +msgstr "" + +#: ../../view_components/welcome.rst:63 +msgid "" +"This view-component could be either a popup on top of the :ref:`landing-" +"view`, :ref:`widget-def` in the landing view or a :ref:`view-def` on its " +"own." +msgstr "" + +#: ../../view_components/welcome.rst:65 +msgid "" +"The welcome message should be centered and not contain very long text, " +"but rather bullet points with links to more detailed documentation. The " +"video should be placed on the top left of the view-component and start " +"automatically without the sound." +msgstr "" + +#: ../../view_components/welcome.rst:67 +msgid "Below the welcome message the hyperlinks could be listed and centered." +msgstr "" + +#: ../../view_components/welcome.rst:69 +msgid "" +"The *Do not show again* check-box can be displayed on the bottom of the " +"view-component (bottom-left?) with larger fontsize such that the user " +"cannot miss it. It should be unticked by default." +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/views/landing.mo b/docs/locale/de/LC_MESSAGES/views/landing.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/views/landing.mo differ diff --git a/docs/locale/de/LC_MESSAGES/views/landing.po b/docs/locale/de/LC_MESSAGES/views/landing.po new file mode 100755 index 0000000..b97aa13 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/views/landing.po @@ -0,0 +1,99 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../views/landing.rst:2 +msgid "Landing" +msgstr "" + +#: ../../views/landing.rst:5 +msgid "Attributes" +msgstr "" + +#: ../../views/landing.rst:6 +msgid "There are no attributes specific to the landing view." +msgstr "" + +#: ../../views/landing.rst:9 +msgid "Active view-components" +msgstr "" + +#: ../../views/landing.rst:11 +msgid ":ref:`menu_bar-label`" +msgstr "" + +#: ../../views/landing.rst:12 +msgid ":ref:`progression_bar-label`" +msgstr "" + +#: ../../views/landing.rst:13 +msgid ":ref:`welcome-label`" +msgstr "" + +#: ../../views/landing.rst:17 +msgid "Actions" +msgstr "" + +#: ../../views/landing.rst:18 +msgid "" +"There are no actions specific to the landing view, the possible actions " +"are already defined in the various view-components" +msgstr "" + +#: ../../views/landing.rst:21 +msgid "Requirement" +msgstr "" + +#: ../../views/landing.rst:22 +msgid "" +"the very first time the user sees this view, the :ref:`welcome-label` " +"view-component should be displayed (popup, or integrated to the view)" +msgstr "" + +#: ../../views/landing.rst:25 +msgid "Link with other views" +msgstr "" + +#: ../../views/landing.rst:26 +msgid "TBD" +msgstr "" + +#: ../../views/landing.rst:29 +msgid "Rendering of the view" +msgstr "" + +#: ../../views/landing.rst:30 +msgid "There are currently 2 types of rendering proposed:" +msgstr "" + +#: ../../views/landing.rst:33 +msgid "minimalistic:" +msgstr "" + +#: ../../views/landing.rst:33 +msgid "The user is only prompted to \"build your own energy cell\"" +msgstr "" + +#: ../../views/landing.rst:35 +msgid "expert mode:" +msgstr "" + +#: ../../views/landing.rst:36 +msgid "Most of the menu and flow charts are displayed in widget windows" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/views/scenario_comparison.mo b/docs/locale/de/LC_MESSAGES/views/scenario_comparison.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/views/scenario_comparison.mo differ diff --git a/docs/locale/de/LC_MESSAGES/views/scenario_comparison.po b/docs/locale/de/LC_MESSAGES/views/scenario_comparison.po new file mode 100755 index 0000000..238f76a --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/views/scenario_comparison.po @@ -0,0 +1,138 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../views/scenario_comparison.rst:2 +msgid "Scenario Comparison" +msgstr "" + +#: ../../views/scenario_comparison.rst:4 +msgid "" +"*The output comparable on the \"scenario comparison view\" will be " +"determine with oemof and the input/output excel file*" +msgstr "" + +#: ../../views/scenario_comparison.rst:7 +msgid "Attributes" +msgstr "" + +#: ../../views/scenario_comparison.rst:8 ../../views/scenario_comparison.rst:23 +msgid "**List of scenarios**" +msgstr "" + +#: ../../views/scenario_comparison.rst:10 +#: ../../views/scenario_comparison.rst:27 +msgid "**Different comparison points**" +msgstr "" + +#: ../../views/scenario_comparison.rst:12 +msgid "Technical" +msgstr "" + +#: ../../views/scenario_comparison.rst:13 +msgid "Financial" +msgstr "" + +#: ../../views/scenario_comparison.rst:14 +msgid "Ecological" +msgstr "" + +#: ../../views/scenario_comparison.rst:17 +msgid "Active view-components" +msgstr "" + +#: ../../views/scenario_comparison.rst:19 +msgid ":ref:`menu_bar-label`" +msgstr "" + +#: ../../views/scenario_comparison.rst:22 +msgid "Actions" +msgstr "" + +#: ../../views/scenario_comparison.rst:25 +msgid "The user can select which scenario he would like to compare." +msgstr "" + +#: ../../views/scenario_comparison.rst:29 +msgid "Technical: Based on the technical output of the simulation" +msgstr "" + +#: ../../views/scenario_comparison.rst:30 +msgid "Financial: Based on the financial output of the simulation" +msgstr "" + +#: ../../views/scenario_comparison.rst:31 +msgid "Ecological: Based on the ecological output of the simulation" +msgstr "" + +#: ../../views/scenario_comparison.rst:33 +msgid "**Save comparison**" +msgstr "" + +#: ../../views/scenario_comparison.rst:35 +msgid "Allows the user to save their comparison in the tool." +msgstr "" + +#: ../../views/scenario_comparison.rst:36 +msgid "" +"Makes a pop up appear where the user has to select a name for his " +"comparison." +msgstr "" + +#: ../../views/scenario_comparison.rst:38 +msgid "**Export comparison**" +msgstr "" + +#: ../../views/scenario_comparison.rst:40 +msgid "" +"Allows the user to save his comparison in different format (PDF, csv, " +"...?)" +msgstr "" + +#: ../../views/scenario_comparison.rst:42 +msgid "**Import scenario**" +msgstr "" + +#: ../../views/scenario_comparison.rst:44 +msgid "Allows the user to import one or more scenario" +msgstr "" + +#: ../../views/scenario_comparison.rst:47 +msgid "Requirement" +msgstr "" + +#: ../../views/scenario_comparison.rst:51 +msgid "Link with other views" +msgstr "" + +#: ../../views/scenario_comparison.rst:54 +msgid "Rendering of the view" +msgstr "" + +#: ../../views/scenario_comparison.rst:56 +msgid "**Two possible views**" +msgstr "" + +#: ../../views/scenario_comparison.rst:58 +msgid "As a table" +msgstr "" + +#: ../../views/scenario_comparison.rst:59 +msgid "As a plot" +msgstr "" + diff --git a/docs/locale/de/LC_MESSAGES/views/view_template.mo b/docs/locale/de/LC_MESSAGES/views/view_template.mo new file mode 100755 index 0000000..61eb8cf Binary files /dev/null and b/docs/locale/de/LC_MESSAGES/views/view_template.mo differ diff --git a/docs/locale/de/LC_MESSAGES/views/view_template.po b/docs/locale/de/LC_MESSAGES/views/view_template.po new file mode 100755 index 0000000..f443119 --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/views/view_template.po @@ -0,0 +1,115 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2020, Reiner Lemoine Institut +# This file is distributed under the same license as the open_plan package. +# FIRST AUTHOR , 2021. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: open_plan \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2021-04-14 10:14+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.8.0\n" + +#: ../../views/view_template.rst:17 +msgid "" +msgstr "" + +#: ../../views/view_template.rst:20 +msgid "Attributes" +msgstr "" + +#: ../../views/view_template.rst:32 +msgid "**Attribute A**" +msgstr "" + +#: ../../views/view_template.rst:24 +msgid "Description" +msgstr "" + +#: ../../views/view_template.rst:29 +msgid "Properties:" +msgstr "" + +#: ../../views/view_template.rst:27 +msgid "Property 1" +msgstr "" + +#: ../../views/view_template.rst:28 +msgid "..." +msgstr "" + +#: ../../views/view_template.rst:29 +msgid "Property n" +msgstr "" + +#: ../../views/view_template.rst:31 +msgid "Actions index:" +msgstr "" + +#: ../../views/view_template.rst:33 +msgid "Requirements index:" +msgstr "" + +#: ../../views/view_template.rst:37 +msgid "Actions" +msgstr "" + +#: ../../views/view_template.rst:41 +msgid "Action 1" +msgstr "" + +#: ../../views/view_template.rst:42 +msgid "Action 2" +msgstr "" + +#: ../../views/view_template.rst:45 +msgid "Requirement" +msgstr "" + +#: ../../views/view_template.rst:52 +msgid "Requirement 1" +msgstr "" + +#: ../../views/view_template.rst:53 +msgid "Requirement 2" +msgstr "" + +#: ../../views/view_template.rst:56 +msgid "Active view-components" +msgstr "" + +#: ../../views/view_template.rst:60 +msgid ":ref:`-label`" +msgstr "" + +#: ../../views/view_template.rst:61 +msgid ":ref:`-label`" +msgstr "" + +#: ../../views/view_template.rst:64 +msgid "Link with views" +msgstr "" + +#: ../../views/view_template.rst:68 +msgid ":ref:`-label`" +msgstr "" + +#: ../../views/view_template.rst:68 ../../views/view_template.rst:71 +msgid "Description of the link" +msgstr "" + +#: ../../views/view_template.rst:72 +msgid ":ref:`-label`" +msgstr "" + +#: ../../views/view_template.rst:75 +msgid "Rendering of the view" +msgstr "" + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..922152e --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/math/math_intro.rst b/docs/math/math_intro.rst new file mode 100644 index 0000000..5c63af8 --- /dev/null +++ b/docs/math/math_intro.rst @@ -0,0 +1,5 @@ +======================== +Mathematical Description +======================== + +To be completed. \ No newline at end of file diff --git a/docs/model/assumptions.rst b/docs/model/assumptions.rst new file mode 100644 index 0000000..836255f --- /dev/null +++ b/docs/model/assumptions.rst @@ -0,0 +1,619 @@ +=========== +Assumptions +=========== + +The open-plan-tool uses the programming framework :code:`oemof-solph` at its core and builds an energy system model based upon its nomenclature. +As such, the energy system model can be described with a linear equation system. +The most important aspects of a linear equation system are described below in a generalized way, and additionally explained through the use of an example. +This will enable the clear comparision to other energy system models. + +.. _economic_precalculation-label: + +Economic Dispatch +----------------- + +Linear programming is a mathematical modelling and optimization technique for a system of a linear objective function subject to linear constraints. +The goal of a linear programming problem is to find the optimal value for the objective function, be it a maximum or a minimum. +open-plan-tool is based on :code:`oemof-solph`, which in turn uses :code:`Pyomo` to create a linear problem. +The economic dispatch problem in the open-plan-tool has the objective of minimizing the production cost by allocating the total demand among the generating units at each time step. +The equation is the following: + +.. math:: + min Z = \sum_i a_i \cdot CAP_i + \sum_i \sum_t c_{var,i} \cdot E_i(t) + +.. math:: + CAP_i &\geq 0 + + E_i(t) &\geq 0 \qquad \forall t + + i &\text{: asset} + + a_i &\text{: asset annuity [currency/kWp/year, currency/kW/year, currency/kWh/year]} + + CAP_i &\text{: asset capacity [kWp, kW, kWh]} + + c_{var,i} &\text{: variable operational or dispatch cost [currency/kWh, currency/L]} + + E_i(t) &\text{: asset dispatch [kWh]} + +The annual cost function of each asset includes the capital expenditure (investment cost) and residual value, as well as the operating expenses of each asset. +It is expressed as follows: + +.. math:: + a_i &= \left( capex_i + \sum_{k=1}^{n} \frac{capex_i}{(1+d)^{k \cdot t_a}} - c_{res,i} \right) \cdot CRF(T) + opex_i + + CRF(T) &= \frac{d \cdot (1+d)^T}{(1+d)^T - 1} + +.. math:: + capex_i &\text{: specific investment costs [currency/unit]} + + n &\text{: number of replacements of an asset within project lifetime } T + + t_a &\text{: asset lifetime [years]} + + CRF &\text{: capital recovery factor} + + c_{res,i} &\text{: residual value of asset i at the end of project lifetime } T \text{ [currency/unit]} + + opex_i &\text{: annual operational and management costs [currency/unit/year]} + + d &\text{: discount factor} + + T &\text{: project lifetime [years]} + +The CRF is a ratio used to calculate the present value of the annuity. +The discount factor can be replaced by the weighted average cost of capital (WACC), calculated by the user. + +The lifetime of the asset :math:`t_a` and the lifetime of the project :math:`T` can be different from each other; +as a result, the number of replacements :math:`n` is estimated using the equation below: + +.. math:: + n = round \left( \frac{T}{t_a} + 0.5 \right) - 1 + +The residual value is also known as the salvage value and it represents an estimate of the monetary value of an asset at the end of the project lifetime :math:`T`. +open-plan-tool considers a linear depreciation over :math:`T` and accounts for the time value of money through the use of the following equation: + +.. math:: + c_{res,i} = \frac{capex_i}{(1+d)^{n \cdot t_a}} \cdot \frac{1}{T} \cdot \frac{(n+1) \cdot t_a - T}{(1+d)^T} + +.. _equation_energy_balance: + +Energy Balance Equation +----------------------- + +One main constraint that the optimization model is subject to is the energy balance equation, which specifically maintains equality between the total incoming and outgoing energy of a bus. +This balancing equation is applicable to all bus types, be it electrical, thermal, hydrogen or any other energy carrier. + +.. math:: + \sum E_{in,i}(t) - \sum E_{out,j}(t) = 0 \qquad \forall t + +.. math:: + E_{in,i} &\text{: energy flowing from asset i to the bus} + + E_{out,j} &\text{: energy flowing from the bus to asset j} + +It is very important to note that assets i and j can be the same asset (e.g. a battery with an electrical inflow/outflow). +`Oemof-solph` allows both :math:`E_{in}` and :math:`E_{out}` to be larger than zero in the same time step t (see :ref:`limitations-real-life-constraint`). + +.. _example_energy_balance_equations: + +Example: Sector Coupled Energy System +------------------------------------- + +In order to understand the component models, a generic sector coupled energy system example is shown in the figure below. +It brings together the electricity and heat sector through a transformer (Transformer 4) which connects the two sector buses. + +.. image:: ../images/26-10-2020_sector_coupled_example.png + :width: 600 + +For the sake of simplicity, the following table gives an example for each asset type with an abbreviation to be used in the energy balance and component equations. + + .. list-table:: Asset Types and Examples + :widths: 50 25 25 25 + :header-rows: 1 + + * - Asset Type + - Asset Example + - Abbreviation + - Unit + * - Non-dispatchable source 1 + - Wind turbine + - wind + - kW + * - Non-dispatchable source 2 + - Photovoltaic panels + - pv + - kWp + * - Storage 1 + - Battery energy storage + - bat + - kWh + * - Transformer 1 + - Rectifier + - rec + - kW + * - Transformer 2 + - Solar inverter + - inv + - kW + * - Non-dispatchable source 3 + - Solar thermal collector + - stc + - kWth + * - Storage 2 + - Thermal energy storage + - tes + - kWth + * - Dispatchable source + - Heat source (e.g., biogas) + - heat + - L + * - Transformer 3 + - Turbine + - turb + - kWth + * - Transformer 4 + - Heat pump + - hp + - kWth + +All grid and dispatchable source asset types are assumed to be available 100% of the time with no consumption limits. +For each bus in the system, the open-plan-tool automatically includes a sink component for excess energy related to the bus, which is denoted :math:`E_{ex}` in the equations. +This excess sink accounts for the extra energy in the system that has to be dumped. + +Electricity Grid Equation +######################### + +The electricity grid is modeled through a feed-in and a consumption node. +Transformers limit the peak flow into or from the local electricity line, and electricity sold to the grid experiences losses in the transformer :math:`(ts,f)`. + +.. math:: + E_{grid,c}(t) - E_{grid,f}(t) + E_{ts,f}(t) \cdot \eta_{ts,f} - E_{ts,c}(t) = 0 \qquad \forall t + +.. math:: + E_{grid,c} &\text{: energy consumed from the electricity grid} + + E_{grid,f} &\text{: energy fed into the electricity grid} + + E_{grid,c} &\text{: transformer station feed-in} + + \eta_{ts,f} &\text{: transformer station efficiency} + + E_{grid,c} &\text{: transformer station consumption} + +Non-Dispatchable Source Equations +################################# + +Non-dispatchable sources in the sector coupled energy system example are wind, PV and solar thermal power. +Their generation is determined by the provided timeseries of instantaneous generation, providing :math:`\alpha`, :math:`\beta`, :math:`\gamma` in relation to wind, PV and solar thermal power respectively. + +.. math:: + E_{wind}(t) &= CAP_{wind} \cdot \alpha_{wind}(t) \qquad \forall t + + E_{pv}(t) &= CAP_{pv} \cdot \beta_{pv}(t) \qquad \forall t + + E_{stc}(t) &= CAP_{stc} \cdot \gamma_{stc}(t) \qquad \forall t + +.. math:: + E_{wind} &\text{: energy generated from the wind turbine} + + CAP_{wind} &\text{: wind turbine capacity [kW]} + + \alpha_{wind} &\text{: instantaneous wind turbine performance metric [kWh/kW]} + + E_{pv} &\text{: energy generated from the PV panels} + + CAP_{pv} &\text{: PV panel capacity [kWp]} + + \beta_{pv} &\text{: instantaneous PV specific yield [kWh/kWp]} + + E_{stc} &\text{: energy generated from the solar thermal collector} + + CAP_{stc} &\text{: Solar thermal collector capacity [kWth]} + + \gamma_{stc} &\text{: instantaneous collector's production [kWh/kWth]} + +Storage Model +############# + +There are two storages in the defined example system: An electrical energy storage (Storage 1, :math:`bat`) and a thermal energy storage (Storage 2, :math:`tes`). +Below, the equations for Storage 1 are provided, but Storage 2 follows analogous equations for charge, discharge and bounds. + +.. math:: + E_{bat}(t) = E_{bat}(t - 1) + E_{bat,in}(t) \cdot \eta_{bat,in} - \frac{E_{bat,out}}{\eta_{bat,out}} - E_{bat}(t - 1) \cdot \epsilon \qquad \forall t + +.. math:: + CAP_{bat} \cdot SOC_{min} \leq E_{bat}(t) \leq CAP_{bat} \cdot SOC_{max} \qquad \forall t + + 0 \leq E_{bat}(t) - E_{bat}(t - 1) \leq CAP_{bat} \cdot C_{rate,in} \qquad \forall t + + 0 \leq E_{bat}(t - 1) - E_{bat}(t) \leq CAP_{bat} \cdot C_{rate,out} \qquad \forall t + +.. math:: + E_{bat} &\text{: energy stored in the battery at time t} + + E_{bat,in} &\text{: battery charging energy} + + \eta_{bat,in} &\text{: battery charging efficiency} + + E_{bat,out} &\text{: battery discharging energy} + + \eta_{bat,out} &\text{: battery discharging efficiency} + + \epsilon &\text{: decay per time step} + + CAP_{bat} &\text{: battery capacity [kWh]} + + SOC_{min} &\text{: minimum state of charge} + + SOC_{max} &\text{: maximum state of charge} + + C_{rate,in} &\text{: battery charging rate} + + C_{rate,in} &\text{: battery discharging rate} + +DC Electricity Bus Equation +########################### + +The following equation illustrates an example of a DC bus with a battery, PV and a bi-directional inverter. + +.. math:: + E_{pv}(t) + E_{bat,out}(t) \cdot \eta_{bat,out} + E_{rec}(t) \cdot \eta_{rec} - E_{inv}(t) - E_{bat,in} - E_{ex}(t) = 0 \qquad \forall t + +.. math:: + E_{rec} &\text{: rectifier energy} + + \eta_{rec} &\text{: rectifier efficiency} + + E_{inv} &\text{: inverter energy} + +AC Electricity Bus Equation +########################### + +This equation describes the local electricity grid and all connected assets: + +.. math:: + E_{ts,c}(t) \cdot \eta_{ts,c} + E_{wind}(t) + E_{inv}(t) \cdot \eta_{inv} - E_{ts,c}(t) - E_{rec}(t) - E_{hp}(t) - E_{el}(t) - E_{ex}(t) = 0 \qquad \forall t + +.. math:: + \eta_{ts,c} &\text{: transformer station efficiency} + + \eta_{inv} &\text{: inverter efficiency} + + E_{hp} &\text{: heat pump electrical consumption} + + E_{el} &\text{: electrical load} + +Heat Bus Equation +################# + +This equation describes the heat bus and all connected assets: + +.. math:: + E_{tes}(t) \cdot \eta_{tes} + E_{turb}(t) \cdot \eta_{turb} + E_{hp}(t) \cdot COP - E_{th}(t) - E_{ex}(t) = 0 + +.. math:: + \eta_{tes} &\text{: thermal storage efficiency} + + \eta_{turb} &\text{: turbine efficiency} + + COP &\text{: heat pump coefficient of performance} + + E_{th} &\text{: heat load} + +NDS3 Bus Equation +################# + +The NDS3 Bus is an example of a bus which does not serve both as the input and output of a storage system. +Instead, the thermal storage is charged from the NDS3 bus, but discharges into the heat bus. + +.. math:: + E_{stc}(t) - E_{tes}(t) - E_{ex}(t) = 0 + +.. math:: + E_{tes} \text{: thermal energy storage} + +DS Bus Equation +############### + +The DS Bus shows an example of a fuel source providing an energy carrier (biogas) to a transformer (turbine). + +.. math:: + E_{heat}(t) - E_{turb}(t) - E_{ex}(t) = 0 + +.. math:: + E_{heat} &\text{: thermal energy (biogas) production} + + E_{turb} &\text{: turbine (biogas turbine) energy} + + +.. _Cost_calculations: + +Cost calculations +----------------- + +The optimization of the open-plan-tool is mainly based on costs. +There is, however, the possibility of introducing additional constraints which will impact the optimization results e.g. implementing a maximum installable capacity limit (comp. :ref:`maxcap-label`) or adding constraints for certain key performance indicators (see :ref:`constraints-label`). +In order to optimize the energy systems properly, the economic data provided with the input data has to be pre-processed (also see :ref:`economic_precalculation-label`) and then also post-processed when evaluating the results. The following assumptions are therefore important: + +* :ref:`Project lifetime `: The simulation has a defined project lifetime, for which continuous operation is assumed - which means that the first year of operation is considered to be the same as the last year of operation. Existing and optimized assets have to be replaced (if their lifetime preceeds the system lifetime) to make this possible. +* :ref:`Simulation duration `: It is advisable to simulate the whole year to find the most suitable combination of energy assets for your system. Sometimes however you might want to look at specific seasons to see their effect - this is possible by choosing a specific start date and simulation duration. +* :ref:`Asset costs `: Each asset can have development costs, specific investment costs, specific operation and management costs as well as dispatch costs. + * *Replacement costs* are calculated based on the lifetime of the assets, and residual values are paid at the end of the project. + * *Development costs* are costs that will occurr regardless of the installed capacity of an asset - even if it is not installed at all. It stands for system planning and licensing costs. If you have optimized your energy system and see that an asset might not be favourable (zero optimized capacities), you might want to run the simulation again and remove the asset, or remove the development costs of the asset. + * *Specific investment costs* and *specific operation and maintenance costs* are used to calculate the annual expenditures that an asset has per year, in the process also adding the replacement costs. + * *Dispatch price* can often be set to zero, but are supposed to cover instances where utilization of an asset requires increased operation and maintenance or leads to wear. +* :ref:`Pre-existing capacities `: It is possible to add assets that already exist in your energy system with their capacity and age. + * *Replacements* - To ensure that the energy system operates continously, the existing assets are replaced with the same capacities when they reached their end of life within the project lifetime. + * *Replacement costs* are calculated based on the lifetime of the asset in general and the age of the pre-existing capacities +* `Fix project costs `__: It is possible to define fix costs of the project - this is important if you want to compare different project locations with each other. You can define... + * *Development costs*, which could for example stand for the cost of licenses of the whole energy system + * *(Specific) investment costs*, which could be an investment into land or buildings at the project site. When you define a lifetime for the investment, the MVS will also consider replacements and reimbursements. + * *(Specific) operation and management costs*, which can cover eg. the salaries of at the project site + + +.. _energy_carrier_weighting: + +Weighting of energy carriers +---------------------------- + +To be able to calculate sector-wide key performance indicators, it is necessary to assign weights to the energy carriers based on their usable potential. In the conference paper handed in to the CIRED workshop, we have proposed a methodology comparable to Gasoline Gallon Equivalents. + +After thorough consideration, it has been decided to base the equivalence in tonnes of oil equivalent (TOE). Electricity has been chosen as a baseline energy carrier, as our pilot sites mainly revolve around it and also because we believe that this energy carrier will play a larger role in the future. For converting the results into a more conventional unit, we choose crude oil as a secondary baseline energy carrier. This also enables comparisons with crude oil price developments in the market. For most KPIs, the baseline energy carrier used is of no relevance as the result is not dependent on it. This is the case for KPIs such as the share of renewables at the project location or its self-sufficiency. The choice of the baseline energy carrier is relevant only for the levelized cost of energy (LCOE), as it will either provide a system-wide supply cost in Euro per kWh electrical or per kg crude oil. + +First, the conversion factors to kg crude oil equivalent [`1 `__] were determined (see :ref:`table_kgoe_conversion_factors` below). These are equivalent to the energy carrier weighting factors with baseline energy carrier crude oil. + +Following conversion factors and energy carriers are defined: + +.. _table_kgoe_conversion_factors: + +.. list-table:: Conversion factors: kg crude oil equivalent (kgoe) per unit of a fuel + :widths: 50 25 25 + :header-rows: 1 + + * - Energy carrier + - Unit + - Value + * - H2 [`3 `__] + - kgoe/kgH2 + - 2.87804 + * - LNG + - kgoe/kg + - 1.0913364 + * - Crude oil + - kgoe/kg + - 1 + * - Gas oil/diesel + - kgoe/litre + - 0.81513008 + * - Kerosene + - kgoe/litre + - 0.0859814 + * - Gasoline + - kgoe/litre + - 0.75111238 + * - LPG + - kgoe/litre + - 0.55654228 + * - Ethane + - kgoe/litre + - 0.44278427 + * - Electricity + - kgoe/kWh(el) + - 0.0859814 + * - Biodiesel + - kgoe/litre + - 0.00540881 + * - Ethanol + - kgoe/litre + - 0.0036478 + * - Natural gas + - kgoe/litre + - 0.00080244 + * - Heat + - kgoe/kWh(therm) + - 0.086 + * - Heat + - kgoe/kcal + - 0.0001 + * - Heat + - kgoe/BTU + - 0.000025 + +The values of ethanol and biodiesel seem comparably low in [`1 `__] and [`2 `__] and do not seem to be representative of the net heating value (or lower heating value) that was expected to be used here. + +From this, the energy weighting factors are calculated using the electricity content for crude oil as baseline (see :ref:`table_default_energy_carrier_weights_label` below). + +.. _table_default_energy_carrier_weights_label: + +.. list-table:: Electricity equivalent conversion per unit of a fuel + :widths: 50 25 25 + :header-rows: 1 + + * - Energy carrier + - Unit + - Value + * - LNG + - kWh(eleq)/kg + - 12.6927 + * - Crude oil + - kWh(eleq)/kg + - 11.6304 + * - Diesel + - kWh(eleq)/litre + - 9.4803 + * - Kerosene + - kWh(eleq)/litre + - 8.9080 + * - Gasoline + - kWh(eleq)/litre + - 8.7358 + * - LPG + - kWh(eleq)/litre + - 6.4728 + * - Ethane + - kWh(eleq)/litre + - 5.1498 + * - H2 + - kWh(eleq)/kgH2 + - 33.4728 + * - Electricity + - kWh(eleq)/kWh(el) + - 1 + * - Biodiesel + - kWh(eleq)/litre + - 0.0629 + * - Ethanol + - kWh(eleq)/litre + - 0.0424 + * - Natural gas + - kWh(eleq)/litre + - 0.009 + * - Heat + - kWh(eleq)/kWh(therm) + - 1.0002 + * - Heat + - kWh(eleq)/kcal + - 0.0011 + * - Heat + - kWh(eleq)/BTU + - 0.0003 + +With this, the equivalent potential of an energy carrier *E*:sub:`{eleq,i}`, compared to electricity, can be calculated with its conversion factor *w*:sub:`i` as: + +.. math:: + E_{eleq,i} = E_{i} \cdot w_{i} + +As it can be noticed, the conversion factor between heat (kWh(therm)) and electricity (kWh(el)) is almost 1. The deviation stems from the data available in source [`1 `__] and [`2 `__]. The equivalency of heat and electricity can be a source of discussion, as from an exergy point of view these energy carriers can not be considered equivalent. When combined, say with a heat pump, the equivalency can also result in ripple effects in combination with the minimal renewable factor or the minimal degree of autonomy, which need to be evaluated during the pilot simulations. + +For the most part, the energy carrier weighting factors are similar to the lower heating value of the fuel in question. A stark deviation is noticable for ethanol and biodiesel. This deviation should be investigated further. In the future, it should be discussed whether it would be better to directly use the lower heating values of a fuel as its energy carrier weighting factor, as this would be more intuitive. + +.. note:: + The :code:`energy_vector` of each of the assets and busses must be identical in spelling to one of the energy carriers defined in the above table. Spaces should be translated to underscores (ie. Crude oil as an energy carrier is defined as :code:`Crude_oil` in the input files). Other energy carriers can not be parsed and will raise a warning. Please note that `Heat` currently has to be measured in kWh(thermal). + +:Code: + +Currently, the energy carrier conversion factors are defined in :code:`constants.py` with :code:`DEFAULT_WEIGHTS_ENERGY_CARRIERS`. New energy carriers should be added to its list when needed. Unknown carriers raise an :code:`UnknownEnergyVectorError` error. + +:Comment: + +Please note that the energy carrier weighting factor is not applied dependent on the LABEL of the energy asset, but based on its energy vector. Let us consider an example: + +In our system, we have a dispatchable `diesel fuel source`, with dispatch carrying the unit `l Diesel`. +The energy vector needs to be defined as `Diesel` for the energy carrier weighting to be applied, ie. the energy vector of `diesel fuel source` needs to be `Diesel`. This will also have implications for the KPI: +For example, the `degree of sector coupling` will reach its maximum, when the system only has heat demand and all of it is provided by processing diesel fuel. If you want to portrait diesel as something inherent to heat supply, you will need to make the diesel source a heat source, and set its `dispatch costs` to currency/kWh, ie. divide the diesel costs by the heating value of the fuel. + +:Comment: + +In the open-plan-tool, there is no distinction between energy carriers and energy vector. For `Electricity` of the `Electricity` vector this may be self-explanatory. However, the energy carriers of the `Heat` vector can have different technical characteristics: A fluid on different temperature levels. As the open-plan-tool measures the energy content of a flow in kWh(thermal) however, this distinction is only relevant for the end user to be aware of, as two assets that have different energy carriers as an output should not be connected to one and the same bus if a detailed analysis is expected. An example of this would be, that a system where the output of the diesel boiler as well as the output of a solar thermal panel are connected to the same bus, eventhough they can not both supply the same kind of heat demands (radiator vs. floor heating). This, however, is something that the end-user has to be aware of themselves, eg. by defining self-explanatory labels. + +Emission factors +---------------- + +In order to optimise the energy system with minimum emissions, it is important to calculate emission per unit of fuel consumption. + +In table :ref:`table_emissions_energyCarriers` the emission factors for energy carriers are defined. These values are based on direct emissions during stationary consumption of the mentioned fuels. + +.. _table_emissions_energyCarriers: + +.. list-table:: Emission factors: Kg of CO2 equivalent per unit of fuel consumption + :widths: 50 25 25 25 + :header-rows: 1 + + * - Energy carrier + - Unit + - Value + - Source + * - Diesel + - kgCO2eq/litre + - 2.7 + - [`4 `__] Page No. 26 + * - Gasoline + - kgCO2eq/litre + - 2.3 + - [`4 `__] Page No. 26 + * - Kerosene + - kgCO2eq/litre + - 2.5 + - [`4 `__] Page No. 26 + * - Natural gas + - kgCO2eq/m3 + - 1.9 + - [`4 `__] Page No. 26 + * - LPG + - kgCO2eq/litre + - 1.6 + - [`4 `__] Page No. 26 + * - Biodiesel + - kgCO2eq/litre + - 0.000125 + - [`5 `__] Page No. 6 + * - Bioethanol + - kgCO2eq/litre + - 0.0000807 + - [`5 `__] Page No. 6 + * - Biogas + - kgCO2eq/m3 + - 0.12 + - [`6 `__] Page No. 1 + +In table :ref:`table_CO2_emissions_countries` the CO2 emissions for Germany and the four pilot sites (Norway, Spain, Romania, India) are defined: + +.. _table_CO2_emissions_countries: + +.. list-table:: CO2 Emission factors: grams of CO2 equivalent per kWh of electricity consumption + :widths: 50 25 25 25 + :header-rows: 1 + + * - Country + - Unit + - Value + - Source + * - Germany + - gCO2eq/kWh + - 338 + - [`7 `__] Fig. 2 + * - Norway + - gCO2eq/kWh + - 19 + - [`7 `__] Fig. 2 + * - Spain + - gCO2eq/kWh + - 207 + - [`7 `__] Fig. 2 + * - Romania + - gCO2eq/kWh + - 293 + - [`7 `__] Fig. 2 + * - India + - gCO2eq/kWh + - 708 + - [`8 `__] Page No. 7 + +The values mentioned in the table above account for emissions during the complete life cycle. This includes emissions during energy production, energy conversion, energy storage and energy transmission. + + +.. _verification_of_inputs: + +Input verification +------------------ + +The inputs for a simulation with the open-plan-tool are subjected to a couple of verification tests to make sure that the inputs result in valid oemof simulations. This should ensure: + +- Uniqueness of labels (:code:`C1.check_for_label_duplicates`): This function checks if any LABEL provided for the energy system model in dict_values is a duplicate. This is not allowed, as oemof can not build a model with identical labels. + +- No levelized costs of generation lower than feed-in tariff of same energy vector in case of investment optimization (:code:`optimizeCap` is :code:`True`) (:code:`C1.check_feedin_tariff_vs_levelized_cost_of_generation_of_providers`): Raises error if feed-in tariff > levelized costs of generation if :code:`maximumCap` is :code:`None` for energy asset in :code:`ENERGY_PRODUCTION`. This is not allowed, as oemof otherwise may be subjected to an unbound problem, ie. a business case in which an asset should be installed with infinite capacities to maximize revenue. If maximumCap is not :code:`None` a :code:`logging.warning` is shown as the maximum capacity of the asset will be installed. + +- No feed-in tariff higher then energy price from an energy provider (:code:`C1.check_feedin_tariff_vs_energy_price`): Raises error if feed-in tariff > energy price of any asset in :code:`energyProvider.csv`. This is not allowed, as oemof otherwise is subjected to an unbound and unrealistic problem, eg. one where the owner should consume electricity to feed it directly back into the grid for its revenue. + +- Assets have well-defined energy vectors and belong to an existing bus (:code:`C1.check_if_energy_vector_of_all_assets_is_valid`): Validates for all assets, whether :code:`energyVector` is defined within :code:`DEFAULT_WEIGHTS_ENERGY_CARRIERS` and within the :code:`energyBusses`. + +- Energy carriers used in the simulation have defined factors for the electricity equivalency weighting (:code:`C1.check_if_energy_vector_is_defined_in_DEFAULT_WEIGHTS_ENERGY_CARRIERS`): Raises an error message if an energy vector is unknown. It then needs to be added to the :code:`DEFAULT_WEIGHTS_ENERGY_CARRIERS` in :code:`constants.py` + +- An energy bus is always connected to one inflow and one outflow (:code:`C1.check_for_sufficient_assets_on_busses`): Validating model regarding busses - each bus has to have more then two assets connected to it, exluding energy excess sinks + +- Time series of energyProduction assets that are to be optimized have specific generation profiles (:code:`C1.check_non_dispatchable_source_time_series`, :code:`C1.check_time_series_values_between_0_and_1`): Raises error if time series of non-dispatchable sources are not between [0, 1]. + +- Provided timeseries are checked for :code:`NaN` values, which are replaced by zeroes (:code:`C0.replace_nans_in_timeseries_with_0`). + +- Asset capacities connected to each bus are sized sufficiently to fulfill the maximum demand (:code:`C1.check_energy_system_can_fulfill_max_demand`): Logs a logging.warning message if the aggregated installed capacity and maximum capacity (if applicable) of all conversion, generation and storage assets connected to one bus is smaller than the maximum demand. The check is applied to each bus of the energy system. Check passes when the potential peak supply is larger then or equal to the peak demand on the bus, or if the maximum capacity of an asset is set to :code:`None` when optimizing. diff --git a/docs/model/components.rst b/docs/model/components.rst new file mode 100644 index 0000000..ec6cc62 --- /dev/null +++ b/docs/model/components.rst @@ -0,0 +1,297 @@ +.. _component_models: + +Component models +---------------- + +The component models of the open-plan-tool result from the used python-library :code:`oemof-solph` for energy modeling. + +It requires component models to be simplified and linearized. +This is the reason why the open-plan-tool can provide a pre-feasibility study of a specific system setup, +but not the final sizing and system design. +The types of assets are presented below. + +.. _energy_consumption: + +Energy consumption +################## + +Demands within the open-plan-tool are added as energy consumption assets. Most importantly, they are defined by a timeseries, representing the demand profile, and their energy vector. A number of demand profiles can be defined for one energy system, both of the same and different energy vectors. +The main optimization goal for the open-plan-tool is to supply the defined demand without fail for all of the timesteps in the simulation with the least cost of supply (comp. :ref:`economic_precalculation-label`). + + +.. _energy_production: + +Energy production +################# + +Non-dispatchable sources of generation +====================================== + +`Examples`: + + - PV plants + - Wind plants + - Run-of-the-river hydro power plants + - Solar thermal collectors + +Variable renewable energy (VRE) sources, like wind and PV, are non-dispatchable due to their fluctuations in supply. + +The fluctuating nature of non-dispatchable sources is represented by generation time series that show the respective production for each time step of the simulated period. In energy system modelling it is common to use hourly time series. + +If you cannot provide time series for your VRE assets you can consider to calculate them by using models for generating feed-in time series from weather data. The following is a list of examples, which is not exhaustive: + + - PV: `pvlib `_ , `Renewables Ninja `_ (download capacity factors), `altlite `__ + - Wind: `windpowerlib `_, `Renewables Ninja `_ (download capacity factors), `altlite `__ + - Hydro power (run-of-the-river): `hydropowerlib `_ + - Solar thermal: `flat plate collectors `_ of `oemof.thermal `_ + + +.. _dispatchable_sources: + +Dispatchable sources of generation +================================== + +`Examples`: + + - Fuel sources + - Deep-ground geothermal plant (ground assumed to allow unlimited extraction of heat, not depending on season) + +Fuel sources are added as dispatchable sources, which can have development, investment, operational and dispatch costs. + +Fuel sources are for example needed as source for a diesel generator (diesel), biogas plant (gas) or a condensing power plant (gas, coal, ...), see :ref:`energy_conversion`. + + +.. _energy_conversion: + +Energy conversion +################# + +`Examples`: + + - Electric transformers (rectifiers, inverters, transformer stations, charge controllers) + - HVAC and Heat pumps (as heater and/or chiller) + - Combined heat and power (CHP) and other condensing power plants + - Diesel generators + - Electrolyzers + - Biogas power plants + +Conversion assets are added as transformers. + +The parameters :ref:`dispatch_price `, :ref:`efficiency ` and :ref:`installedCap ` of transformers are assigned to their output flows. +This means that these parameters need to be provided for the output of the asset and that the costs of the input, (e.g. cost of fuel) are not included in its :ref:`dispatch_price ` but in the :ref:`dispatch_price ` of the fuel source, see :ref:`dispatchable_sources`. + +Conversion assets can be defined with multiple inputs or multiple outputs, but one asset currently cannot have both, multiple inputs and multiple outputs. Note that multiple inputs/output is possible but this feature is not currently tested. + +.. _energyconversion_electric_transformers: + +Electric transformers +===================== + +Electric rectifiers and inverters that are transforming electricity in one direction only, are simply added as transformers. +Bidirectional converters and transformer stations are defined by two transformers that are optimized independently from each other, if optimized. +The same accounts for charge controllers for a :ref:`battery_storage` that are defined by two transformers, one for charging and one for discharging. +The parameters :ref:`dispatch_price `, :ref:`efficiency ` and :ref:`installedCap ` need to be given for the electrical output power of the electric transformers. + +.. note:: + When using two conversion objects to emulate a bidirectional conversion asset, their capacity should be interdependent. This is currently not the case, see :ref:`Infeasible bi-directional flow in one timestep `. + +.. _energyconversion_hvac: + +Heating, Ventilation, and Air Conditioning (HVAC) +================================================= + +Like other conversion assets, devices for heating, ventilation and air conditioning (HVAC) are added as transformers. As the parameters :ref:`dispatch_price `, :ref:`efficiency ` and :ref:`installedCap ` are assigned to the output flows they need to be given for the nominal heat output of the HVAC. + +Different types of HVAC can be modelled. Except for an air source device with ambient temperature as heat reservoir, the device could be modelled with two inputs (electricity and heat) in case the user is interested in the heat reservoir. This has not been tested yet. Also note that currently efficiencies are assigned to the output flows the see `issue #799 `_. +Theoretically, a HVAC device can be modelled with multiple outputs (heat, cooling, ...); this has not been tested yet. + +The efficiency of HVAC systems is defined by the coefficient of performance (COP), which is strongly dependent on the temperature. In order to take account of this, the efficiency can be defined as time series. +If you do not provide your own COP time series you can calculate them with `oemof.thermal `_, see `documentation on compression heat pumps and chillers `_ and `documentation on absorption chillers `_. + +.. _energyconversion_electrolyzers: + +Electrolyzers +============= + +Electrolyzers are added as transformers with a constant or time dependent but in any case pre-defined efficiency. The parameters :ref:`dispatch_price `, :ref:`efficiency ` and :ref:`installedCap ` need to be given for the output of the electrolyzers (hydrogen). + +Currently, electrolyzers are modelled with only one input flow (electricity), not taking into account the costs of water; see `issue #799 `_. +The minimal operation level and consumption in standby mode are not taken into account, yet, see `issue #50 `_. + +.. _power_plants: + +Condensing power plants and Combined heat and power (CHP) +========================================================= + +Condensing power plants are added as transformers with one input (fuel) and one output (electricity), while CHP plants are defined with two outputs (electricity and heat). +The parameters :ref:`dispatch_price `, :ref:`efficiency ` and :ref:`installedCap ` need to be given for the electrical output power (and nominal heat output) of the power plant, while fuel costs need to be included in the :ref:`dispatch_price ` of the fuel source. + +The ratio between the heat and electricity output of a CHP is currently simulated as fix values. This might be changed in the future by using the `ExtractionTurbineCHP `_ +or the `GenericCHP `_ component of oemof, see `issue #803 `_ + +Note that multiple inputs/output have not been tested yet. + +Other fuel powered plants +========================= + +Fuel powered conversion assets, such as diesel generators and biogas power plants, are added as transformers. +The parameters :ref:`dispatch_price `, :ref:`efficiency ` and :ref:`installedCap ` need to be given for the electrical output power of the diesel generator or biogas power plant. +As described above, the costs for diesel and gas need to be included in the :ref:`dispatch_price ` of the fuel source. + + +.. _energy_providers: + +Energy providers +################ + +The energy providers are the most complex assets in the open-plan-tool model. They are composed of a number of sub-assets + + - Energy consumption source, providing the energy required from the system with a certain price + - Energy peak demand pricing "transformers", which represent the costs induced due to peak demand + - Bus connecting energy consumption source and energy peak demand pricing transformers + - Energy feed-in sink, able to take in generation that is provided to the energy provider for revenue + - Optionally: Transformer Station connecting the energy provider bus to the energy bus of the LES + +With all these components, the energy provider can be visualized as follows: + +.. image:: ../images/Model_Assumptions_energyProvider_assets.png + :width: 600 + +Variable energy consumption prices (time-series) +================================================ + +Energy consumption prices can be added as values that vary over time. + +.. _energy_providers_peak_demand_pricing: + +Peak demand pricing +=================== + +A peak demand pricing scheme is based on an electricity tariff, +that requires the consumer not only to pay for the aggregated energy consumption in a time period (eg. kWh electricity), +but also for the maximum peak demand (load, eg. kW power) towards the grid of the energy provider within a specific pricing period. + +In the open-plan-tool, this information is gathered in the provider assets with: + + - :const:`multi_vector_simulator.utils.constants_json_strings.PEAK_DEMAND_PRICING_PERIOD` as the period used in peak demand pricing. Possible values are 1 (yearly), 2 (half-yearly), 3 (each trimester), 4 (quaterly), 6 (every 2 months) and 12 (each month). If you have a `simulation_duration` < 365 days, the periods will still be set up assuming a year! This means, that if you are simulating 14 days, you will never be able to have more than one peak demand pricing period in place. + + - :const:`multi_vector_simulator.utils.constants_json_strings.PEAK_DEMAND_PRICING` as the costs per peak load unit, eg. kW + +To represent the peak demand pricing, the open-plan-tool adds a "transformer" that is optimized with specific operation and maintenance costs per year equal to the PEAK_DEMAND_PRICING for each of the pricing periods. +For two peak demand pricing periods, the resulting dispatch could look as following: + +.. image:: ../images/Model_Assumptions_Peak_Demand_Pricing_Dispatch_Graph.png + :width: 600 + +.. _energy_storage: + +Energy storage +############## + +Energy storages such as battery storages, thermal storages or H2 storages are modelled with the :code:`GenericStorage` component of :code:`oemof.solph`. They are designed for one input and one output. + +The state of charge of a storage at the first and last time step of an optimization are equal. +Charge and discharge of the whole capacity of the energy storage are possible within one time step in case the capacity of the storage is not optimized. In case of +capacity optimization charge and discharge is limited by the :ref:`crate-label`. + +.. _battery_storage: + +Battery energy storage system (BESS) +==================================== + +BESS are modelled as :code:`GenericStorage` like described above. The BESS can either be connected directly to the electricity bus of the LES or via a charge controller that manages the BESS. +When choosing the second option, the capacity of the charge controller can be optimized individually, which takes its specific costs and lifetime into consideration. +A charge controller is defined by two transformers, see section :ref:`energy_conversion` above. + +Note that capacity reduction over the lifetime of a BESS that may occur due to different effects during aging cannot be taken into consideration in the open-plan-tool. A possible workaround for this could be to manipulate the lifetime. + + +Hydrogen storage (H2) +===================== + +Hydrogen storages are modelled as all storage types in the open-plan-tool as :code:`GenericStorage` like described above. + +The most common hydrogen storages store H2 as liquid under temperatures lower than -253 °C or under high pressures. +The energy needed to provide these requirements cannot be modelled via the storage component as another energy sector such as cooling or electricity is needed. It could therefore, be modelled as an additional demand of the energy system, see `issue #811 `_ + +.. _thermal_storage: + +Thermal energy storage +====================== + +Thermal energy storages of the type sensible heat storage (SHS) are modelled as :code:`GenericStorage` like described above. The implementation of a specific type of SHS, the stratified thermal energy storage, is described in section :ref:`stratified_tes`. +The modelling of latent-heat (or Phase-change) and chemical storages have not been tested with the open-plan-tool, but might be achieved by precalculations. + +.. _stratified_tes: + +Stratified thermal energy storage +================================= + +Stratified thermal energy storage is defined by the two optional parameters :ref:`fixed_thermal_losses_relative-label` and :ref:`fixed_thermal_losses_absolute-label`. +These two parameters are used to take into account temperature dependent losses of a thermal storage. To model a thermal energy storage without stratification, the two parameters are not set. The default values of :ref:`fixed_thermal_losses_relative-label` and :ref:`fixed_thermal_losses_absolute-label` are zero. +Except for these two additional parameters the stratified thermal storage is implemented in the same way as other storage components. + +Precalculations of the :ref:`installedcap-label`, :ref:`efficiency-label`, :ref:`fixed_thermal_losses_relative-label` and :ref:`fixed_thermal_losses_absolute-label` can be done orientating on the stratified thermal storage component of `oemof.thermal `__. +The parameters :code:`U-value`, :code:`volume` and :code:`surface` of the storage, which are required to calculate :ref:`installedcap-label`, can be precalculated as well. + +The efficiency :math:`\eta` of the storage is calculated as follows: + +.. math:: + \eta = 1 - loss{\_}rate + +This example shows how to do precalculations using stratified thermal storage specific input data: + + +.. code-block:: python + + from oemof.thermal.stratified_thermal_storage import ( + calculate_storage_u_value, + calculate_storage_dimensions, + calculate_capacities, + calculate_losses, + ) + + # Precalculation + u_value = calculate_storage_u_value( + input_data['s_iso'], + input_data['lamb_iso'], + input_data['alpha_inside'], + input_data['alpha_outside']) + + volume, surface = calculate_storage_dimensions( + input_data['height'], + input_data['diameter'] + ) + + nominal_storage_capacity = calculate_capacities( + volume, + input_data['temp_h'], + input_data['temp_c']) + + loss_rate, fixed_losses_relative, fixed_losses_absolute = calculate_losses( + u_value, + input_data['diameter'], + input_data['temp_h'], + input_data['temp_c'], + input_data['temp_env']) + +Please see the `oemof.thermal` `examples `__ and the `documentation `__ for further information. + +For an investment optimization the height of the storage should be left open in the precalculations and `installedCap` should be set to 0 or NaN. + +An implementation of the stratified thermal storage component has been done in `pvcompare `__. You can find the precalculations of the stratified thermal energy storage made in `pvcompare` `here `__. + + +Energy excess +############# + +.. note:: + Energy excess components are implemented **automatically** by the open-plan-tool! You do not need to define them yourself. + +An energy excess sink is placed on each of the LES energy busses, and therefore energy excess is allowed to take place on each bus of the LES. +This means that there are assumed to be sufficient vents (heat) or resistors (electricity) to dump excess (waste) generation. +Excess generation can only take place when a non-dispatchable source is present or if an asset is allowed to supply energy without any fuel or dispatch costs. + +In case of excessive excess energy, a warning is issued that it seems to be cheaper to have high excess generation than investing into more capacities. +High excess energy can for example result into an optimized inverter capacity that is smaller than the peak generation of installed PV. +The model becomes unrealistic when the excess is very high. diff --git a/docs/model/constraints.rst b/docs/model/constraints.rst new file mode 100644 index 0000000..539887d --- /dev/null +++ b/docs/model/constraints.rst @@ -0,0 +1,78 @@ +.. _constraints-label: + +Constraints +----------- + +.. _constraint_min_re_factor: + +Minimal renewable factor constraint +################################### + +The minimal renewable factor constraint requires the capacity and dispatch optimization of the open-plan-tool to reach at least the minimal renewable factor defined within the constraint. The renewable share of the optimized energy system may also be higher than the minimal renewable factor. + +The minimal renewable factor is applied to the minimal renewable factor of the whole, sector-coupled energy system, but not to specific sectors. As such, energy carrier weighting plays a role and may lead to unexpected results. The constraint reads as follows: + +.. TODO: express this equation with variables as used with output KPIs + +.. math:: + minimal renewable factor <= \frac{\sum renewable generation \cdot weighting factor}{\sum renewable generation \cdot weighting factor + \sum non-renewable generation \cdot weighting factor} + +Please be aware that the minimal renewable factor constraint defines bounds for the :ref:`renewable_factor` of the system, ie. taking into account both local generation as well as renewable supply from the energy providers. The constraint explicitly does not aim to reach a certain :ref:`renewable_share_of_local_generation` on-site. + +Depending on the energy system, especially when working with assets which are not to be capacity-optimized, it is possible that the minimal renewable factor criterion cannot be met. The simulation terminates in that case. If you are not sure if your energy system can meet the constraint, set all :code:`optimize_Cap` parameters of your optimizable assets to :code:`True`, and then investigate further. + +Also, if you are aiming at very high minimal renewable factors, the simulation time can increase drastically. If you do not get a result after an execessive simulation time (e.g. 10 times the simulation without constraints), you should consider terminating the simulation and trying with a lower minimum renewable share. + + +.. _constraint_minimal_degree_of_autonomy: + +Minimal degree of autonomy constraint +###################################### + +The minimal degree of autonomy constraint requires the capacity and dispatch optimization of the open-plan-tool to reach at least the minimal degree of autonomy defined within the constraint. The degree of autonomy of the optimized energy system may also be higher than the minimal degree of autonomy. For more details, refer to the definition of :ref:`degree of autonomy ` + +The minimal degree of autonomy is applied to the whole, sector-coupled energy system, but not to specific sectors. As such, energy carrier weighting plays a role and may lead to unexpected results. + +.. TODO clarify what is the intent of this sentence, I would expect an example of an "unexpected results situation" + +The constraint reads as follows: + +.. math:: + minimal~degree~of~autonomy <= DA = \frac{\sum E_{demand,i} \cdot w_i - \sum E_{consumption,provider,j} \cdot w_j}{\sum E_{demand,i} \cdot w_i} + +Depending on the energy system, especially when working with assets which are not subject to the optimization of their capacities, it is possible that the minimal degree of autonomy criterion cannot be met. The simulation terminates in that case. If you are not sure if your energy system can meet the constraint, set all :ref:`optimizecap-label` parameters of your optimizable assets to :code:`True`, and then investigate further. + + +.. _constraint_maximum_emissions: + +Maximum emission constraint +########################### + +The maximum emission constraint limits the maximum amount of total emissions per year of the energy system. It allows the capacity and dispatch optimization of the open-plan-tool to result into a maximum amount of emissions defined by the maximum emission constraint. The yearly emissions of the optimized energy system may also be lower than the maximum emission constraint. + +.. note:: The maximum emissions constraint currently does not take into consideration life cycle emissions, also see :ref:`total_emissions` section for an explanation. + +The unit of the constraint is `kgCO2eq/a`. To pick a realistic value for this constraint you can e.g.: + +- Firstly, optimize your system without the constraint to get an idea about the scale of the emissions and then, secondly, set the constraint and lower the emissions step by step until you reach an unbound problem (which then represents the non-achievable minimum of emissions for your energy system) +- Check the emissions targets of your region/country and disaggregate the number + + +.. _constraint_net_zero_energy: + +Net zero energy (NZE) constraint +################################ + +The net zero energy (NZE) constraint requires the capacity and dispatch optimization of the open-plan-tool to result into a net zero system, but can also result in a plus energy system. +The degree of NZE of the optimized energy system may be higher than 1, in case of a plus energy system. Please find the definition of net zero energy (NZE) and the KPI here: :ref:`degree_of_nze`. + +.. TODO quote the literature references here + +Some definitions of NZE systems in literature allow the energy system's demand solely be provided by locally generated renewable energy. In the open-plan-tool this is not the case - all locally generated energy is taken into consideration. To enlarge the share of renewables in the energy system you can use the :ref:`constraint_min_re_factor`. + +The NZE constraint is applied to the whole, sector-coupled energy system, but not to specific sectors. As such, energy carrier weighting plays a role and may lead to unexpected results. The constraint reads as follows: + +.. math:: + \sum_{i} {E_{feedin, provider} (i) \cdot w_i - E_{consumption, provider} (i) \cdot w_i} >= 0 + +Depending on the energy system, especially when working with assets which are not subject to the optimization of their capacities, it is possible that the NZE criterion cannot be met. The simulation terminates in that case. If you are not sure whether your energy system can meet the constraint, set all :ref:`optimizecap-label` parameters of your optimizable assets to :code:`True`, and then investigate further. diff --git a/docs/model/images/example_dispatch_assets.png b/docs/model/images/example_dispatch_assets.png new file mode 100644 index 0000000..40ac1af Binary files /dev/null and b/docs/model/images/example_dispatch_assets.png differ diff --git a/docs/model/images/example_excel_scalar.png b/docs/model/images/example_excel_scalar.png new file mode 100644 index 0000000..ad76809 Binary files /dev/null and b/docs/model/images/example_excel_scalar.png differ diff --git a/docs/model/images/example_excel_timeseries.png b/docs/model/images/example_excel_timeseries.png new file mode 100644 index 0000000..7d72ed5 Binary files /dev/null and b/docs/model/images/example_excel_timeseries.png differ diff --git a/docs/model/images/example_input_timeseries.png b/docs/model/images/example_input_timeseries.png new file mode 100644 index 0000000..0cff0e6 Binary files /dev/null and b/docs/model/images/example_input_timeseries.png differ diff --git a/docs/model/images/example_logfile.png b/docs/model/images/example_logfile.png new file mode 100644 index 0000000..8963b36 Binary files /dev/null and b/docs/model/images/example_logfile.png differ diff --git a/docs/model/images/example_miniature_report.png b/docs/model/images/example_miniature_report.png new file mode 100644 index 0000000..5f743fc Binary files /dev/null and b/docs/model/images/example_miniature_report.png differ diff --git a/docs/model/images/example_om_pie_chart.png b/docs/model/images/example_om_pie_chart.png new file mode 100644 index 0000000..f350170 Binary files /dev/null and b/docs/model/images/example_om_pie_chart.png differ diff --git a/docs/model/images/example_optimal_additional_capacities.png b/docs/model/images/example_optimal_additional_capacities.png new file mode 100644 index 0000000..560b5c5 Binary files /dev/null and b/docs/model/images/example_optimal_additional_capacities.png differ diff --git a/docs/model/images/example_report_header.png b/docs/model/images/example_report_header.png new file mode 100644 index 0000000..a34ecc9 Binary files /dev/null and b/docs/model/images/example_report_header.png differ diff --git a/docs/model/images/example_simulation_report.pdf b/docs/model/images/example_simulation_report.pdf new file mode 100644 index 0000000..e2668c6 Binary files /dev/null and b/docs/model/images/example_simulation_report.pdf differ diff --git a/docs/model/images/network_graph.png b/docs/model/images/network_graph.png new file mode 100644 index 0000000..9e62709 Binary files /dev/null and b/docs/model/images/network_graph.png differ diff --git a/docs/model/input_parameters.rst b/docs/model/input_parameters.rst new file mode 100644 index 0000000..eace6b2 --- /dev/null +++ b/docs/model/input_parameters.rst @@ -0,0 +1,36 @@ +.. _input_parameters: + +================ +Input parameters +================ + +******************* +Table of parameters +******************* + +.. This file is generated automatically when conf.py is executed (function generate_parameter_table) + +The input parameters are gathered in the table below. Each parameter is provided with unit, type and example values. For more information about one parameter, please click on it. + +.. csv-table:: Parameters summary + :file: parameters/MVS_parameters_list.tbl + :header-rows: 1 + + +****************** +List of parameters +****************** + +Below is the list of all the parameters of the open-plan-tool, sorted in alphabetical order. +Each of the parameters has the following properties + +:Definition: parameter's definition, could also contain potential use cases of the parameter +:Type: str (text), numeric (integer or double precision number), boolean (True or False) +:Unit: physical unit +:Example: an example of parameter's value +:Restrictions: specific restrictions on the parameter's value (e.g., "positive integer number", "must be an even number", "must be one of ['val1', 'val2']" +:Default: default parameter's value + +.. This file is generated automatically when conf.py is executed (function generate_parameter_description) + +.. include:: parameters/MVS_parameters_list.inc diff --git a/docs/model/limitations.rst b/docs/model/limitations.rst new file mode 100644 index 0000000..e1bbe61 --- /dev/null +++ b/docs/model/limitations.rst @@ -0,0 +1,257 @@ +Limitations +----------- + +When running simulations with the open-plan-tool, there are certain peculiarities to be aware of. +The peculiarities can be considered as limitations, some of which are merely model assumptions and others are drawbacks of the model. +A number of those are inherited due to the nature of the open-plan-tool and its underlying modules. +The following table (:ref:`table_limitations_label`) lists the limitations of open-plan-tool based on their type. + + +.. _table_limitations_label: + +.. list-table:: Limitations + :widths: 15 15 + :header-rows: 1 + :class: limitations-table + + * - Inherited + - Can be addressed + * - :ref:`limitations-real-life-constraint` + - :ref:`limitations-bidirectional-transformers` + * - :ref:`limitations-simplified_model` + - :ref:`limitations-random-excess` + * - :ref:`limitations-degradation` + - :ref:`limitations-renewable-share-definition` + * - :ref:`limitations-perfect_foresight` + - :ref:`limitations-energy_carrier_weighting` + * - + - :ref:`limitations-energy_shortage` + +.. _limitations-real-life-constraint: + +Infeasible bi-directional flow in one timestep +############################################## + +:Limitation: + +It is not possible to model two flows in opposite directions during the same time step. + +:Reason: + +The open-plan-tool is based on the python library :code:`oemof-solph`. Its generic components are used to set up the energy system. As a ground rule, the components of :code:`oemof-solph` are unidirectional. This means that for an asset that is bidirectional two transformer objects have to be used. Examples for this are: + +* Physical bi-directional assets, eg. inverters +* Logical bi-directional assets, eg. consumption from the grid and feed-in to the grid + +To achieve the real-life constraint one flow has to be zero when the other is larger zero, one would have to implement following relation: + +.. math:: + E_{in} \cdot E_{out} = 0 + +However, this relation creates a non-linear problem and can not be implemented in :code:`oemof-solph`. + +:Implications: + +This limitation means that the open-plan-tool might result in infeasible dispatch of assets. For instance, a bus might be supplied by a rectifier and itself supplying an inverter at the same time step t, which cannot logically happen if these assets are part of one physical bi-directional inverter. Another case that could occur is feeding the grid and consuming from it at the same time t. + +Under certain conditions, including excess generation as well as dispatch costs of zero, the infeasible dispatch can also be observed for batteries and result in a parallel charge and discharge of the battery. If this occurs, a solution may be to set a marginal dispatch cost of battery charge. + +.. _limitations-simplified_model: + +Simplified linear component models +################################## + +:Limitation: + +The open-plan-tool simplifies the component model of some assets. + + * Generators have an efficiency that is not load-dependent + * Storage have a charging efficiency that is not SOC-dependent + * Turbines are implemented without ramp rates + +:Reason: + +The open-plan-tool is based :code:`oemof-solph` python library and uses its generic components to set up an energy system. Transformers and storages cannot have variable efficiencies, because otherwise the system of equation to solve would not be linear. + +:Implications: + +Simplifying the implementation of some component specifications can be beneficial for the ease of the model, however, it contributes to the lack of realism and might result in less accurate values. The open-plan-tool trades off the decreased level of detail for a quick evaluation of its scenarios, which are often only used for a pre-feasibility analysis. + +.. _limitations-degradation: + +No degradation of efficiencies over a component lifetime +######################################################## + +:Limitation: + +The open-plan-tool does not degrade the efficiencies of assets over the lifetime of the project, eg. in the case of production assets like PV panels. + +:Reason: + +The simulation of the open-plan-tool is only based on a single reference year, and it is not possible to take into account multi-year degradation of asset efficiency. + +:Implications: + +This results in an overestimation of the energy generated by the asset, which implies that the calculation of some other results might also be overestimated (e.g. overestimation of feed-in energy). The user can circumvent this by applying a degradation factor manually to the generation time series used as an input for the open-plan-tool. + +.. _limitations-perfect_foresight: + +Perfect foresight +################# + +:Limitation: + +The optimal solution of the energy system is based on perfect foresight. + +:Reason: + +As the open-plan-tool and thus :code:`oemof-solph`, which is handling the energy system model, know the generation and demand profiles for the whole simulation time and solve the optimization problem based on a linear equation system, the solver knows their dispatch for certain, whereas in reality the generation and demand could only be forecasted. + +:Implications: + +The perfect foresight can lead to suspicious dispatch of assets, for example charging of a battery right before a (in real-life) random blackout occurs. The systems optimized with the open-plan-tool therefore, represent their optimal potential, which in reality could not be reached. The open-plan-tool has thus a tendency to underestimate the needed battery capacity or the minimal state of charge for backup purposes, and also designs the PV system and backup power according to perfect forecasts. In reality, operational margins would need to be considered. + + +.. _limitation_precision_limit: + +Optimization precision +###################### + +:Limitation: + +Marginal capacities and flows below a threshold of 10^-6 are rounded to zero. + +:Reason: + +The open-plan-tool makes use of the open energy modelling framework (oemof) by using :code:`oemof-solph`. For the open-plan-tool, we use the :code:`cbc-solver` with a :code:`ratioGap=0.03`. This influences the precision of the optimized decision variables, ie. the optimized capacities as well as the dispatch of the assets. +In some cases the dispatch and capacities vary around 0 with fluctuations of the order of floating point precision (well below <10e-6), thus resulting sometimes in marginal fluctuations dispatch or capacities around 0. When calculating KPI from these decision variables, the results can be nonsensical, for example leading to SoC curves with negative values or values far above the viable value 1. +As the reason for these inconsistencies is known, the open-plan-tool enforces the capacities and dispatch of to be above 10e-6, ie. all capacities or flows smaller than that are automatically set to zero. This is applied to absolute values, so that irregular (and incorrect) values for decision variables can still be detected. + + +:Implications: + +If your energy system has demand or resource profiles that include marginal values below the threshold of 10^-6, the open-plan-tool will not result in appropriate results. For example, that means that if you have an energy system with usually is measured in `MW` but one demand is in the `W` range, the dispatch of assets serving this minor demand is not displayed correctly. Please consider using `kW` or even `W` as a base unit then. + +Extension of KPIs necessary +########################### + +:Limitation: + +Some important KPIs usually required by developers are currently not implemented within open-plan-tool: + +* Internal rate of return (IRR) +* Payback period +* Return on equity (ROE), + +:Reason: + +The open-plan-tool is a work in progress and this can still be addressed in the future. + +:Implications: + +The absence of such indicators might affect decision-making. + +.. _limitations-random-excess: + +Random excess energy distribution +################################# + +:Limitation: + +There is random excess distribution between the feed-in sink and the excess sink when no feed-in-tariff is assumed in the system. + +:Reason: + +Since there is no feed-in-tariff to benefit from, the open-plan-tool randomly distributes the excess energy between the feed-in and excess sinks. As such, the distribution of excess energy changes when running several simulations for the same input files. + +:Implications: + +On the first glance, the distribution of excess energy onto both feed-in sink and excess sink may seem off to the end-user. Other than these inconveniences, there are no real implications that affect the capacity and dispatch optimization. When a degree of self-supply and self-consumption is defined, the limitation might tarnish these results. + +.. _limitations-renewable-share-definition: + +Renewable energy share definition relative to energy carriers +############################################################# + +:Limitation: + +The current renewable energy share depends on the share of renewable energy production assets directly feeding the load. The equation to calculate the share also includes the energy carrier rating as described here below: + +.. math:: + RES &= \frac{\sum_i E_{RE,generation}(i) \cdot w_i}{\sum_i E_{RE,generation}(i) \cdot w_i + \sum_k E_{nonRE,generation}(k) \cdot w_k} + + \text{with~} & i \text{: renewable energy asset} + + & k \text{: non-renewable energy asset} + +:Reason: + +The open-plan-tool is a work in progress and this can still be addressed in the future. + +:Implications: + +This might result in different values when comparing them to other models. Another way to calculate it is by considering the share of energy consumption supplied from renewable sources. + +.. _limitations-energy_carrier_weighting: + +Energy carrier weighting +######################## + +:Limitation: + +The open-plan-tool assumes a usable energy content rating for every energy carrier. The current version assumes that 1 kWh thermal is equivalent to 1 kWh electricity. + +:Reason: + +This is an approach that open-plan-tool currently uses. + +:Implications: + +By weighing the energy carriers according to their energy content (Gasoline Gallon Equivalent (GGE)), the open-plan-tool might result in values that can't be directly assessed. Those ratings affect the calculation of the levelized cost of the energy carriers, but also the minimum renewable energy share constraint. + +.. TODO: I am not sure I understand what values can't be assessed here? + +.. _limitations-energy_shortage: + +Events of energy shortage or grid interruption cannot be modelled +################################################################# + +:Limitation: + +The open-plan-tool assumes no shortage or grid interruption in the system. + +:Reason: + +The aim of the open-plan-tool does not cover this scenario. + +:Implications: + +Electricity shortages due to power cuts might happen in real life and the open-plan-tool currently omits this scenario. +If a system is self-sufficient but relies on grid-connected PV systems, +the latter stop feeding the load if any power cuts occur +and the battery storage systems might not be enough to serve the load thus resulting energy shortage. + +.. _limitations-bidirectional-transformers: + +Need to model one technical unit with two transformer assets +############################################################ + +:Limitation: + +Two transformer objects representing one technical unit in real life are currently unlinked in terms of capacity and attributed costs. + +.. TODO: the last sentence is not very good, what did you mean here? + +:Reason: + +The open-plan-tool uses :code:`oemof-solph`'s generic components which are unidirectional so for a bidirectional asset, +two transformer objects have to be used. + +:Implications: + +Since only one input is allowed, such technical units are modelled as two separate transformers that are currently unlinked in the open-plan-tool (e.g., hybrid inverter, heat pump, distribution transformer, etc.). +This raises a difficulty to define costs in the input data. +It also results in two optimized capacities for one logical unit. + +This limitation can be addressed with a constraint which links both capacities of one logical unit, +and therefore solves both the problem to attribute costs and the previously differing capacities. diff --git a/docs/model/outputs/.gitkeep b/docs/model/outputs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/model/outputs/MVS_kpi_categories.inc b/docs/model/outputs/MVS_kpi_categories.inc new file mode 100644 index 0000000..dc11620 --- /dev/null +++ b/docs/model/outputs/MVS_kpi_categories.inc @@ -0,0 +1,45 @@ +Technical KPI are calculated to assess the performance of a simulated energy system, ie. represent the technical system configuration and operation. They are calculated based on the asset capacities and asset dispatch. They should allow the comparision of different energy system topologies and different project sites with each other. These are the calculated technical KPI: + +* :ref:`Aggregated flow ` +* :ref:`Average flow ` +* :ref:`Degree of Autonomy ` +* :ref:`Degree of Net Zero Energy ` +* :ref:`Dispatch of an asset ` +* :ref:`Onsite energy fraction ` +* :ref:`Onsite energy matching ` +* :ref:`Optimal additional capacity ` +* :ref:`Peak flow ` +* :ref:`Renewable factor ` +* :ref:`Renewable share of local generation ` +* :ref:`Energy import ` +* :ref:`Energy demand ` +* :ref:`Energy excess ` +* :ref:`Energy export ` +* :ref:`Total local generation ` +* :ref:`Total non-renewable local generation ` +* :ref:`Total renewable local generation ` +* :ref:`Total non-renewable energy use ` +* :ref:`Total renewable energy use ` + + +Economic KPI are calculated to assess the costs of a simulated energy system. They include the costs per asset as well as the system's overall costs. Relative values like the levelized costs of supply allow a comparision to other investment options. These are the calculated economic KPI: + +* :ref:`Annual operation, maintenance and dispatch expenses ` +* :ref:`Annuity ` +* :ref:`Costs attributed to a specific sector ` +* :ref:`Operation and maintenance costs ` +* :ref:`Dispatch costs ` +* :ref:`Investment costs ` +* :ref:`Operation, maintenance and dispatch costs ` +* :ref:`Net Present Costs (NPC) ` +* :ref:`Upfront investment costs ` +* :ref:`Levelized cost of throughput ` +* :ref:`Levelized costs of electricity equivalent ` +* :ref:`Replacement costs ` + + +Environmental KPI are calculated to assess the impact of a simulated energy system on the environment. These are the calculated environmental KPI: + +* :ref:`Specific GHG per electricity equivalent ` +* :ref:`Total GHG emissions ` + diff --git a/docs/model/outputs/annual_total_flow.inc b/docs/model/outputs/annual_total_flow.inc new file mode 100644 index 0000000..77477f6 --- /dev/null +++ b/docs/model/outputs/annual_total_flow.inc @@ -0,0 +1,11 @@ +.. _annual_total_flow: + +Aggregated flow (annual_total_flow) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Dispatch of the asset over a year, aggregated generation, demand or throughput. +:Type: Numeric +:Unit: kWh +:Valid Interval: >=0 +:Related indicators: :ref:`average_flow` | :ref:`peak_flow` + diff --git a/docs/model/outputs/annuity_om.inc b/docs/model/outputs/annuity_om.inc new file mode 100644 index 0000000..f5a6bbe --- /dev/null +++ b/docs/model/outputs/annuity_om.inc @@ -0,0 +1,11 @@ +.. _annuity_om: + +Annual operation, maintenance and dispatch expenses (annuity_om) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Annuity of the operation, maintenance and dispatch costs of the asset or energy system, i.e. ballpark number of the annual expenses for asset or system operation. +:Type: Numeric +:Unit: currency/a +:Valid Interval: >=0 +:Related indicators: :ref:`annuity_total` | :ref:`costs_om_total` + diff --git a/docs/model/outputs/annuity_total.inc b/docs/model/outputs/annuity_total.inc new file mode 100644 index 0000000..98019fd --- /dev/null +++ b/docs/model/outputs/annuity_total.inc @@ -0,0 +1,11 @@ +.. _annuity_total: + +Annuity (annuity_total) +^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Annuity of the assets costs over the project lifetime or the energy system's :ref:`net present costs (NPC) ` . +:Type: Numeric +:Unit: currency/a +:Valid Interval: >=0 +:Related indicators: :ref:`annuity_om` | :ref:`costs_total` + diff --git a/docs/model/outputs/attributed_costs.inc b/docs/model/outputs/attributed_costs.inc new file mode 100644 index 0000000..aa105bb --- /dev/null +++ b/docs/model/outputs/attributed_costs.inc @@ -0,0 +1,11 @@ +.. _attributed_costs: + +Costs attributed to a specific sector (attributed_costs) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Costs attributed to supplying the demand of a specific sector, based on the :ref:`net present costs (NPC) ` of the energy system and the share of the sector demand compared to the overall system demand. +:Type: Numeric +:Unit: currency +:Valid Interval: >=0 +:Related indicators: :ref:`costs_total` + diff --git a/docs/model/outputs/automatic_report.inc b/docs/model/outputs/automatic_report.inc new file mode 100644 index 0000000..38d2072 --- /dev/null +++ b/docs/model/outputs/automatic_report.inc @@ -0,0 +1,11 @@ +.. _automatic_report: + +Simulation report +^^^^^^^^^^^^^^^^^ + +:Definition: Automatically generated simulation report, including the most important input data as well as all output data. The `html` can be browsed interactively, while the `pdf` can be shared with partners. +:Type: html or pdf +:Unit: NA +:Valid Interval: NA +:Related indicators: None + diff --git a/docs/model/outputs/average_flow.inc b/docs/model/outputs/average_flow.inc new file mode 100644 index 0000000..f3dac18 --- /dev/null +++ b/docs/model/outputs/average_flow.inc @@ -0,0 +1,11 @@ +.. _average_flow: + +Average flow (average_flow) +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Average value of the assets dispatch. The ratio of average dispatch to peak dispatch indicates how much the asset is used in comparison to its actual installed capacity. +:Type: Numeric +:Unit: kWh +:Valid Interval: >=0 +:Related indicators: :ref:`annual_total_flow` | :ref:`peak_flow` + diff --git a/docs/model/outputs/bar_chart_optimizedAddCap.inc b/docs/model/outputs/bar_chart_optimizedAddCap.inc new file mode 100644 index 0000000..baf00b7 --- /dev/null +++ b/docs/model/outputs/bar_chart_optimizedAddCap.inc @@ -0,0 +1,11 @@ +.. _bar_chart_optimizedAddCap: + +Bar chart of optimal capacities +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: A bar chart to compare the optimized additional capacities for each asset to be installed in the energy system. Please be aware that the units of the capacities may different. +:Type: Figure +:Unit: kWh, kWp, kW, ... +:Valid Interval: NA +:Related indicators: :ref:`optimizedAddCap` + diff --git a/docs/model/outputs/costs_cost_om.inc b/docs/model/outputs/costs_cost_om.inc new file mode 100644 index 0000000..1166768 --- /dev/null +++ b/docs/model/outputs/costs_cost_om.inc @@ -0,0 +1,11 @@ +.. _costs_cost_om: + +Operation and maintenance costs (costs_cost_om) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Costs for fix annual operation and maintenance costs over the whole project lifetime, which do not depend on the assets dispatch but solely on installed capacity. An example would be the maintenance costs for cleaning the installed PV capacity. +:Type: Numeric +:Unit: currency +:Valid Interval: >=0 +:Related indicators: :ref:`costs_dispatch` | :ref:`costs_investment_over_lifetime` | :ref:`costs_om_total` | :ref:`costs_total` | :ref:`costs_upfront_in_year_zero` + diff --git a/docs/model/outputs/costs_dispatch.inc b/docs/model/outputs/costs_dispatch.inc new file mode 100644 index 0000000..f7c1b55 --- /dev/null +++ b/docs/model/outputs/costs_dispatch.inc @@ -0,0 +1,11 @@ +.. _costs_dispatch: + +Dispatch costs (costs_dispatch) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Dispatch costs over the whole project lifetime including all expenditures that depend on the dispatch of assets (e.g. fuel costs, electricity consumption from the external grid, costs for operation and maintainance that depend on the throughput of an asset) +:Type: Numeric +:Unit: currency +:Valid Interval: >=0 +:Related indicators: :ref:`costs_cost_om` | :ref:`costs_investment_over_lifetime` | :ref:`costs_om_total` | :ref:`costs_total` | :ref:`costs_upfront_in_year_zero` + diff --git a/docs/model/outputs/costs_investment_over_lifetime.inc b/docs/model/outputs/costs_investment_over_lifetime.inc new file mode 100644 index 0000000..2c9bc81 --- /dev/null +++ b/docs/model/outputs/costs_investment_over_lifetime.inc @@ -0,0 +1,11 @@ +.. _costs_investment_over_lifetime: + +Investment costs (costs_investment_over_lifetime) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Investment costs over the whole project lifetime, including all replacement costs. +:Type: Numeric +:Unit: currency +:Valid Interval: >=0 +:Related indicators: :ref:`costs_cost_om` | :ref:`costs_dispatch` | :ref:`costs_om_total` | :ref:`costs_total` | :ref:`costs_upfront_in_year_zero` | :ref:`replacement_costs_during_project_lifetime` + diff --git a/docs/model/outputs/costs_om_total.inc b/docs/model/outputs/costs_om_total.inc new file mode 100644 index 0000000..9834908 --- /dev/null +++ b/docs/model/outputs/costs_om_total.inc @@ -0,0 +1,11 @@ +.. _costs_om_total: + +Operation, maintenance and dispatch costs (costs_om_total) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Costs for annual operation and maintenance costs as well as dispatch of all assets of the energy system, for the whole project duration. +:Type: Numeric +:Unit: currency +:Valid Interval: >=0 +:Related indicators: :ref:`costs_cost_om` | :ref:`costs_dispatch` | :ref:`costs_investment_over_lifetime` | :ref:`costs_total` | :ref:`costs_upfront_in_year_zero` + diff --git a/docs/model/outputs/costs_total.inc b/docs/model/outputs/costs_total.inc new file mode 100644 index 0000000..ba4460c --- /dev/null +++ b/docs/model/outputs/costs_total.inc @@ -0,0 +1,11 @@ +.. _costs_total: + +Net Present Costs (NPC) (costs_total) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Net present costs of the system for the whole project duration, includes all operation, maintainance and dispatch costs as well as the investment costs (including replacements). Applied to a single asset, the costs can also be called present costs of the asset. +:Type: Numeric +:Unit: currency +:Valid Interval: >=0 +:Related indicators: :ref:`costs_cost_om` | :ref:`costs_dispatch` | :ref:`costs_investment_over_lifetime` | :ref:`costs_om_total` | :ref:`costs_upfront_in_year_zero` + diff --git a/docs/model/outputs/costs_upfront_in_year_zero.inc b/docs/model/outputs/costs_upfront_in_year_zero.inc new file mode 100644 index 0000000..2c0a493 --- /dev/null +++ b/docs/model/outputs/costs_upfront_in_year_zero.inc @@ -0,0 +1,11 @@ +.. _costs_upfront_in_year_zero: + +Upfront investment costs (costs_upfront_in_year_zero) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: The costs which will have to be paid upfront when project begins, ie. In year 0. These are the investment and fix project costs into the chosen configuration. +:Type: Numeric +:Unit: currency +:Valid Interval: >=0 +:Related indicators: :ref:`costs_cost_om` | :ref:`costs_dispatch` | :ref:`costs_investment_over_lifetime` | :ref:`costs_om_total` | :ref:`costs_total` + diff --git a/docs/model/outputs/degree_of_autonomy.inc b/docs/model/outputs/degree_of_autonomy.inc new file mode 100644 index 0000000..1908819 --- /dev/null +++ b/docs/model/outputs/degree_of_autonomy.inc @@ -0,0 +1,11 @@ +.. _degree_of_autonomy: + +Degree of Autonomy (degree_of_autonomy) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: A degree of autonomy close to zero shows high dependence on the energy provider, while a degree of autonomy of 1 represents an autonomous or net-energy system and a degree of autonomy higher 1 a surplus-energy system. +:Type: Numeric +:Unit: Factor +:Valid Interval: [0,1] +:Related indicators: :ref:`total_demand` + diff --git a/docs/model/outputs/degree_of_nze.inc b/docs/model/outputs/degree_of_nze.inc new file mode 100644 index 0000000..1d6d9ed --- /dev/null +++ b/docs/model/outputs/degree_of_nze.inc @@ -0,0 +1,11 @@ +.. _degree_of_nze: + +Degree of Net Zero Energy (degree_of_nze) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: The degree of net zero energy describes the ability of an energy system to provide its aggregated annual demand through local sources. +:Type: Numeric +:Unit: Factor +:Valid Interval: >=0 +:Related indicators: :ref:`total_feedin` | :ref:`total_consumption_from_energy_provider` + diff --git a/docs/model/outputs/excel_scalar_kpi.inc b/docs/model/outputs/excel_scalar_kpi.inc new file mode 100644 index 0000000..3f13a52 --- /dev/null +++ b/docs/model/outputs/excel_scalar_kpi.inc @@ -0,0 +1,11 @@ +.. _excel_scalar_kpi: + +Excel file with all KPI +^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Excel sheet with all calculated KPI, both for the individual assets, the sectors and the overall energy system. +:Type: Excel file +:Unit: NA +:Valid Interval: NA +:Related indicators: None + diff --git a/docs/model/outputs/excel_timeseries.inc b/docs/model/outputs/excel_timeseries.inc new file mode 100644 index 0000000..11a234e --- /dev/null +++ b/docs/model/outputs/excel_timeseries.inc @@ -0,0 +1,11 @@ +.. _excel_timeseries: + +Excel file with dispatch timeseries +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Excel sheet with the dispatch of all assets of the energy system. Each tab represents one energy bus. +:Type: Excel file +:Unit: NA +:Valid Interval: NA +:Related indicators: :ref:`flow` | :ref:`plot_dispatch` + diff --git a/docs/model/outputs/flow.inc b/docs/model/outputs/flow.inc new file mode 100644 index 0000000..41de0db --- /dev/null +++ b/docs/model/outputs/flow.inc @@ -0,0 +1,11 @@ +.. _flow: + +Dispatch of an asset (flow) +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Optimized dispatch of an asset in the optimized energy system, ie. its generation or thoughput. +:Type: Time series (with time stamps and values) +:Unit: kW,kgH2,... +:Valid Interval: NA +:Related indicators: :ref:`plot_dispatch` | :ref:`peak_flow` | :ref:`annual_total_flow` | :ref:`average_flow` + diff --git a/docs/model/outputs/json_input_processed.inc b/docs/model/outputs/json_input_processed.inc new file mode 100644 index 0000000..826749e --- /dev/null +++ b/docs/model/outputs/json_input_processed.inc @@ -0,0 +1,11 @@ +.. _json_input_processed: + +Simulation data after pre-processing (JSON) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: This file includes all data that is used to setup the energy system model, including all the pre-processing performed within :ref:`the module C0 `. It is mostly used by developers. +:Type: JSON +:Unit: NA +:Valid Interval: NA +:Related indicators: None + diff --git a/docs/model/outputs/json_with_results.inc b/docs/model/outputs/json_with_results.inc new file mode 100644 index 0000000..c4bff21 --- /dev/null +++ b/docs/model/outputs/json_with_results.inc @@ -0,0 +1,11 @@ +.. _json_with_results: + +Simulation data and results (JSON) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: This file includes all simulation data and also results of the energy system optimization. With :code:`mvs_report` this file can be used to create a report without re-simulating the energy system. This file is also only used by developers, and also the file used to provide the EPA with the simulation results. +:Type: JSON +:Unit: NA +:Valid Interval: NA +:Related indicators: None + diff --git a/docs/model/outputs/levelized_cost_of_energy_of_asset.inc b/docs/model/outputs/levelized_cost_of_energy_of_asset.inc new file mode 100644 index 0000000..239d7f4 --- /dev/null +++ b/docs/model/outputs/levelized_cost_of_energy_of_asset.inc @@ -0,0 +1,11 @@ +.. _levelized_cost_of_energy_of_asset: + +Levelized cost of throughput (levelized_cost_of_energy_of_asset) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Cost per kWh throughput through an asset, based on the assets costs during the project lifetime as well as the total throughput through the asset in the project lifetime. For generation assets, equivalent to the levelized cost of generation. +:Type: Numeric +:Unit: currency/kWh +:Valid Interval: >=0 +:Related indicators: :ref:`annuity_total` | :ref:`annual_total_flow` + diff --git a/docs/model/outputs/levelized_costs_of_electricity_equivalent.inc b/docs/model/outputs/levelized_costs_of_electricity_equivalent.inc new file mode 100644 index 0000000..c3e5190 --- /dev/null +++ b/docs/model/outputs/levelized_costs_of_electricity_equivalent.inc @@ -0,0 +1,11 @@ +.. _levelized_costs_of_electricity_equivalent: + +Levelized costs of electricity equivalent (levelized_costs_of_electricity_equivalent) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Levelized cost of energy of the sector-coupled energy system, calculated from the systems annuity and the total system demand in electricity equivalent. +:Type: Numeric +:Unit: currency/kWheleq +:Valid Interval: >=0 +:Related indicators: :ref:`costs_total` | :ref:`total_demand` + diff --git a/docs/model/outputs/logfile.inc b/docs/model/outputs/logfile.inc new file mode 100644 index 0000000..5e05bd3 --- /dev/null +++ b/docs/model/outputs/logfile.inc @@ -0,0 +1,11 @@ +.. _logfile: + +MVS logfile +^^^^^^^^^^^ + +:Definition: Logfile of the MVS simulation including a number of log entries: Debug, information, warning and error messages. Helpful to debug the energy system simulation. +:Type: Logfile +:Unit: NA +:Valid Interval: NA +:Related indicators: None + diff --git a/docs/model/outputs/network_graph.inc b/docs/model/outputs/network_graph.inc new file mode 100644 index 0000000..1139a90 --- /dev/null +++ b/docs/model/outputs/network_graph.inc @@ -0,0 +1,11 @@ +.. _network_graph: + +Energy system model visualization +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Plot of the energy system model in oemof-solph topology. This graph also includes the automatically generated components, ie. the sub-assets of energy providers and an energy excess sink on each energy bus. The model therefore appears different than in the Energy Planning Application (EPA). +:Type: Figure +:Unit: NA +:Valid Interval: NA +:Related indicators: None + diff --git a/docs/model/outputs/onsite_energy_fraction.inc b/docs/model/outputs/onsite_energy_fraction.inc new file mode 100644 index 0000000..20eed36 --- /dev/null +++ b/docs/model/outputs/onsite_energy_fraction.inc @@ -0,0 +1,11 @@ +.. _onsite_energy_fraction: + +Onsite energy fraction (onsite_energy_fraction) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Onsite energy fraction is also referred to as self-consumption. It describes the fraction of all locally generated energy that is consumed by the system itself. +:Type: Numeric +:Unit: Factor +:Valid Interval: [0,1] +:Related indicators: :ref:`onsite_energy_matching` + diff --git a/docs/model/outputs/onsite_energy_matching.inc b/docs/model/outputs/onsite_energy_matching.inc new file mode 100644 index 0000000..efb7ecd --- /dev/null +++ b/docs/model/outputs/onsite_energy_matching.inc @@ -0,0 +1,11 @@ +.. _onsite_energy_matching: + +Onsite energy matching (onsite_energy_matching) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: The onsite energy matching is also referred to as self-sufficiency. It describes the fraction of the total demand that can be covered by the locally generated energy. +:Type: Numeric +:Unit: Factor +:Valid Interval: [0,1] +:Related indicators: :ref:`onsite_energy_fraction` | :ref:`total_feedin` + diff --git a/docs/model/outputs/optimizedAddCap.inc b/docs/model/outputs/optimizedAddCap.inc new file mode 100644 index 0000000..3c68823 --- /dev/null +++ b/docs/model/outputs/optimizedAddCap.inc @@ -0,0 +1,11 @@ +.. _optimizedAddCap: + +Optimal additional capacity (optimizedAddCap) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Capacity added to installed capacity for optimal economic system performance. +:Type: Numeric +:Unit: kW, kWh, kWp, ... +:Valid Interval: >=0 +:Related indicators: :ref:`peak_flow` + diff --git a/docs/model/outputs/peak_flow.inc b/docs/model/outputs/peak_flow.inc new file mode 100644 index 0000000..fd28593 --- /dev/null +++ b/docs/model/outputs/peak_flow.inc @@ -0,0 +1,11 @@ +.. _peak_flow: + +Peak flow (peak_flow) +^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Peak of the dispatch of an asset. +:Type: Numeric +:Unit: kW +:Valid Interval: >=0 +:Related indicators: :ref:`average_flow` | :ref:`annual_total_flow` + diff --git a/docs/model/outputs/pie_chart_costs.inc b/docs/model/outputs/pie_chart_costs.inc new file mode 100644 index 0000000..62df775 --- /dev/null +++ b/docs/model/outputs/pie_chart_costs.inc @@ -0,0 +1,11 @@ +.. _pie_chart_costs: + +Pie charts of cost parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Displays the share of individual asset costs on different economical parameters of the overall system +:Type: Figure +:Unit: Percentages +:Valid Interval: NA +:Related indicators: :ref:`costs_total` | :ref:`costs_om_total` | :ref:`annuity_total` + diff --git a/docs/model/outputs/plot_dispatch.inc b/docs/model/outputs/plot_dispatch.inc new file mode 100644 index 0000000..b21b26f --- /dev/null +++ b/docs/model/outputs/plot_dispatch.inc @@ -0,0 +1,11 @@ +.. _plot_dispatch: + +Dispatch of all assets on a bus +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Visualization of the dispatch of all assets of a specific energy bus, ie. all inflows and outflows of a specific bus. Generated for every single energy bus in the energy system. If relevant, a plot of the state of charge is also displayed. +:Type: Figure +:Unit: kW, kgH2, ... +:Valid Interval: NA +:Related indicators: :ref:`flow` + diff --git a/docs/model/outputs/plot_input_timeseries.inc b/docs/model/outputs/plot_input_timeseries.inc new file mode 100644 index 0000000..c6693cb --- /dev/null +++ b/docs/model/outputs/plot_input_timeseries.inc @@ -0,0 +1,11 @@ +.. _plot_input_timeseries: + +Input timeseries +^^^^^^^^^^^^^^^^ + +:Definition: Vizualization of timeseries provided as input data, eg. PV generation timeseries. +:Type: Figure +:Unit: kW, kgH2, ... +:Valid Interval: NA +:Related indicators: None + diff --git a/docs/model/outputs/renewable_factor.inc b/docs/model/outputs/renewable_factor.inc new file mode 100644 index 0000000..72a46f3 --- /dev/null +++ b/docs/model/outputs/renewable_factor.inc @@ -0,0 +1,11 @@ +.. _renewable_factor: + +Renewable factor (renewable_factor) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Describes the share of the energy influx to the local energy system that is provided from renewable sources. This includes both local generation as well as consumption from energy providers. +:Type: Numeric +:Unit: Factor +:Valid Interval: [0,1] +:Related indicators: :ref:`renewable_share_of_local_generation` | :ref:`onsite_energy_fraction` | :ref:`onsite_energy_matching` + diff --git a/docs/model/outputs/renewable_share_of_local_generation.inc b/docs/model/outputs/renewable_share_of_local_generation.inc new file mode 100644 index 0000000..5d56ec1 --- /dev/null +++ b/docs/model/outputs/renewable_share_of_local_generation.inc @@ -0,0 +1,11 @@ +.. _renewable_share_of_local_generation: + +Renewable share of local generation (renewable_share_of_local_generation) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: The renewable share of local generation describes how much of the energy generated locally is produced from renewable sources. It does not take into account the consumption from energy providers. +:Type: Numeric +:Unit: Factor +:Valid Interval: [0,1] +:Related indicators: :ref:`renewable_factor` + diff --git a/docs/model/outputs/replacement_costs_during_project_lifetime.inc b/docs/model/outputs/replacement_costs_during_project_lifetime.inc new file mode 100644 index 0000000..3282dad --- /dev/null +++ b/docs/model/outputs/replacement_costs_during_project_lifetime.inc @@ -0,0 +1,11 @@ +.. _replacement_costs_during_project_lifetime: + +Replacement costs (replacement_costs_during_project_lifetime) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Costs for replacement of assets which occur over the project lifetime. +:Type: Numeric +:Unit: currency +:Valid Interval: >=0 +:Related indicators: :ref:`costs_investment_over_lifetime` + diff --git a/docs/model/outputs/specific_emissions_per_electricity_equivalent.inc b/docs/model/outputs/specific_emissions_per_electricity_equivalent.inc new file mode 100644 index 0000000..50f3e01 --- /dev/null +++ b/docs/model/outputs/specific_emissions_per_electricity_equivalent.inc @@ -0,0 +1,11 @@ +.. _specific_emissions_per_electricity_equivalent: + +Specific GHG per electricity equivalent (specific_emissions_per_electricity_equivalent) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Specific GHG emissions per supplied electricity equivalent. +:Type: Numeric +:Unit: kg GHGeq/kWh +:Valid Interval: >=0 +:Related indicators: :ref:`total_emissions` + diff --git a/docs/model/outputs/total_consumption_from_energy_provider.inc b/docs/model/outputs/total_consumption_from_energy_provider.inc new file mode 100644 index 0000000..83c923e --- /dev/null +++ b/docs/model/outputs/total_consumption_from_energy_provider.inc @@ -0,0 +1,11 @@ +.. _total_consumption_from_energy_provider: + +Energy import (total_consumption_from_energy_provider) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Aggregated energy imports into the local energy system from the provider. +:Type: Numeric +:Unit: kWh, kWheleq, ... +:Valid Interval: >=0 +:Related indicators: None + diff --git a/docs/model/outputs/total_demand.inc b/docs/model/outputs/total_demand.inc new file mode 100644 index 0000000..bd52acf --- /dev/null +++ b/docs/model/outputs/total_demand.inc @@ -0,0 +1,11 @@ +.. _total_demand: + +Energy demand (total_demand) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Demand of energy in local energy system over a the project lifetime. +:Type: Numeric +:Unit: kWh, kWheleq, ... +:Valid Interval: >=0 +:Related indicators: None + diff --git a/docs/model/outputs/total_emissions.inc b/docs/model/outputs/total_emissions.inc new file mode 100644 index 0000000..3d3703a --- /dev/null +++ b/docs/model/outputs/total_emissions.inc @@ -0,0 +1,11 @@ +.. _total_emissions: + +Total GHG emissions (total_emissions) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Total greenhouse gas emissions in kg. +:Type: Numeric +:Unit: kg GHGeq +:Valid Interval: >=0 +:Related indicators: :ref:`renewable_factor` | :ref:`specific_emissions_per_electricity_equivalent` + diff --git a/docs/model/outputs/total_excess.inc b/docs/model/outputs/total_excess.inc new file mode 100644 index 0000000..cb2a743 --- /dev/null +++ b/docs/model/outputs/total_excess.inc @@ -0,0 +1,11 @@ +.. _total_excess: + +Energy excess (total_excess) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Excess of energy, ie. unused energy in local energy system. +:Type: Numeric +:Unit: kWh, kWheleq, ... +:Valid Interval: >=0 +:Related indicators: None + diff --git a/docs/model/outputs/total_feedin.inc b/docs/model/outputs/total_feedin.inc new file mode 100644 index 0000000..014b2da --- /dev/null +++ b/docs/model/outputs/total_feedin.inc @@ -0,0 +1,11 @@ +.. _total_feedin: + +Energy export (total_feedin) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Feed-in of energy into external grid. +:Type: Numeric +:Unit: kWh, kWheleq, ... +:Valid Interval: >=0 +:Related indicators: :ref:`onsite_energy_fraction` + diff --git a/docs/model/outputs/total_internal_generation.inc b/docs/model/outputs/total_internal_generation.inc new file mode 100644 index 0000000..9c45082 --- /dev/null +++ b/docs/model/outputs/total_internal_generation.inc @@ -0,0 +1,11 @@ +.. _total_internal_generation: + +Total local generation (total_internal_generation) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Aggregated amount of energy generated within the energy system. +:Type: Numeric +:Unit: kWheleq +:Valid Interval: >=0 +:Related indicators: :ref:`total_internal_non-renewable_generation` | :ref:`total_internal_renewable_generation` + diff --git a/docs/model/outputs/total_internal_non-renewable_generation.inc b/docs/model/outputs/total_internal_non-renewable_generation.inc new file mode 100644 index 0000000..a23286c --- /dev/null +++ b/docs/model/outputs/total_internal_non-renewable_generation.inc @@ -0,0 +1,11 @@ +.. _total_internal_non-renewable_generation: + +Total non-renewable local generation (total_internal_non-renewable_generation) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Aggregated amount of non-renewable energy generated within the energy system. +:Type: Numeric +:Unit: kWheleq +:Valid Interval: >=0 +:Related indicators: :ref:`total_internal_generation` | :ref:`total_internal_renewable_generation` + diff --git a/docs/model/outputs/total_internal_renewable_generation.inc b/docs/model/outputs/total_internal_renewable_generation.inc new file mode 100644 index 0000000..e1ec0d6 --- /dev/null +++ b/docs/model/outputs/total_internal_renewable_generation.inc @@ -0,0 +1,11 @@ +.. _total_internal_renewable_generation: + +Total renewable local generation (total_internal_renewable_generation) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Aggregated amount of renewable energy generated within the energy system. +:Type: Numeric +:Unit: kWheleq +:Valid Interval: >=0 +:Related indicators: :ref:`total_internal_generation` | :ref:`total_internal_non-renewable_generation` + diff --git a/docs/model/outputs/total_non-renewable_energy_use.inc b/docs/model/outputs/total_non-renewable_energy_use.inc new file mode 100644 index 0000000..669a85b --- /dev/null +++ b/docs/model/outputs/total_non-renewable_energy_use.inc @@ -0,0 +1,11 @@ +.. _total_non-renewable_energy_use: + +Total non-renewable energy use (total_non-renewable_energy_use) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Aggregated amount of non-renewable energy used within the energy system (ie. Including local generation and external supply). +:Type: Numeric +:Unit: kWheleq +:Valid Interval: >=0 +:Related indicators: :ref:`total_renewable_energy_use` + diff --git a/docs/model/outputs/total_renewable_energy_use.inc b/docs/model/outputs/total_renewable_energy_use.inc new file mode 100644 index 0000000..c507b86 --- /dev/null +++ b/docs/model/outputs/total_renewable_energy_use.inc @@ -0,0 +1,11 @@ +.. _total_renewable_energy_use: + +Total renewable energy use (total_renewable_energy_use) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition: Aggregated amount of renewable energy used within the energy system (ie. Including local generation and external supply). +:Type: Numeric +:Unit: kWheleq +:Valid Interval: >=0 +:Related indicators: :ref:`total_non-renewable_energy_use` + diff --git a/docs/model/parameters/.gitkeep b/docs/model/parameters/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/model/parameters/MVS_parameters_categories.inc b/docs/model/parameters/MVS_parameters_categories.inc new file mode 100644 index 0000000..afcb82b --- /dev/null +++ b/docs/model/parameters/MVS_parameters_categories.inc @@ -0,0 +1,161 @@ +.. _constraints: + +constraints.csv +^^^^^^^^^^^^^^^ + +The file `constraints.csv` includes the following parameter(s): + +* :ref:`maxemissions-label` +* :ref:`minda-label` +* :ref:`minrenshare-label` +* :ref:`nzeconstraint-label` + + +.. _economic_data: + +economic_data.csv +^^^^^^^^^^^^^^^^^ + +The file `economic_data.csv` includes all economic data that the simulation will use. This includes the following parameters: + +* :ref:`currency-label` +* :ref:`discountfactor-label` +* :ref:`projectduration-label` +* :ref:`tax-label` + + +.. _busses: + +energyBusses.csv +^^^^^^^^^^^^^^^^ + +The file `energyBusses.csv` defines all busses required to build the energy system. It includes following parameters: + +* :ref:`energyvector-label` + + +.. _consumption: + +energyConsumption.csv +^^^^^^^^^^^^^^^^^^^^^ + +The file `energyConsumption.csv` defines all energy demands that should be included in the energy system. It includes the following parameters: + +* :ref:`filename-label` +* :ref:`inflowdirection-label` +* :ref:`outflowdirec-label` + + +.. _conversion: + +energyConversion.csv +^^^^^^^^^^^^^^^^^^^^ + +The file `energyConversion.csv` defines the assets that convert one energy carrier into another one, eg. inverters or generators. Following parameters define them: + +* :ref:`developmentcosts-label` +* :ref:`dispatchprice-label` +* :ref:`efficiency-label` +* :ref:`installedcap-label` +* :ref:`lifetime-label` +* :ref:`optimizecap-label` +* :ref:`specificcosts-label` +* :ref:`specificomcosts-label` +* :ref:`typeoemof-label` +* :ref:`unit-label` +* :ref:`Beta-label` + + +.. _production: + +energyProduction.csv +^^^^^^^^^^^^^^^^^^^^ + +The file `energyProduction.csv` defines the assets that serve as energy sources, eg. fuel sources or PV plants. They include the following parameters: + +* :ref:`maxcap-label` +* :ref:`renewableasset-label` + + +.. _providers: + +energyProviders.csv +^^^^^^^^^^^^^^^^^^^ + +The file `energyProviders.csv` defines the energy providers of the energy system. They include the following parameters: + +* :ref:`emissionfactor-label` +* :ref:`energyprice-label` +* :ref:`feedincap-label` +* :ref:`feedintariff-label` +* :ref:`peakdemand-label` +* :ref:`peakdemandperiod-label` +* :ref:`renshare-label` + + +.. _storage: + +energyStorage.csv +^^^^^^^^^^^^^^^^^ + +The file `energyStorage.csv` defines the storage assets included in the energy system. It does not hold all needed parameters, but requires `storage_xx.csv` to be defined as well. The file `energyStorage.csv` includes the following parameters: + +* :ref:`maxcap-label` +* :ref:`storagefilename-label` + + +.. _fixcost: + +fixcost.csv +^^^^^^^^^^^ + +The parameters must be filled for all three columns/components namely: *distribution_grid*, *engineering* and *operation*. +The file `fixcost.csv` includes the following parameters: + +* :ref:`labl-label` + + +.. _project_data: + +project_data.csv +^^^^^^^^^^^^^^^^ + +The file `project_data.csv` includes the following parameters: + +* :ref:`country-label` +* :ref:`latitude-label` +* :ref:`longitude-label` +* :ref:`projectid-label` +* :ref:`projectname-label` +* :ref:`scenariodescription-label` +* :ref:`scenarioid-label` +* :ref:`scenarioname-label` + + +.. _simulation_settings: + +simulation_settings.csv +^^^^^^^^^^^^^^^^^^^^^^^ + +The file `simulation_settings.csv` includes the following parameters: + +* :ref:`evaluatedperiod-label` +* :ref:`outputlpfile-label` +* :ref:`startdate-label` +* :ref:`timestep-label` + + +.. _storage_csv: + +storage_*.csv +^^^^^^^^^^^^^ + +The `*` in the storage filename is the number identifying the storage. It depends on the number of storage components (such as batteries, etc.) present in the system. For e.g., there should be two storage files named storage_01.csv and storage_02.csv if the system contains two storage components.The file `storage_xx.csv` contains the following parameters: + +* :ref:`crate-label` +* :ref:`fixed_thermal_losses_absolute-label` +* :ref:`fixed_thermal_losses_relative-label` +* :ref:`socin-label` +* :ref:`socmax-label` +* :ref:`socmin-label` + diff --git a/docs/model/parameters/MVS_parameters_list.inc b/docs/model/parameters/MVS_parameters_list.inc new file mode 100644 index 0000000..3c446b9 --- /dev/null +++ b/docs/model/parameters/MVS_parameters_list.inc @@ -0,0 +1,763 @@ +.. _age_ins-label: + +age_installed +^^^^^^^^^^^^^ + +:Definition_Short: Number of years the asset has already been in operation +:Definition_Long: If the project lasts longer than its remaining lifetime, the replacement costs of the asset will be taken into account. +:Type: numeric +:Unit: a +:Example: 10 +:Restrictions: Natural number +:Default: 0 + + + +.. _crate-label: + +c-rate +^^^^^^ + +:Definition_Short: Maximum permissable power at which the storage can be charged or discharged relative to the nominal capacity of the storage +:Definition_Long: The C rate indicates the reciprocal of the time for which a battery of the specified capacity can be charged or discharged with the maximum charge or discharge current. A C-rate of 1 implies that the battery can be fully charged or discharged completely in a single timestep. A C-rate of 0.5 implies that the battery needs at least 2 timesteps to be fully charged or discharged. +:Type: numeric +:Unit: Factor +:Example: 1 +:Restrictions: Real number between 0 and 1 +:Default: 1 + + + +.. _country-label: + +country +^^^^^^^ + +:Definition_Short: Name of the country where the project is being deployed +:Type: str +:Unit: None +:Example: Norway +:Restrictions: None +:Default: None + + + +.. _currency-label: + +currency +^^^^^^^^ + +:Definition_Short: The currency of the country where the project is implemented +:Type: str +:Unit: None +:Example: EUR +:Restrictions: None +:Default: None + + + +.. _developmentcosts-label: + +development_costs +^^^^^^^^^^^^^^^^^ + +:Definition_Short: Planning and development costs +:Definition_Long: This could be planning and development costs which do not depend on the (optimized) capacities of the assets. +:Type: numeric +:Unit: € +:Example: 10000 +:Restrictions: Positive real number +:Default: 0 + + + +.. _discountfactor-label: + +discount_factor +^^^^^^^^^^^^^^^ + +:Definition_Short: The factor which accounts for the depreciation in the value of money in the future compared to the current value of the same money +:Definition_Long: The common method is to calculate the weighted average cost of capital (WACC) and use it as the discount rate. +:Type: numeric +:Unit: Factor +:Example: 0.06 +:Restrictions: Real number +:Default: 0.05 + + + +.. _dispatchprice-label: + +dispatch_price +^^^^^^^^^^^^^^ + +:Definition_Short: Costs associated with a flow through/from the asset (OPEX_var or fuel costs) +:Definition_Long: This could be fuel costs for fuel sources like biogas or oil or operational costs for thermal power plants which only occur when operating the plant. +:Type: numeric +:Unit: €/kWh +:Example: 0.01 +:Restrictions: None +:Default: 0.01 + + + +.. _efficiency-label: + +efficiency +^^^^^^^^^^ + +:Definition_Short: Ratio of energy output to energy input +:Definition_Long: The battery efficiency is the ratio of the energy taken out from the battery to the energy put into the battery. +:Type: numeric +:Unit: Factor +:Example: 0.95 +:Restrictions: Positive real number +:Default: 0.8 + + + +.. _emissionfactor-label: + +emission_factor +^^^^^^^^^^^^^^^ + +:Definition_Short: Emissions per unit dispatch of an asset +:Type: numeric +:Unit: kgCO2eq/asset unit +:Example: 14.4 +:Restrictions: Positive real number +:Default: 0.4 + + + +.. _energyprice-label: + +energy_price +^^^^^^^^^^^^ + +:Definition_Short: Price of the energy carrier sourced from the utility grid +:Definition_Long: Can be also a timeseries +:Type: numeric +:Unit: €/kWh +:Example: 0.3 +:Restrictions: None +:Default: 0.3 + + + +.. _energyvector-label: + +energyVector +^^^^^^^^^^^^ + +:Definition_Short: Energy commodity +:Definition_Long: Convention: For an energy conversion asset define the commodity of the output. For a sink define the commodity based on the input flow. For a source define the commodity based on the output flow. For a storage, define the commodity based on the stored energy carrier. +:Type: str +:Unit: None +:Example: Electricity +:Restrictions: One of “Electricity”, “Gas”, “Bio-Gas”, “Diesel”, “Heat”, “H2” +:Default: Electricity + + + +.. _evaluatedperiod-label: + +evaluated_period +^^^^^^^^^^^^^^^^ + +:Definition_Short: The number of days for which the simulation is to be run +:Type: numeric +:Unit: None +:Example: 365 +:Restrictions: Natural number +:Default: 365 + + + +.. _feedincap-label: + +feedin_cap +^^^^^^^^^^ + +:Definition_Short: Maximum capacity for feeding electricity into the grid +:Type: numeric +:Unit: :unit: +:Example: 1000 +:Restrictions: Acceptable values are either a positive real number or None +:Default: None + + + +.. _feedintariff-label: + +feedin_tariff +^^^^^^^^^^^^^ + +:Definition_Short: Price received for feeding electricity into the grid +:Definition_Long: Can be also a timeseries +:Type: numeric +:Unit: €/kWh +:Example: 0.1 +:Restrictions: None +:Default: 0.1 + + + +.. _filename-label: + +file_name +^^^^^^^^^ + +:Definition_Short: Name of the csv file containing the input generation or demand timeseries +:Type: str +:Unit: None +:Example: demand_harbor.csv +:Restrictions: This file must be placed in a folder named “time_series” inside your input folder. +:Default: None + + + +.. _fixed_thermal_losses_absolute-label: + +fixed_thermal_losses_absolute +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition_Short: Thermal losses of the storage independent of the state of charge and independent of nominal storage capacity between two consecutive timesteps +:Type: numeric +:Unit: factor +:Example: 0.0003 +:Restrictions: Between 0 and 1 +:Default: 0 + + + +.. _fixed_thermal_losses_relative-label: + +fixed_thermal_losses_relative +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition_Short: Thermal losses of storage independent of state of charge between two consecutive timesteps relative to nominal storage capacity +:Type: numeric +:Unit: factor +:Example: 0.0016 +:Restrictions: Between 0 and 1 +:Default: 0 + + + +.. _inflowdirection-label: + +inflow_direction +^^^^^^^^^^^^^^^^ + +:Definition_Short: Label of the bus/component from which the energyVector is arriving into the asset +:Type: str +:Unit: None +:Example: Electricity +:Restrictions: None +:Default: None + + + +.. _installedcap-label: + +installedCap +^^^^^^^^^^^^ + +:Definition_Short: Already existing installed capacity +:Definition_Long: If the project lasts longer than its remaining lifetime, the replacement costs of the asset will be taken into account. +:Type: numeric +:Unit: :unit: +:Example: 50 +:Restrictions: None +:Default: 0 + + + +.. _labl-label: + +label +^^^^^ + +:Definition_Short: Name of the asset +:Type: str +:Unit: None +:Example: pv_plant_01 +:Restrictions: Input the names in a computer friendly format, preferably with underscores instead of spaces, and avoiding special characters +:Default: None + + + +.. _latitude-label: + +latitude +^^^^^^^^ + +:Definition_Short: Latitude coordinate of the project's geographical location +:Type: numeric +:Unit: None +:Example: 45.641603 +:Restrictions: Should follow geographical convention +:Default: None + + + +.. _lifetime-label: + +lifetime +^^^^^^^^ + +:Definition_Short: Number of operational years of the asset until it has to be replaced +:Type: numeric +:Unit: a +:Example: 20 +:Restrictions: Natural number +:Default: 20 + + + +.. _longitude-label: + +longitude +^^^^^^^^^ + +:Definition_Short: Longitude coordinate of the project's geographical location +:Type: numeric +:Unit: None +:Example: 10.95787 +:Restrictions: Should follow geographical convention +:Default: None + + + +.. _maxemissions-label: + +maximum_emissions +^^^^^^^^^^^^^^^^^ + +:Definition_Short: Maximum amount of total emissions which are allowed in the optimized energy system +:Type: numeric +:Unit: kgCO2eq/a +:Example: 100000 +:Restrictions: Acceptable values are either a positive real number or None. +:Default: None + + + +.. _maxcap-label: + +maximumCap +^^^^^^^^^^ + +:Definition_Short: Maximum total capacity of an asset that can be installed at the project site +:Definition_Long: This includes the already existing installed and additional capacity possible. An example would be that a roof can only carry 50 kW PV (maximum capacity), whereas the installed capacity is already 10 kW. The optimization would only be allowed to add 40 kW PV at maximum. +:Type: numeric +:Unit: :unit: +:Example: 1000 +:Restrictions: Acceptable values are either a positive real number or None. +:Default: None + + + +.. _minda-label: + +minimal_degree_of_autonomy +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition_Short: Minimum degree of autonomy that needs to be met by the optimization +:Definition_Long: This constraint defines a lower bound on the degree of autonomy of the energy system. Note that constraint is applied to the the whole, sector-coupled energy system, but not to specific sectors individually. +:Type: numeric +:Unit: factor +:Example: 0.6 +:Restrictions: Real number between 0 and 1 +:Default: 0.6 + + + +.. _minrenshare-label: + +minimal_renewable_factor +^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition_Short: Minimum share of energy supplied by renewable generation that needs to be met by the optimization +:Definition_Long: This constraint defines a lower bound on the renewable share of the system, which takes into account both local generation as well as the renewable share of energy providers. Note that constraint is applied to the renewable share of the whole, sector-coupled energy system, but not to specific sectors individually. +:Type: numeric +:Unit: factor +:Example: 0.8 +:Restrictions: Real number between 0 and 1 +:Default: 0.8 + + + +.. _nzeconstraint-label: + +net_zero_energy +^^^^^^^^^^^^^^^ + +:Definition_Short: Specifies whether optimization needs to result into a net zero energy system (True) or not (False) +:Type: boolean +:Unit: None +:Example: True +:Restrictions: Acceptable values are either Yes or No. +:Default: False + + + +.. _optimizecap-label: + +optimizeCap +^^^^^^^^^^^ + +:Definition_Short: Choose if capacity optimization should be performed for this asset. +:Type: boolean +:Unit: None +:Example: True +:Restrictions: Acceptable values are either Yes or No. +:Default: False + + + +.. _outflowdirec-label: + +outflow_direction +^^^^^^^^^^^^^^^^^ + +:Definition_Short: Label of bus/component towards which the energyVector is leaving from the asset +:Type: str +:Unit: None +:Example: PV plant (mono) +:Restrictions: None +:Default: None + + + +.. _outputlpfile-label: + +output_lp_file +^^^^^^^^^^^^^^ + +:Definition_Short: Enables the output of the linear programming (lp) file with the linear equation system describing the optimization problem +:Definition_Long: The lp file contains the objective function and all constraints. It enables the user to look at the underlying equations of the optimization. +:Type: boolean +:Unit: None +:Example: False +:Restrictions: Acceptable values are either True or False +:Default: False + + + +.. _peakdemand-label: + +peak_demand_pricing +^^^^^^^^^^^^^^^^^^^ + +:Definition_Short: Grid fee to be paid based on the peak demand of a given period +:Type: numeric +:Unit: €/kW +:Example: 60 +:Restrictions: None +:Default: 0 + + + +.. _peakdemandperiod-label: + +peak_demand_pricing_period +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:Definition_Short: Number of reference periods in one year for the peak demand pricing +:Type: numeric +:Unit: times per year +:Example: 2 +:Restrictions: Only one of the following are acceptable values: 1 (yearly), 2, 3 ,4, 6, 12 (monthly) +:Default: 1 + + + +.. _projectduration-label: + +project_duration +^^^^^^^^^^^^^^^^ + +:Definition_Short: The number of years the project is intended to be operational +:Definition_Long: The project duration also sets the installation time of the assets used in the simulation. After the project ends these assets are 'sold' and the refund is charged against the initial investment costs. +:Type: numeric +:Unit: a +:Example: 30 +:Restrictions: Natural number +:Default: 20 + + + +.. _projectid-label: + +project_id +^^^^^^^^^^ + +:Definition_Short: Assign a project ID as per your preference. +:Type: str +:Unit: None +:Example: 1 +:Restrictions: Cannot be the same as an already existing project ID +:Default: None + + + +.. _projectname-label: + +project_name +^^^^^^^^^^^^ + +:Definition_Short: Assign a project name as per your preference. +:Type: str +:Unit: None +:Example: Borg Havn +:Restrictions: None +:Default: None + + + +.. _renshare-label: + +renewable_share +^^^^^^^^^^^^^^^ + +:Definition_Short: Share of renewables in the generation mix of the energy supplied by the DSO utility +:Type: numeric +:Unit: Factor +:Example: 0.5 +:Restrictions: Real number between 0 and 1 +:Default: 0.44 + + + +.. _renewableasset-label: + +renewableAsset +^^^^^^^^^^^^^^ + +:Definition_Short: Choose if this asset should be considered as renewable. +:Definition_Long: This parameter is necessary to consider the renewable share constraint correctly. +:Type: boolean +:Unit: None +:Example: True +:Restrictions: Acceptable values are either Yes or No. +:Default: True + + + +.. _scenariodescription-label: + +scenario_description +^^^^^^^^^^^^^^^^^^^^ + +:Definition_Short: Brief description of the scenario being simulated +:Type: str +:Unit: None +:Example: This scenario simulates a sector-coupled energy system +:Restrictions: None +:Default: None + + + +.. _scenarioid-label: + +scenario_id +^^^^^^^^^^^ + +:Definition_Short: Assign a scenario ID as per your preference. +:Type: str +:Unit: None +:Example: 1 +:Restrictions: Cannot be the same as an already existing scenario ID within the project +:Default: None + + + +.. _scenarioname-label: + +scenario_name +^^^^^^^^^^^^^ + +:Definition_Short: Assign a scenario name as per your preference. +:Type: str +:Unit: None +:Example: Warehouse 14 +:Restrictions: None +:Default: None + + + +.. _socin-label: + +soc_initial +^^^^^^^^^^^ + +:Definition_Short: State of charge of the storage in the zeroth time step +:Definition_Long: The state of charge is specified as a factor of the nominal capacity. +:Type: numeric +:Unit: None or factor +:Example: nan +:Restrictions: nan +:Default: None + + + +.. _socmax-label: + +soc_max +^^^^^^^ + +:Definition_Short: The maximum permissible level of charge of the storage as a factor of the nominal capacity +:Definition_Long: When the battery is filled to its nominal capacity the state of charge is represented by the value 1. +:Type: numeric +:Unit: Factor +:Example: nan +:Restrictions: Real number between 0 and 1 +:Default: 1 + + + +.. _socmin-label: + +soc_min +^^^^^^^ + +:Definition_Short: The minimum permissible level of charge of the storage as a factor of the nominal capacity +:Definition_Long: When the battery is fully discharged the state of charge is represented by the value 0. +:Type: numeric +:Unit: Factor +:Example: nan +:Restrictions: Real number between 0 and 1 +:Default: 0 + + + +.. _specificcosts-label: + +specific_costs +^^^^^^^^^^^^^^ + +:Definition_Short: Specific investment costs of the asset related to the installed capacity (CAPEX) +:Type: numeric +:Unit: €/:unit: +:Example: 1000 +:Restrictions: None +:Default: 1000 + + + +.. _specificomcosts-label: + +specific_costs_om +^^^^^^^^^^^^^^^^^ + +:Definition_Short: Specific operational and maintenance costs of the asset related to the installed capacity (OPEX_fix) +:Type: numeric +:Unit: €/(:unit:\*a) +:Example: 10 +:Restrictions: None +:Default: 10 + + + +.. _startdate-label: + +start_date +^^^^^^^^^^ + +:Definition_Short: Date and time when the simulation starts with the first step +:Definition_Long: This date will be used for the results graphs as well as the timeseries upload. +:Type: str +:Unit: None +:Example: 2018-01-01 00:00:00 +:Restrictions: Acceptable format is YYYY-MM-DD HH:MM:SS +:Default: None + + + +.. _storagefilename-label: + +storage_filename +^^^^^^^^^^^^^^^^ + +:Definition_Short: Name of a csv file containing the properties of a storage component +:Type: str +:Unit: None +:Example: storage_01.csv +:Restrictions: Follows the convention of 'storage_xx.csv' where 'xx' is a number. This file must be placed in a folder named “csv_elements” inside your input folder. +:Default: None + + + +.. _tax-label: + +tax +^^^ + +:Definition_Short: Tax factor +:Type: numeric +:Unit: Factor +:Example: 0 +:Restrictions: Between 0 and 1 +:Default: 0 + + + +.. _timestep-label: + +timestep +^^^^^^^^ + +:Definition_Short: Length of the time steps +:Type: numeric +:Unit: None +:Example: 60 +:Restrictions: Can only be 60 minutes at the moment +:Default: 60 + + + +.. _typeoemof-label: + +type_oemof +^^^^^^^^^^ + +:Definition_Short: Input the type of OEMOF component +:Definition_Long: A photovoltaic plant would be a source, a solar inverter would be a transformer, etc. The `type_oemof` will later on be determined through the EPA. +:Type: str +:Unit: None +:Example: sink +:Restrictions: *sink* or *source* or one of the other component classes of OEMOF. +:Default: None + + + +.. _unit-label: + +unit +^^^^ + +:Definition_Short: Unit associated with the capacity of the component +:Type: str +:Unit: nan +:Example: Storage could have units like kW or kWh, transformer station could have kVA, and so on. +:Restrictions: Appropriate scientific unit +:Default: kW + + + +.. _Beta-label: + +beta +^^^^ + +:Definition_Short: Power loss index for CHPs, usually known as beta coefficient +:Definition_Long: 0.6 +:Type: factor +:Unit: beta +:Example: Between 0 and 1 +:Restrictions: numeric +:Default: 0 + + diff --git a/docs/model/parameters/MVS_parameters_list.tbl b/docs/model/parameters/MVS_parameters_list.tbl new file mode 100644 index 0000000..b681fe7 --- /dev/null +++ b/docs/model/parameters/MVS_parameters_list.tbl @@ -0,0 +1,54 @@ +Parameter,Type,Unit,Default +:ref:`age_ins-label`,numeric,a,0 +:ref:`crate-label`,numeric,Factor,1 +:ref:`country-label`,str,None,None +:ref:`currency-label`,str,None,None +:ref:`developmentcosts-label`,numeric,€,0 +:ref:`discountfactor-label`,numeric,Factor,0.05 +:ref:`dispatchprice-label`,numeric,€/kWh,0.01 +:ref:`efficiency-label`,numeric,Factor,0.8 +:ref:`emissionfactor-label`,numeric,kgCO2eq/asset unit,0.4 +:ref:`energyprice-label`,numeric,€/kWh,0.3 +:ref:`energyvector-label`,str,None,Electricity +:ref:`evaluatedperiod-label`,numeric,None,365 +:ref:`feedincap-label`,numeric,:unit:,None +:ref:`feedintariff-label`,numeric,€/kWh,0.1 +:ref:`filename-label`,str,None,None +:ref:`fixed_thermal_losses_absolute-label`,numeric,factor,0 +:ref:`fixed_thermal_losses_relative-label`,numeric,factor,0 +:ref:`inflowdirection-label`,str,None,None +:ref:`installedcap-label`,numeric,:unit:,0 +:ref:`labl-label`,str,None,None +:ref:`latitude-label`,numeric,None,None +:ref:`lifetime-label`,numeric,a,20 +:ref:`longitude-label`,numeric,None,None +:ref:`maxemissions-label`,numeric,kgCO2eq/a,None +:ref:`maxcap-label`,numeric,:unit:,None +:ref:`minda-label`,numeric,factor,0.6 +:ref:`minrenshare-label`,numeric,factor,0.8 +:ref:`nzeconstraint-label`,boolean,None,False +:ref:`optimizecap-label`,boolean,None,False +:ref:`outflowdirec-label`,str,None,None +:ref:`outputlpfile-label`,boolean,None,False +:ref:`peakdemand-label`,numeric,€/kW,0 +:ref:`peakdemandperiod-label`,numeric,times per year,1 +:ref:`projectduration-label`,numeric,a,20 +:ref:`projectid-label`,str,None,None +:ref:`projectname-label`,str,None,None +:ref:`renshare-label`,numeric,Factor,0.44 +:ref:`renewableasset-label`,boolean,None,True +:ref:`scenariodescription-label`,str,None,None +:ref:`scenarioid-label`,str,None,None +:ref:`scenarioname-label`,str,None,None +:ref:`socin-label`,numeric,None or factor,None +:ref:`socmax-label`,numeric,Factor,1 +:ref:`socmin-label`,numeric,Factor,0 +:ref:`specificcosts-label`,numeric,€/:unit:,1000 +:ref:`specificomcosts-label`,numeric,€/(:unit:\*a),10 +:ref:`startdate-label`,str,None,None +:ref:`storagefilename-label`,str,None,None +:ref:`tax-label`,numeric,Factor,0 +:ref:`timestep-label`,numeric,None,60 +:ref:`typeoemof-label`,str,None,None +:ref:`unit-label`,str,,kW +:ref:`Beta-label`,factor,beta,0 diff --git a/docs/model/simulation_outputs.rst b/docs/model/simulation_outputs.rst new file mode 100644 index 0000000..10f3ad2 --- /dev/null +++ b/docs/model/simulation_outputs.rst @@ -0,0 +1,349 @@ +.. _simulation_outputs: + +======================= +Outputs of a simulation +======================= + +After optimization of an energy system, the open-plan-tool evaluates the simulation output. It evaluates the flows, costs and performance of the system. As a result, it can calculate a number of :ref:`key performance indicators (KPI) `, namely :ref:`economic `, :ref:`technical ` and :ref:`environmental ` KPI. Not all of them are displayed in the graphical current user interface, they are nevertheless listed here for information. + +.. _key_performance_indicators_overview: + +Overview of Key Performance Indicators +###################################### + +.. Bullet list of all the KPI of the different KPI categories: + +.. include:: outputs/MVS_kpi_categories.inc + +.. the .inc files describing the kpis are automatically generated in `conf.py` from the `MVS_kpis_list.csv` file + +In the sections :ref:`economic `, :ref:`technical ` and :ref:`environmental ` KPI, these indicators are further defined and in :ref:`Files ` the possible exportable figures and files are presented. This takes place with the following structure: + +:Definition: Definition of the defined KPI, can be used as tooltips. + +:Type: One of Numeric, Figure, Excel File, JSON, Time series, Logfile or html/pdf + +:Unit: Unit of the KPI, multiple units possible if KPI can be applied to individual sectors (see also: :ref:`kpi_suffixes`). + +:Valid Interval: Expected valid range of the KPI. Exceptions are possible under certain conditions. + +:Related indicators: List of indicators that are related to the described KPI, either because they are part of its calculation or can be compared to it. + +Besides these parameters attributes, the underlying equation of a specific KPI may be presented and explained, or further hints might be provided for the parameter evaluation or for special cases. + +.. _kpi_suffixes: + +Suffixes of KPI +############### + +The KPI of the open-plan-tool can be calculated per asset, for each sector or for the overall system. + +KPI calculated per asset are not included in the scalar results of the automatic report or in the stored Excel file, but are displayed separately. They do not need suffixes, as they are always displayed in tables next to the respective asset. + +KPI calculated for each vector are specifically these KPI that aggregate the dispatch and costs of multiple assets. For cost-related KPI, such aggregating KPI have the energy vector they are describing as a suffix. An example would be the :code:`attributed_costs` of each energy vector - the attributed costs of the electricity and H2 sector would be called :code:`attributed_costs_electricity` and :code:`attributed_costs_H2` respectively. +For technical KPI, this suffix also applies, but additionally, due to the :ref:`energy carrier weighting `, they also feature the suffix :code:`electricity equivalent` when the weighting has been applied. The energy demand of the system is an example: the demand per sector would be :code:`total_demand_electricity` and :code:`total_demand_H2`. To be able to aggregate these cost into an overall KPI for the system, the electricity equivalents of both values are calculated. They then are named :code:`total_demand_electricity_electricity_equivalent` and :code:`total_demand_H2_electricity_equivalent`. + +KPI that describe the costs of the overall energy system do not have suffixes. Technical KPI often have the suffix :code:`electricity_equivalent` to underline the energy carrier that the parameter is relative to. + +.. _kpi_economic: + +Economic KPI +############ + +All the KPI related to costs described below are provided in net present value. + +.. include:: outputs/costs_total.inc + +The Net present costs (NPC) is the present value of all the costs associated with installation, operation, maintenance and replacement of energy assets within the optimized multi-vector energy system over the whole project lifetime, deducting the present value of the residual value of asset at project end and as well as all the revenues that it earns over the project lifetime. The capital recovery factor (CRF) is used to calculate the present value of the cash flows. + +.. math:: + NPC = \sum_i{(c_{specific} + c_{replacement} + c_{residual}) \cdot CAP_i} + \sum_i{\sum_t{E_i(t)} \cdot p_{dispatch}} + +.. include:: outputs/costs_cost_om.inc + +.. include:: outputs/costs_om_total.inc + +.. include:: outputs/costs_dispatch.inc + +.. include:: outputs/costs_investment_over_lifetime.inc + +.. include:: outputs/costs_upfront_in_year_zero.inc + +.. include:: outputs/replacement_costs_during_project_lifetime.inc + +.. include:: outputs/attributed_costs.inc + +A multi-vector energy system connects energy vectors into a joined energy system and the system is then designed to have an optimial, joined operation. With other systems, the costs associated to each individual energy vector would be used to calculate the costs to supply the individual sector. With the multi-vector system, this could lead to distorted costs - for example if there is a lot of PV (electricity sector), which in the end is only supplying an electrolyzer (H2 sector). The investment and operational costs of the electricity sector assets would thus turn out to be very high, which could be considered unfair as the electricity from PV is solely used to provide the H2 demand. +Therefore, we define the :ref:`attributed costs of each energy vector `, to determine how much of the overall system costs should be attributed to one sector, depending on the energy demand it has compared to the other sectors. To be able to compare the demands of different energy carriers, :ref:`energy carrier weighting ` is applied. + +.. include:: outputs/annuity_total.inc + +.. include:: outputs/annuity_om.inc + +.. include:: outputs/levelized_costs_of_electricity_equivalent.inc + +Specific electricity supply costs, eg. levelized costs of electricity are commonly used to compare the supply costs of different investment decisions or also energy provider prices to local generation costs. However, a multi-vector energy system connects energy vectors into a joined energy system and the optimization objective of the open-plan-tool then is to minimize the overall energy costs, without distinguising between the different sectors. This sector-coupled energy system is then designed to have an optimal, joined operation. With other systems, the costs associated to each individual energy vector would be used to calculate the levelized costs of energy (LCOEnergy). With the multi-vector system, this could lead to distorted costs - for example if there is a lot of PV (electricity sector), which in the end is only supplying an electrolyzer (H2 sector). The LCOE of electricity would thus turn out to be very high, which could be considered unfair as the electricity from PV is solely used to provide the H2 demand. +Therefore, we define the :ref:`attributed costs of each energy vector `, to determine how much of the overall system costs should be attributed to one sector, depending on the energy demand it has compared to the other sectors. To be able to compare the demands of different energy carriers, :ref:`energy carrier weighting ` is applied. + +Therefore the levelized costs of energy (LCOEnergy) for energy carrier :math:`i` are defined based on the annuity of the attributed costs, the CRF and the demand of one energy sector :math:`E_{dem,i}`: + +.. math:: + LCOEnergy_i = \frac{Attributed~costs \cdot CRF}{\sum_{t} E_{dem,i}(t)} + +The LCOEnergy are are calculated for each sector (resulting in the levelized costs of electricity, heat, H2...), but also for the overall energy system. For the overall energy system, the levelized costs of electricity equivalent are calculated, as this system may supply different energy vectors. + +.. include:: outputs/levelized_cost_of_energy_of_asset.inc + +This KPI measures the cost of generating 1 kWh for each asset in the system. +It can be used to assess and compare the available alternative methods of energy production. +The levelized cost of energy of an asset (:math:`LCOE~ASSET_i`) is usually obtained +by looking at the lifetime costs of building and operating the asset per unit of total energy throughput of an asset over the assumed lifetime [currency/kWh]. + +Since not all assets are production assets, the open-plan-tool distinguishes between the type of assets. +For assets to convert or produce energy the open-plan-tool calculates the :math:`LCOE~ASSET_i` +by dividing the total annuity :math:`a_i` of the asset :math:`i` by the total flow :math:`\sum_{t} E_i(t)`. + +.. math:: + LCOE~ASSET_i = \frac{a_i}{\sum_{t} E_i(t)} + +For assets that store energy, the open-plan-tool sums the annuity for :code:`storage capacity` :math:`a_{i,sc}`, :code:`input power` :math:`a_{i,ip}` and :code:`output power` :math:`a_{i,op}` and divides it by the :code:`output power` total flow :math:`\sum{t} E_{i,op}(t)`. + +.. math:: + LCOE~ASSET_i = \frac{a_{i,sc} + a_{i,ip} + a_{i,op}}{\sum_{t}{E_{i,op}(t)}} + +If the total flow is 0 in any of the previous cases, then the :math:`LCOE~ASSET` is set to :code:`None`. + +.. math:: + LCOE~ASSET_i = None + +For assets that consume energy, the open-plan-tool outputs 0 for the :math:`LCOE~ASSET_i`. + +.. math:: + LCOE~ASSET_i = 0 + +.. _kpi_technical: + +Technical KPI +############# + +.. include:: outputs/optimizedAddCap.inc + +.. include:: outputs/flow.inc + +.. include:: outputs/peak_flow.inc + +.. include:: outputs/average_flow.inc + +.. include:: outputs/annual_total_flow.inc + +.. include:: outputs/total_demand.inc + +.. include:: outputs/total_feedin.inc + +.. include:: outputs/total_consumption_from_energy_provider.inc + +.. include:: outputs/total_internal_non-renewable_generation.inc + +.. include:: outputs/total_internal_renewable_generation.inc + +.. include:: outputs/total_internal_generation.inc + +.. include:: outputs/total_excess.inc + +.. include:: outputs/total_renewable_energy_use.inc + +.. include:: outputs/total_non-renewable_energy_use.inc + +.. include:: outputs/renewable_share_of_local_generation.inc + +The renewable share of local generation describes how much of the energy generated locally is produced from renewable sources. +It does not take into account the consumption from energy providers. + +The renewable share of local generation for each sector does not utilize energy carrier weighting but has a limited, single-vector view: + +.. math:: + REGen_v &=\frac{\sum_i {E_{rgen,i}}}{\sum_j {E_{gen,j}}} + + \text{with } v &\text{: Energy vector} + + rgen &\text{: Renewable generation} + + gen &\text{: Renewable and non-renewable generation} + + i,j &\text{: Asset 1,2,…} + +For the system-wide share of local renewable generation, energy carrier weighting is used: + +.. math:: + REGen &=\frac{\sum_i {E_{rgen,i} \cdot w_i}}{\sum_j {E_{gen,j} \cdot w_j}} + + \text{with } rgen &\text{: Renewable generation} + + gen &\text{: Renewable and non-renewable generation} + + i, j &\text{: Assets 1,2,…} + + w_i, w_j &\text{: Energy carrier weighting factor for output of asset i/j} + + +:Example: + +An energy system is composed of a heat and an electricity side. Following are the energy flows: + +* 100 kWh from a local PV plant +* 0 kWh local generation for the heat side + +This results in: + +* A single-vector renewable share of local generation of 0% for the heat sector. +* A single-vector renewable share of local generation of 100% for the electricity sector. +* A system-wide renewable share of local generation of 100%. + +.. include:: outputs/renewable_factor.inc + +Describes the share of the energy influx to the local energy system that is provided from renewable sources. +This includes both local generation as well as consumption from energy providers. + +.. math:: + RF &=\frac{\sum_i {E_{rgen,i} \cdot w_i + RES \cdot E_{grid}}}{\sum_j {E_{gen,j} \cdot w_j}+\sum_k {E_{grid} (k) \cdot w_k}} + + \text{with } rgen &\text{: Renewable generation} + + gen &\text{: Renewable and non-renewable generation} + + i, j &\text{: Assets 1,2,…} + + RES &\text{: Renewable energy share of energy provider} + + k &\text{: Energy provider 1,2…} + + w_i, w_j, w_k &\text{: Energy carrier weighting factor for output of asset i/j/k} + +:Example: + +An energy system is composed of a heat and an electricity side. Following are the energy flows: + +* 100 kWh from a local PV plant +* 0 kWh local generation for the heat side +* 100 kWh consumption from the electricity provider, who has a renewable factor of 50% + +Again, the heat sector would have a renewable factor of 0% when considered separately, and the electricity side would have an renewable factor of 75%. This results in a system-wide renewable share of: + +.. math:: RF = \frac{ 100 kWh(el)\cdot \frac{kWh(eleq)}{kWh(el)} +50 kWh(el) \cdot \frac{kWh(eleq)}{kWh(el)}}{200 kWh(el) \cdot \frac{kWh(eleq)}{kWh(el)}} = 3/4 = \text{75 \%} + +The renewable factor, just like the :ref:`renewable_share_of_local_generation`, cannot indicate how much renewable energy is used in each of the sectors. In the future, it might be possible to get a clearer picture of the flows between the sectors with the proposed :ref:`degree of sector-coupling `. + +.. _degree_of_sector_coupling: + +Degree of sector-coupling (DSC) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To assess how much an optimized multi-vector energy system makes use of the potential of sector-coupling, it is planned to introduce the degree of sector-coupling in the future. This level of interconnection is to be calculated with the ratio of energy flows in between the sectors (ie. those, where energy carriers are converted to another energy carrier) to the energy demand supplied: + +.. math:: + DSC & =\frac{\sum_{i,j}{E_{conversion} (i,j) \cdot w_i}}{\sum_i {E_{demand} (i) \cdot w_i}} + + \text{with } i,j &\text{: Electricity,H2…} + +.. note:: + This feature is currently not implemented. + +.. include:: outputs/onsite_energy_fraction.inc + +Onsite energy fraction is also referred to as "self-consumption". It describes +the fraction of all locally generated energy that is consumed by the system +itself. (see `[1] `__ and `[2] `__). + +An OEF close to zero shows that only a very small amount of locally generated +energy is consumed by the system itself. It is at the same time an indicator +that a large amount is fed into the grid instead. A OEF close to one shows that +almost all locally produced energy is consumed by the system itself. + +.. math:: + OEF &=\frac{\sum_{i} {(E_{generation} (i) - E_{gridfeedin}(i)) \cdot w_i}}{\sum_{i} {E_{generation} (i) \cdot w_i}} + + &OEF \epsilon \text{[0,1]} + +.. include:: outputs/onsite_energy_matching.inc + +The onsite energy matching is also referred to as "self-sufficiency". It +describes the fraction of the total demand that can be +covered by the locally generated energy (see +`[1] `__ and `[2] `__). + + +An OEM close to zero shows that very little of the demand can be covered by +locally produced energy. Am OEM close to one shows that almost all of the demand +can be covered with locally generated energy. Per definition OEM cannot be greater +than 1 because the excess generated energy would automatically be fed into the grid +or an excess sink. + + +.. math:: + OEM &=\frac{\sum_{i} {(E_{generation} (i) - E_{gridfeedin}(i) - E_{excess}(i)) \cdot w_i}}{\sum_i {E_{demand} (i) \cdot w_i}} + + &OEM \epsilon \text{[0,1]} + +.. note:: + The feed into the grid should only be positive. + + +.. include:: outputs/degree_of_autonomy.inc + +The degree of autonomy describes the overall energy consumed minus the energy consumed from the grid divided by the overall energy consumed. Adapted from this definition `[3] `__. + +A degree of autonomy close to zero shows high dependence on the grid operator, while a degree of autonomy of one represents an autonomous system. Note that this key parameter indicator does not take into account the outflow from the system to the grid operator (also called feedin). +As above, we apply a weighting based on Electricity Equivalent. + +.. math:: + Degree of Autonomy = \frac{\sum_{i} E_{demand,i} \cdot w_i - \sum_{j} E_{consumption,provider,j} \cdot w_j}{\sum_{i} E_{demand,i} \cdot w_i} + +.. include:: outputs/degree_of_nze.inc + +The degree of net zero energy describes the ability of an energy system to provide its aggregated annual demand though local sources. For that, the balance between local generation as well as consumption from and feed-in towards the energy provider is compared. +In a net zero energy system, demand can be supplied by energy import, but then local energy generation must provide an equally high energy export of energy in the course of the year. In a plus energy system, the export exceeds the import, while local generation can supply all demand (from an aggregated perspective). +To calculate the degree of NZE, the margin between grid feed-in and grid consumption is compared to the overall demand. + +Some definitions of NZE systems require that the local demand is solely covered by locally generated renewable energy. In the open-plan-tool this is not the case - all locally generated energy is taken into consideration. For information about the share of renewables in the local energy system checkout :ref:`renewable_share_of_local_generation`. + +A degree of NZE lower than 1 shows that the energy system can not reach a net zero balance, and indicates by how much it fails to do so, +while a degree of NZE of 1 represents a net zero energy system +and a degree of NZE higher 1 a plus-energy system. + +As above, we apply a weighting based on Electricity Equivalent. + +.. math:: + Degree of NZE &= 1 + \frac{\sum_{i} {(E_{grid feedin}(i) - E_{grid consumption} (i) )\cdot w_i}}{\sum_i {E_{demand, i} \cdot w_i}} + + +.. _kpi_environmental: + +Environmental KPI +################# + + +.. include:: outputs/total_emissions.inc + +The total emissions of the MES in question are calculated with all aggregated energy flows from the generation assets including energy providers and their subsequent emission factor: + +.. math:: + Total\_emissions &= \sum_i {E_{gen} (i) \cdot emission\_factor (i)} + + \text{with~} &i \text{: generation assets 1,2,…} + +The emissions of each generation asset and provider are also calculated and displayed separately in the outputs of the open-plan-tool. + +.. include:: outputs/specific_emissions_per_electricity_equivalent.inc + +The specific emissions per electricity equivalent of the MES are calculated in :math:`\text{kg/kWh}_{eleq}`: + +.. math:: + Specific\_emissions &= \frac{Total\_emissions}{total\_demand_{eleq}} + +Emissions can be of different nature: CO2 emissions, CO2 equivalents, greenhouse gases, ... + +Currently the emissions do not include life cycle emissions of energy conversion or storage assets, nor are they calculated separately for the energy sectors. For the latter, the problem of the assignment of assets to sectors arises e.g. emissions caused by an electrolyser would be counted to the electricity sector although you might want to count it for the H2 sector, as the purpose of the electrolyser is to feed the H2 sector. Therefore, we will have to verify whether or not we can apply the energy carrier weighting also for this KPI. + + +.. _output_files: + diff --git a/docs/references/references.rst b/docs/references/references.rst new file mode 100644 index 0000000..ad08bcb --- /dev/null +++ b/docs/references/references.rst @@ -0,0 +1,72 @@ +======= +License +======= + +MIT License + +Copyright (c) (for the two commits dated on 2021-12-13) Intracom SA Telecom Solutions + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +Copyright (c) from 2021-07-09 (any commit not made on 2021-12-13) Reiner Lemoine Institut + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +========== +Contact Us +========== + +You can address your questions about open-plan-tool at the following email: + +open_plan@rl-institut.de + +============= +About project +============= + +Project's page +-------------- + +https://reiner-lemoine-institut.de/open_plan_2020/ + + +Project's website +----------------- + +https://open-plan-tool.org + +Reuses +------ + +The source code of the project's graphical interface has been forked twice + +https://github.com/in-RET/open-plan-gui and https://github.com/rl-institut/cp_nigeria_app + +======= +Credits +======= + + +Funding +------- + +Bundesministerium für Wirtschaft und Energie (https://www.bmwk.de) + +Previous work +------------- + +This code is based from previous open-source work done building a user +interface to the +`multi-vector-simulator `__ +tool in the `Horizon2020 `__ ELAND project. In +open_plan project’s scope a new design and more features are added, +based on feedback collected in workshops held with stakeholders. \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..b23254c --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +sphinx>=2.3.1, <7 +sphinx_rtd_theme>=0.4.3 +numpydoc>=1.1.0 +pandas>==1.1.3