Add a tutorial to explain how to use powsybl-METRIX

metrix/src/main/resources/3A/data/conf.groovy

@@ -0,0 +1,8 @@
+
+for (l in network.branches){
+branch(l.id){
+baseCaseFlowResults true
+maxThreatFlowResults true
+}
+}
+

metrix/src/main/resources/3A/data/contingencies.groovy

@@ -0,0 +1,2 @@
+contingency("S_SO_1"){equipments "S_SO_1"}
+

metrix/src/main/resources/3A/data/mapping_file_gen_load.groovy

@@ -0,0 +1,33 @@
+mapToGenerators{
+timeSeriesName 'SO_G1'
+filter {generator.id=='SO_G1'}
+}
+
+mapToGenerators{
+timeSeriesName 'SO_G2'
+filter {generator.id=='SO_G2'}
+}
+
+mapToLoads{
+timeSeriesName 'SE_L1'
+filter {load.id=='SE_L1'}
+}
+
+timeSeries['nul']=0
+
+mapToGenerators{
+timeSeriesName 'nul'
+filter {generator.id in ['N_G','SE_G'] }
+}
+
+mapToLoads{
+timeSeriesName 'nul'
+filter {load.id in ['SE_L2','SO_L']}
+}
+
+network.getTwoWindingsTransformer('NE_NO_1').phaseTapChanger.tapPosition=17
+
+mapToHvdcLines{
+timeSeriesName 'nul'
+filter {hvdcLine.id in ['HVDC1','HVDC2'] }
+}

metrix/src/main/resources/3A/data/ts/time-series-tp.csv

@@ -0,0 +1,4 @@
+Time;Version;SE_L1;SO_G1;SO_G2;seuilN;seuilAM
+2015-01-01T01:00+01:00;1;960;0;960;400;480
+2015-01-01T02:00+01:00;1;960;960;0;400;480
+2015-01-01T03:00+01:00;1;960;960;0;100;480

metrix/src/main/resources/3A/launch_metrix_3A.sh

@@ -0,0 +1 @@
+itools metrix --case-file data/reseau_6noeuds.xiidm --mapping-file data/mapping_file_gen_load.groovy --metrix-dsl-file data/conf.groovy --contingencies-file data/contingencies.groovy --time-series data/ts/time-series-tp.csv --versions 1 --first-variant 0 --variant-count 3 --csv-results-file results/results.csv --chunk-size 3 --log-archive logs --network-point-file results/output_network.xiidm

metrix/src/main/resources/3A/results/results3A.csv

@@ -0,0 +1,4 @@
+Time;Version;ERROR_CODE;FLOW_NE_NO_1;FLOW_NE_N_1;FLOW_NE_N_2;FLOW_NO_N_1;FLOW_NO_N_2;FLOW_SE_NE_1;FLOW_SE_NE_2;FLOW_SO_NO_1;FLOW_SO_NO_2;FLOW_S_SE_1;FLOW_S_SE_2;FLOW_S_SO_1;FLOW_S_SO_2;GEN_COST;INIT_BAL_AREA_0;LOAD_COST;LOSSES;MAX_THREAT_1_FLOW_NE_NO_1;MAX_THREAT_1_FLOW_NE_N_1;MAX_THREAT_1_FLOW_NE_N_2;MAX_THREAT_1_FLOW_NO_N_1;MAX_THREAT_1_FLOW_NO_N_2;MAX_THREAT_1_FLOW_SE_NE_1;MAX_THREAT_1_FLOW_SE_NE_2;MAX_THREAT_1_FLOW_SO_NO_1;MAX_THREAT_1_FLOW_SO_NO_2;MAX_THREAT_1_FLOW_S_SE_1;MAX_THREAT_1_FLOW_S_SE_2;MAX_THREAT_1_FLOW_S_SO_1;MAX_THREAT_1_FLOW_S_SO_2;OVERLOAD_BASECASE;OVERLOAD_OUTAGES;MAX_THREAT_1_NAME_NE_NO_1;MAX_THREAT_1_NAME_NE_N_1;MAX_THREAT_1_NAME_NE_N_2;MAX_THREAT_1_NAME_NO_N_1;MAX_THREAT_1_NAME_NO_N_2;MAX_THREAT_1_NAME_SE_NE_1;MAX_THREAT_1_NAME_SE_NE_2;MAX_THREAT_1_NAME_SO_NO_1;MAX_THREAT_1_NAME_SO_NO_2;MAX_THREAT_1_NAME_S_SE_1;MAX_THREAT_1_NAME_S_SE_2;MAX_THREAT_1_NAME_S_SO_1;MAX_THREAT_1_NAME_S_SO_2
+2015-01-01T01:00:00+01:00;1;0.0;-176.9;-101.0;-101.0;101.0;101.0;-189.5;-189.5;189.5;189.5;290.5;290.5;-290.5;-290.5;0.0;0.0;0.0;24.3;-225.3;-125.3;-125.3;125.3;125.3;-237.9;-237.9;237.9;237.9;242.1;242.1;0.0;-484.2;0.0;0.0;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1
+2015-01-01T02:00:00+01:00;1;0.0;-176.9;-101.0;-101.0;101.0;101.0;-189.5;-189.5;189.5;189.5;290.5;290.5;-290.5;-290.5;0.0;0.0;0.0;24.3;-225.3;-125.3;-125.3;125.3;125.3;-237.9;-237.9;237.9;237.9;242.1;242.1;0.0;-484.2;0.0;0.0;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1
+2015-01-01T03:00:00+01:00;1;0.0;-176.9;-101.0;-101.0;101.0;101.0;-189.5;-189.5;189.5;189.5;290.5;290.5;-290.5;-290.5;0.0;0.0;0.0;24.3;-225.3;-125.3;-125.3;125.3;125.3;-237.9;-237.9;237.9;237.9;242.1;242.1;0.0;-484.2;0.0;0.0;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1;S_SO_1

