Form:Model

Latest revision as of 14:05, 2 March 2017

To create an entry for a new model, enter the name of the model below.

For testing use: Test Model 1

If a page with your name already exists, you will be sent to a form to edit that page.

About

Help

Search

Navigation

Search

Interaction

Toolbox

Namespaces

Variants

Views

Actions

Form:Model

Latest revision as of 14:05, 2 March 2017

@@ Line 2: / Line 2: @@
 To create an entry for a new model, enter the name of the model below.
-For testing, you can use e.g. "Test Model 1"
+For testing use: Test Model 1
-If a page with that name already exists, you will be sent to a form to edit that page.
+If a page with your name already exists, you will be sent to a form to edit that page.
 {{#forminput:form=Model}}
 </noinclude><includeonly>
+{{#widget:HideEditButton}}
 <div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div>
 {{{for template|Model}}}
-== Basics ==
+== Basic Information ==
-{| class="formtable"
+{| class="formtable" style="width: 100%"
-! width="40%" | Author institution:
+! Full model name:
-| width="60%" | {{{field|author_institution}}}
+| {{{field|Full_Model_Name}}} {{#info:The name of the model '''in full''', not the abbreviation.}}
+|-
+! Acronym:
+| {{{field|Acronym}}} {{#info:The short name of the model, this should be the '''same''' as the page title.}}
 |-
-! Author 1:
+! width="30%" | Author institution:
-| {{{field|author_name1}}}
+| width="70%" | {{{field|author_institution}}} {{#info:The organization that '''hosts''' the project. Select the lead institution if more that one organization is involved.}}
 |-
-! Author 2 (optional):
+! Authors:
-| {{{field|author_name2}}}
+| {{{field|authors}}} {{#info:A comma-separated list of "Firstname Lastname" pairs. For example: John Doe, Jill Doe, Max Mustermann}}
 |-
-! Author 3 (optional):
+! Current contact persons:
-| {{{field|author_name3}}}
+| {{{field|contact_persons}}} {{#info:A comma-separated list of "Firstname Lastname" pairs. For example: John Doe, Jill Doe, Max Mustermann}}
 |-
 ! Contact email address:
-| {{{field|contact_email}}}
+| {{{field|contact_email}}} {{#info:The email address of '''one''' contact person.}}
 |-
 ! Website:
-| {{{field|website}}} {{#info:Ideally a link to a landing page for the model, not the institutions main website.}}
+| {{{field|website}}} {{#info:The website URL including the "http://" part. Ideally a link to the '''landing page''' for the project and not the homepage of the institution hosting the project.}}
 |-
 ! Source download link:
-| {{{field|source_download}}}
+| {{{field|source_download}}} {{#info:The download URL including the "http://" part.}}
 |-
 ! Logo:
-| {{{field|logo|uploadable}}}
+| {{{field|logo|uploadable}}}  {{#info:The logo used by the project, if any.}}
 |-
-! Text description:
+! Short description:
-| {{{field|text_description|input type=textarea|cols=30}}}
+| {{{field|text_description|input type=textarea|cols=50}}} {{#info:Describe your project in a few short sentences.}}
+|-
+! Primary purpose:
+| {{{field|Primary purpose}}} {{#info:Record the '''primary purpose''' of your project.}}
+|-
+! Primary outputs:
+| {{{field|Primary outputs}}} {{#info:List the '''primary outputs''' you expect from your project.}}
+|-
+! Support:
+| {{{field|Support}}} {{#info:TOFIX}}
+|-
+! Framework:
+| {{{field|Framework}}} {{#info:TOFIX}}
+|-
+! Link to user documentation:
+| {{{field|User documentation}}} {{#info:Add a URL to the '''user documentation''' you offer.}}
+|-
+! Link to code documentation:
+| {{{field|Code documentation}}} {{#info:Add a URL to the '''developer documentation''' you offer.}}
+|-
+! Source of funding:
+| {{{field|Source of funding}}}  {{#info:List your funding organizations, if appropriate.}}
+|-
+! Number of developers:
+| {{{field|Number of developers}}} {{#info:Add the number of '''developers''' working on the project.}}
+|-
+! Number of users:
+| {{{field|Number of users}}} {{#info:Add the number of '''modelers''' using the project. Modelers can be developers too.}}
 |}
 == Openness ==
+{| class="formtable" style="width: 100%"
+! width="30%" | Open Source licensed?
+| width="70%" | {{{field|open_source_licensed|input type=checkbox}}} {{#info:Is the model published under an '''open source''' license? We regard licenses from OSI (opensource.org) and The Open Definition (opendefinition.org) as open source. Please '''contact us''' if you are using another license. If you leave this dialog '''unchecked''', this implies you are planning to release your model under an open license in due course.}}
-{| class="formtable"
+|-
-! width="40%" | Open Source licensed?
+! If so, what license?
-| width="60%" | {{{field|open_source_licensed|input type=checkbox}}} {{#info:Is the model licensed under an OpenSource license? We regard licenses from OSI (opensource.org) and the Open Definition (opendefinition.org) as Open Source licenses. Contact us for discussions about other licenses.}}
+| {{{field|license|input type=dropdown}}}
+|-
+! Source code directly downloadable?
+| {{{field|model_source_public|input type=checkbox}}} {{#info:Yes means that the source code can be '''downloaded anonymously''' and that registration or manual inquiry is not required.}}
 |-
-! width="40%" | If so, what license?
+! Link to source code:
-| width="60%" | {{{field|license|input type=dropdown}}}
+| {{{field|Link to source}}}
 |-
-! width="40%" | Source code directly downloadable?
+! Data provided?
-| width="60%" | {{{field|model_source_public|input type=checkbox}}} {{#info:This means that no registration or manual inquiry is necessary to download the source code of the model.}}
+| {{{field|data_availability|input type=radiobutton}}} {{#info:Indicate if some or all of the '''datasets''' necessary to run the model are shipped alongside the model.}}
 |-
-! width="40%" | Data provided?
+! Planned to open up in the future?
-| width="60%" | {{{field|data_availability}}} {{#info:Is the data necessary to run the model provided alongside the model?}}
+| {{{field|open_future|input type=checkbox}}} {{#info:Check this dialog if the model and data are '''not fully open''' at present, but you plan to open these up in the future. This field is '''ignored''' if the open source license field is set to yes.}}
 |}
 == Software ==
+{| class="formtable" style="width: 100%"
-{| class="formtable"
+! width="30%" | Modelling software:
-! width="40%" | Modelling software:
+| width="70%" | {{{field|modelling_software}}} {{#info:A comma-separated list of the '''languages''' and perhaps also the key libraries and/or development environments used for modelling. Do not include '''solvers''', they are the subject of a separate question.}}
-| width="60%" | {{{field|modelling_software}}}
 |-
 ! Data processing software:
-| {{{field|processing_software}}}
+| {{{field|processing_software}}} {{#info:A comma-separated list of the '''languages''' and '''software''' used for processing and visualizing data.}}
+|-
+! External optimizer:
+| {{{field|External optimizer}}} {{#info:A comma-separated list of the '''solvers''' used by the project.  If non-proprietary solvers can be deployed, then these should be listed too.}}
+|-
+! Primary purpose:
+| {{{field|Primary purpose}}} {{#info:TOFIX}}
+|-
+! Additional software required:
+| {{{field|Additional software}}} {{#info:A comma-separated list of '''additional''' software and related dependencies that may be required to develop and/or run the model.}}
+|-
+! GUI:
+| {{{field|GUI|input type=checkbox}}} {{#info:Yes if a '''graphical user interface''' is offered.}}
 |}
 == Coverage ==
-{| class="formtable"
+{| class="formtable" style="width: 100%"
-! width="40%" | Model class:
+! width="30%" | Model class:
-| width="60%" | {{{field|model_class|size=30}}}
+| width="70%" | {{{field|model_class|size=30}}} {{#info:A short description indicating the '''class''' and/or '''scope''' of the model. For instance: Australian national electricity market, European transmission grid, distributed energy systems, smart grid simulation, web-based interactive, national planning, and so forth. Look at the data provided by existing projects for more hints.}}
 |-
 ! Modeled sectors:
-| {{{field|sectors|size=30|list}}}
+| {{{field|sectors|size=30|list}}} {{#info:A comma-separated list of the economic '''sectors''' that are supported. For example: electricity, heat, gas, oil, mobility, household, carbon sequestration.}}
 |-
-! Modeled technologies:
+! Modeled generation technologies:
-| {{{field|technologies}}}
+| {{{field|technologies}}} {{#info:Supported generation technologies. CHP and cogeneration are synomyms.}}
+|-
+! Demand sectors:
+| {{{field|Demand sectors|input type=checkboxes|multiple|values=Households,Industry,Transport,Commercial sector,Other}}} {{#info:Supported demand sectors.}}
+|-
+! Modeled energy carriers (Gas):
+| {{{field|Energy carrier (Gas)|input type=checkboxes|values=Natural gas,Biogas,Hydrogen}}} {{#info:Supported energy carriers related to '''gaseous''' fuels.}}
+|-
+! Modeled energy carriers (Liquid):
+| {{{field|Energy carrier (Liquid)|input type=checkboxes|values=Diesel,Ethanol,Petrol}}} {{#info:Supported energy carriers related to '''liquid''' fuels.}}
+|-
+! Modeled energy carriers (Solid):
+| {{{field|Energy carriers (Solid)|input type=checkboxes|values=Biomass,Coal,Lignite,Uranium}}} {{#info:Supported energy carriers related to '''solid''' fuels.}}
+|-
+! Modeled energy carriers (Renewable):
+| {{{field|Energy carriers (Renewable)|input type=checkboxes|values=Geothermal heat,Hydro,Sun,Wind}}} {{#info:Supported '''renewable''' sources. Sun includes photovoltaic and solar thermal technologies.}}
+|-
+! Transport (Electricity):
+| {{{field|Transfer (Electricity)|input type=checkboxes|values=Distribution,Transmission}}} {{#info:Support for low-voltage distribution and high-voltage transmission.}}
+|-
+! Transport (Gas):
+| {{{field|Transfer (Gas)|input type=checkboxes|values=Distribution,Transmission}}} {{#info:Support for low-pressure reticulation and high-pressure transmission.}}
+|-
+! Transport (Heat):
+| {{{field|Transfer (Heat)|input type=checkboxes|values=Distribution,Transmission}}} {{#info:Support for district heat and similar.}}
+|-
+! Storage (Electricity):
+| {{{field|Storage (Electricity)|input type=checkboxes|values=Battery,CAES,Chemical,Kinetic,PHS}}} {{#info: Support for local and grid-based electricity storage. CAES is compressed air energy storage and PHS is pumped hydroelectric storage.}}
+|-
+! Storage (Gas):
+| {{{field|Storage (Gas)|input type=checkbox}}} {{#info:Support for gas storage, either as a gas or liquid.}}
+|-
+! Storage (Heat):
+| {{{field|Storage (Heat)|input type=checkbox}}} {{#info:Support for heat storage.}}
+|-
+! User behaviour:
+| {{{field|User behaviour}}} {{#info:A brief description of the representation of '''consumer behavior''', perhaps using techniques from bounded rationality.}}
+|-
+! Market models:
+| {{{field|Market models}}} {{#info:A brief description of the representation of '''energy and carbon markets''' and their type.}}
 |-
 ! Modeled decisions:
-| {{{field|decisions}}}
+| {{{field|decisions}}} {{#info:Dispatch decisions relate to system '''operations''' and investment decisions relate to plant '''commissioning and decommissioning'''.}}
+|-
+! Changes in efficiency:
+| {{{field|Changes in efficiency}}} {{#info:Are plant efficiencies '''fixed''' or can they depend on the '''state''' of the environment and/or the plant in question?}}
 |-
 ! Geographic regions covered:
-| {{{field|georegions|input type=tokens}}}
+| {{{field|georegions|input type=tokens}}} {{#info:A comma-separated list of '''regions''' covered by the model. Leave this blank if the model and data are not limited to a specific region. Examples include: USA, Canada, Germany, western Europe.}}
 |-
 ! Geographic resolution:
-| {{{field|georesolution}}}
+| {{{field|georesolution}}} {{#info:The '''geographic''' resolution of the model. Examples include: country, federal states, NUTS 3 (a Eurostat designation), TSO regions, individual power stations.}}
 |-
 ! Time resolution:
-| {{{field|timeresolution|input type=dropdown}}}
+| {{{field|timeresolution|input type=dropdown}}} {{#info:The '''timestep''' normally used by the model.}}
 |-
 ! Network coverage:
-| {{{field|network_coverage}}}
+| {{{field|network_coverage}}} {{#info:How are engineering '''networks''' represented for in your model? Multiple answers are possible. AC load flow refers to AC transmission and DC load flow refers to DC transmission.}}
+|-
+! Observation period:
+| {{{field|Observation period|input type=checkboxes|values=Less than one month,Less than one year,More than one year}}} {{#info:The '''time horizon''' normally used by a model.}}
+|-
+! Additional dimensions (Ecological):
+| {{{field|Additional dimensions (Ecological)}}} {{#info:Can the model calculate and report '''greenhouse gas emissions''', air pollution, water demand, and direct and indirect land use?}}
+|-
+! Additional dimensions (Economic):
+| {{{field|Additional dimensions (Economical)}}} {{#info:Can the model calculate and report '''economic statistics''', including: aggregate financial cost, net-present value, spot price time series?}}
+|-
+! Additional dimensions (Social):
+| {{{field|Additional dimensions (Social)}}} {{#info:Can the model estimate and report '''social statistics''', such as energy sector employment?}}
+|-
+! Additional dimensions (Other):
+| {{{field|Additional dimensions (Other)}}} {{#info:Any other dimensions of significance.}}
 |}
 == Mathematical properties ==
-{| class="formtable"
+{| class="formtable" style="width: 100%"
-! width="40%" | Math modeltype:
+! width="30%" | Model type:
-| width="60%" | {{{field|math_modeltype}}}
+| width="70%" | {{{field|math_modeltype}}} {{#info:Multiple answers are possible.}}
 |-
-! Math modeltype shortdesc:
+! Short description of mathematical model type:
-| {{{field|math_modeltype_shortdesc|input type=textarea|cols=30}}}
+| {{{field|math_modeltype_shortdesc|input type=textarea|cols=50}}} {{#info:Provide a brief description of the mathematics behind the model. This may range from simple accounting through to intertemporal mathematical optimization.}}
 |-
 ! Math objective:
-| {{{field|math_objective}}}
+| {{{field|math_objective}}} {{#info:A comma-separated list of supported '''system objectives'''. For example: financial cost, economic welfare, greenhouse gas emissions.}}
 |-
-! Deterministic:
+! Approach to uncertainty:
-| {{{field|deterministic}}}
+| {{{field|deterministic}}} {{#info:How is '''uncertainty''' dealt with by your model? Answers might include: deterministic, stochastic, stochastic hydro inflows but otherwise perfect foresight, monte carlo methods, sensitivity analysis.}}
 |-
-! Is suited for many scenarios:
+! Suited for many scenarios / monte-carlo:
-| {{{field|is_suited_for_many_scenarios}}}
+| {{{field|is_suited_for_many_scenarios|input type=checkbox}}} {{#info:Is the model able to be used for '''large-scale scenario analysis''' with hundreds or thousands of different parameter sets being investigated?}}
 |-
 ! Number of variables:
-| {{{field|number_of_variables}}}
+| {{{field|number_of_variables}}} {{#info:How many '''variables''' might a typical model have? Please enter a number ''without'' special letters or characters.}}
+|-
+! Supports Monte Carlo simulation:
+| {{{field|montecarlo|input type=checkbox}}}  {{#info:Does the model support '''Monte Carlo''' methods?}}
 |-
 ! Computation time minutes:
-| {{{field|computation_time_minutes}}}
+| {{{field|computation_time_minutes}}} {{#info:How long might a typical model take to solve in '''minutes'''? Please enter a number ''without'' special letters or characters.}}
+|-
+! Hardware used for computation time:
+| {{{field|computation_time_hardware}}} {{#info:A brief description of the '''hardware''' used to establish runtime benchmarks.}}
+|-
+! Comments regarding computation time:
+| {{{field|computation_time_comments}}} {{#info:You can add a '''comment''' regarding the computation time. For example, you could explain under what circumstances the given run time time would be typical.}}
 |}
 == References ==
+{| class="formtable" style="width: 100%"
-{| class="formtable"
+! width="30%" | Citation reference:
-! width="40%" | Citation references:
+| width="70%" | {{{field|citation_references}}} {{#info:A single publication which can be used to '''cite''' the model. For example: Doe, John (2014). "An electricity market model for Europe", Journal of Modeling Sciences, Vol 10, Issue 80. The DOI is given next.}}
-| width="60%" | {{{field|citation_references}}}
 |-
 ! Citation doi:
-| {{{field|citation_doi}}}
+| {{{field|citation_doi}}} {{#info:The '''DOI''' identifier for the given reference, if available.}}
+|-
+! References to reports produced using the model:
+| {{{field|report_references|input type=textarea|cols=50}}} {{#info:References to reports produced using the model.}}
 |-
 ! Example research questions:
-| {{{field|example_research_questions}}}
+| {{{field|example_research_questions|input type=textarea|cols=50}}} {{#info:A selection of research questions that the model is capable of answering.}}
+|-
+! Larger scale usage:
+| {{{field|Larger scale usage}}} {{#info:TOFIX}}
+|-
+! Model validation:
+| {{{field|Model validation}}} {{#info:List any procedures used to '''help ensure''' that the model is valid.}}
+|-
+! Comment on model validation:
+| {{{field|Comment on model validation}}} {{#info:Comment on procedures used to '''help ensure''' the model is valid.}}
+|-
+! Model specific properties:
+| {{{field|Specific properties}}} {{#info:List any properties that are '''special''' or unique to your model.}}
+|-
 |}
-{{{end template}}}
+== Model integration ==
-'''Free text:'''
+{| class="formtable" style="width: 100%"
+! width="30%" | Integrated models:
+| width="70%" | {{{field|Integrated models}}} {{#info:TOFIX}}
+|-
+! Interfaces:
+| {{{field|Interfaces}}} {{#info:List the '''interfaces''' that your model can offer to other models.}}
+|-
+! Integrating models:
+| {{{field|Integrating models}}} {{#info:TOFIX}}
+|-
+! Model input file format:
+| {{{field|Model input file format|input type=checkbox}}} {{#info:Briefly specify the '''data input format''' used by your model. For example: structured text, XML, CSV, JSON, pandas data structures, and Excel.}}
+|-
+! Model file format:
+| {{{field|Model file format|input type=checkbox}}} {{#info:TOFIX}}
+|-
+! Model output file format:
+| {{{field|Model output file format|input type=checkbox}}} {{#info:Briefly specify the '''data output format''' used by your model.}}
+|-
+|}
-{{{standard input|free text|rows=10}}}
+{{{end template}}}
+== Edit options ==
 {{{standard input|summary}}}

Log in / create account

About

Help

Search

Navigation

Search

Interaction

Toolbox

Namespaces

Variants

Views

Actions

Form:Model

Latest revision as of 14:05, 2 March 2017