Test cases description template
Markdown metadata block
layout: page
do not modify
title: Test case's name
put the name of your test case, try to be as specific as possible
tags: [_tag1, tag2, tag3_]
pick none, one or several tags for the following categories:
- Opensource : tag to be added if there is at least one open source implementation of this test case
- CIM description: CIMStatic or CIMDynamic tags can be selected if your test case can be exported with CIM standard
- Test case size: Small (<10 nodes), medium (>10 and <100 nodes), large (>100 nodes)
- Standard: select the relevant tag name standard (WECC, CIGRE, IEEE, IEC, etc.) if your test case is included in a standard.
- Test case readiness level: indicates the level of maturity of the test case:
- case exists on paper
- case has been implemented in a tool
- case has been implemented and validated in tool with a reference or field measures.
- case is being used on regular basis in one or several industrial tools
- Phenomena: tag caracterizing the type of phenomena the test case is meant to highlight. For example: Short term Voltage, long term voltage, small signal, frequency, converter driven instability slow interaction, converter driven instability fast interaction, resonance, restoration, etc.
- Code section: if this template contains a Modelica or Openmodelica code section in line with the network description and equations, use the tag CodeImplementation
- Contains: gives the list of electrical devices the case contains: Protection, line, bus, machines, synchronous generator, transformer, controllers, capacitors, sources, excitation system, automatic voltage regulator, PSS, PLL, Governor, load, sensors, wind generation, solar generation, load, HVDC, synchronous condensers, DLR, etc.
- Implementation tools: software name (EMTP, PSCAD, PSS/E, NEPLAN, dynawo, DPSIM, Power Factory, Matlab, STEPSS, RTDS, Opal RT, powerworld, GE PSLF) to be used as tag if your test case is implemented in specific software
date: XX/XX/20XX
date of page creation
last-updated: XX/XX/20XX
date of last page modification
author
name the author of this test case
reviewers
name the reviewers of this test case
Do not provide the title here (to avoid duplicate display) as it should be included in the Metadata block. We recommend including the issue ID generated by Colib GitHub along with the title.
A test case includes a network test system with static and dynamic models for each element, some input data, and some scenarios. Each test case must be specific enough to be added in a new page. In other words, it means that the test case should be significatively different from existing standard test cases (either by its network topology, generation mix, static data values), either by its operating point, either by the phenomena/event it tackles. The differences with existing well-known test cases should be clearly explained.
Use case purpose and context (mandatory)
This section aims at explaining the main purpose of the test case, the reason why it was built. The history behind the test case can also be given for clarity.
References citations can be made pointing to the references section (at the end of the document). Two ways to include a citation:
-
by using footnote links: put
[^1]
inside the main text insert references manually by using this markdown list links in the reference section below. -
by using a bibtex file: add your bibtexfile in the _bibliography folder. Add a citation inside your text with:
{% cite DUMMY:2 %}
which gives: (Taylor, 2010) Insert directly the bibtex file bibliography in the reference section below
Table of references (mandatory)
This section lists all the references. It must comply with current citation standards.
A bibtex file can directly be used. Two ways to include a bibliography:
-
by using footnote links: insert references manually by using this markdown list:
<a id="1">[1]</a> Author's name, "Title" Date Journal, doi: 10.1109/>XXXXx46648.2021.9495096 <a id="2">[2]</a> Author's name 2, "Title2" Date Journal, doi: 10.1109/>XXXXXXXXX.2021.9495096
-
by inserting directly the bibtex file biblioagraphy with the following command:
{% bibliography --file references %}
--cited
command list only the ones that are cited in the page.
More details about the citations details can be found at: jekyllScholarCitations
Network description (mandatory)
This section gives the overview of the network test system. A grid map, an electrical circuit diagram, can be provided as well as some extra explanations of the network (chart labels, symbols, generation mix, consumption level, etc.).
For electrical circuit diagram, we invite the author to use the draw.io plugin for github allowing you to make your own diagram easily. The diagram is fully editable with github commit using a graphical interface, and allowing multiple format outputs (for more details, see: draw.io github) If you want to use a picture, please use Scalable Vector Graphics (SVG) file format.
Static and Dynamic models description (mandatory)
This section lists the different elements of the network test system.
To avoid moo much information on the same page, some links to the elements model’s pages can be provided.
Input Data (mandatory)
This section includes all the needed input data the test case needs to be run. It covers:
- static data for the network
Line/Cable | Nominal Voltage (kV) | R (\(\Omega\)) | X (\(\Omega\)) |
---|---|---|---|
XXX | XXX | XXX | XXX |
- dynamic data for each dynamic element component. For example :
PLL parameter | Units (if pu specify the base) |
---|---|
Tpll | ms |
- load flow values
- initial states of dynamic variables
If the network is too big, input data can be provided by uploading data files directly in the page. The data files should be understandable and contains unit information.
For example: [Data](/pages/templates/data.xlsx)
Scenarios (at least one mandatory)
This section explains the scenario that is played on the previous described system. For example: three phase ground fault on line 1-3.
Scenario No. XX / Name
gives a number or/and a name to the scenario.
In this paragraph, all the information that is required to run the test and that the previous section hasn’t covered should be included in the scenario description. If no additional information is required, this section can be left empty.
Below is listed the type of information that can be useful for the reader:
-
Event gives a description of the event and the time of the event.
-
Operating point No. X If the operating point differs from the load flow values provided before, the change in the operating point should be precised here.
-
Control modes if specific control modes are used for the scenario, it should be detailed here.
-
Network variant if slight changes are made in the network configuration, topology, mix, dynamic data, etc. those changes can be described here.
Simulation parameters (optional)
The section gathers the main simulation parameters used to run the case.
For example:
Parameter | value |
---|---|
Type of problem | DAE |
Solver name | IDA |
Computing method | variable-order, variable-coefficient Backward differentiation formula in fixed-leading-coefficient form |
Time step | 5 ms |
Simulation duration | 5 s |
Outputs (mandatory)
The section presents the key outputs of the simulation by providing figures, curves, and text.
The results should be interpreted to the extent possible. The plots can be provided in various forms.
Modelica implementation (optional)
This section is a code section that provides the source code for model described above.
The implementation should correspond strictly the equations/diagram/algorithm described before and should have been validated in a tool. The date of the code should be specified at the beginning of the section, the code should be clean, readable and organized. The code can be presented in a markdown code block like this:
function test() {
console.log("notice the blank line before this function?");
}
Open source implementations (if any)
This section give a list of the different open source implementations of this model. It provides the reader with links and languages/software used for each implementation.
The markdown table can be used to display such list, for example:
This model has been successfully implemented in :
Software | URL | Language | Open-Source License | Last consulted date | Comments |
---|---|---|---|---|---|
Software name | Link | modelica | MPL v2.0 | XX/XX/20XX | Comments can contain implementations details such as validation means, implementations key choices, etc. |