metrix/src/main/resources/3B/data/conf.groovy

@@ -0,0 +1,6 @@
+branch("S_SO_2"){
+baseCaseFlowResults true
+maxThreatFlowResults true
+branchRatingsBaseCase "seuilN"
+branchRatingsOnContingency "seuilN"
+}

metrix/src/main/resources/3B/data/contingencies.groovy

@@ -0,0 +1,3 @@
+for (b in network.branches) {
+contingency(b.id){equipments b.id}
+}

metrix/src/main/resources/3B/data/mapping_file_gen_load.groovy

@@ -0,0 +1,33 @@
+mapToGenerators{
+timeSeriesName 'SO_G1'
+filter {generator.id=='SO_G1'}
+}
+
+mapToGenerators{
+timeSeriesName 'SO_G2'
+filter {generator.id=='SO_G2'}
+}
+
+mapToLoads{
+timeSeriesName 'SE_L1'
+filter {load.id=='SE_L1'}
+}
+
+timeSeries['nul']=0
+
+mapToGenerators{
+timeSeriesName 'nul'
+filter {generator.id in ['N_G','SE_G'] }
+}
+
+mapToLoads{
+timeSeriesName 'nul'
+filter {load.id in ['SE_L2','SO_L']}
+}
+
+network.getTwoWindingsTransformer('NE_NO_1').phaseTapChanger.tapPosition=17
+
+mapToHvdcLines{
+timeSeriesName 'nul'
+filter {hvdcLine.id in ['HVDC1','HVDC2'] }
+}

metrix/src/main/resources/3B/data/ts/time-series-tp.csv

@@ -0,0 +1,4 @@
+Time;Version;SE_L1;SO_G1;SO_G2;seuilN;seuilAM
+2015-01-01T01:00+01:00;1;960;0;960;400;480
+2015-01-01T02:00+01:00;1;960;960;0;400;480
+2015-01-01T03:00+01:00;1;960;960;0;100;480

metrix/src/main/resources/3B/launch_metrix_3B.sh

@@ -0,0 +1 @@
+itools metrix --case-file data/reseau_6noeuds.xiidm --mapping-file data/mapping_file_gen_load.groovy --metrix-dsl-file data/conf.groovy --contingencies-file data/3B/contingencies.groovy --time-series data/ts/time-series-tp.csv --versions 1 --first-variant 0 --variant-count 3 --csv-results-file results/results3B.csv --chunk-size 3 --log-archive logs --network-point-file results/output_network.xiidm

metrix/src/main/resources/3B/results/results3B.csv

@@ -0,0 +1,4 @@
+Time;Version;ERROR_CODE;FLOW_S_SO_2;GEN_COST;INIT_BAL_AREA_0;LOAD_COST;LOSSES;MAX_THREAT_1_FLOW_S_SO_2;OVERLOAD_BASECASE;OVERLOAD_OUTAGES;MAX_THREAT_1_NAME_S_SO_2
+2015-01-01T01:00:00+01:00;1;0.0;-290.5;0.0;0.0;0.0;24.3;-484.2;0.0;84.2;S_SO_1
+2015-01-01T02:00:00+01:00;1;0.0;-290.5;0.0;0.0;0.0;24.3;-484.2;0.0;84.2;S_SO_1
+2015-01-01T03:00:00+01:00;1;0.0;-290.5;0.0;0.0;0.0;24.3;-484.2;190.5;384.2;S_SO_1

metrix/src/main/resources/4A/data/conf.groovy

@@ -0,0 +1,10 @@
+parameters {
+computationType OPF_WITHOUT_REDISPATCHING
+}
+
+branch('S_SO_2') {
+	baseCaseFlowResults true
+	maxThreatFlowResults true
+	branchRatingsBaseCase 'seuilN'
+	branchRatingsOnContingency 'seuilN'
+}

metrix/src/main/resources/4A/data/contingencies.groovy

@@ -0,0 +1,3 @@
+for (b in network.branches) {
+contingency(b.id){equipments b.id}
+}

metrix/src/main/resources/4A/data/mapping_file_gen_load.groovy

@@ -0,0 +1,33 @@
+mapToGenerators{
+timeSeriesName 'SO_G1'
+filter {generator.id=='SO_G1'}
+}
+
+mapToGenerators{
+timeSeriesName 'SO_G2'
+filter {generator.id=='SO_G2'}
+}
+
+mapToLoads{
+timeSeriesName 'SE_L1'
+filter {load.id=='SE_L1'}
+}
+
+timeSeries['nul']=0
+
+mapToGenerators{
+timeSeriesName 'nul'
+filter {generator.id in ['N_G','SE_G'] }
+}
+
+mapToLoads{
+timeSeriesName 'nul'
+filter {load.id in ['SE_L2','SO_L']}
+}
+
+network.getTwoWindingsTransformer('NE_NO_1').phaseTapChanger.tapPosition=17
+
+mapToHvdcLines{
+timeSeriesName 'nul'
+filter {hvdcLine.id in ['HVDC1','HVDC2'] }
+}

metrix/src/main/resources/4A/data/parades.csv

@@ -0,0 +1,5 @@
+NB;4;;;
+S_SO_1;1;SS1_SS1_DJ_OMN;;
+S_SO_1;1;SOO1_SOO1_DJ_OMN;;
+S_SO_1;2;SS1_SS1_DJ_OMN;SOO1_SOO1_DJ_OMN;
+S_SO_1;1;S_SO_2;;