com.powsybl.metrix.tools.MetrixDieTool Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powsybl-metrix-tools Show documentation
There is a newer version: 2.4.0
/*
 * Copyright (c) 2021, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.metrix.tools;

import com.google.auto.service.AutoService;
import com.powsybl.contingency.ContingenciesProvider;
import com.powsybl.contingency.dsl.GroovyDslContingenciesProvider;
import com.powsybl.iidm.network.ImportConfig;
import com.powsybl.iidm.network.Network;
import com.powsybl.metrix.integration.*;
import com.powsybl.metrix.integration.dataGenerator.MetrixInputData;
import com.powsybl.metrix.mapping.TimeSeriesMappingConfig;
import com.powsybl.timeseries.ReadOnlyTimeSeriesStore;
import com.powsybl.timeseries.ReadOnlyTimeSeriesStoreCache;
import com.powsybl.tools.Command;
import com.powsybl.tools.Tool;
import com.powsybl.tools.ToolRunningContext;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;

import java.nio.file.Path;

/**
 * @author Marianne Funfrock {@literal }
 */
@AutoService(Tool.class)
public class MetrixDieTool implements Tool {

    private static final String CONTINGENCIES_FILE = "contingencies-file";
    private static final String METRIX_DSL_FILE = "metrix-dsl-file";
    private static final String REMEDIAL_ACTIONS_FILE = "remedial-actions-file";
    private static final String OUTPUT_DIR = "output-dir";

    @Override
    public Command getCommand() {
        return new Command() {
            @Override
            public String getName() {
                return "metrix-die";
            }

            @Override
            public String getTheme() {
                return "Metrix";
            }

            @Override
            public String getDescription() {
                return "Generate Metrix DIE files";
            }

            @Override
            public Options getOptions() {
                Options options = new Options();
                options.addOption(Option.builder()
                        .longOpt("case-file")
                        .desc("the base case file")
                        .hasArg()
                        .argName("FILE")
                        .required()
                        .build());
                options.addOption(Option.builder()
                        .longOpt(CONTINGENCIES_FILE)
                        .desc("Groovy DSL file that describes contingencies")
                        .hasArg()
                        .argName("FILE")
                        .build());
                options.addOption(Option.builder()
                        .longOpt(METRIX_DSL_FILE)
                        .desc("Groovy DSL file that describes the branch monitoring and the phase shifter actions")
                        .hasArg()
                        .argName("FILE")
                        .build());
                options.addOption(Option.builder()
                        .longOpt(REMEDIAL_ACTIONS_FILE)
                        .desc("name of the remedial actions file")
                        .hasArg()
                        .argName("FILE")
                        .build());
                options.addOption(Option.builder()
                        .longOpt(OUTPUT_DIR)
                        .desc("Output directory")
                        .hasArg()
                        .argName("DIR")
                        .build());
                return options;
            }

            @Override
            public String getUsageFooter() {
                return null;
            }
        };
    }

    @Override
    public void run(CommandLine line, ToolRunningContext context) throws Exception {

        Path caseFile = context.getFileSystem().getPath(line.getOptionValue("case-file"));

        Path contingenciesFile = line.hasOption(CONTINGENCIES_FILE)
                ? context.getFileSystem().getPath(line.getOptionValue(CONTINGENCIES_FILE))
                : null;

        Path metrixDslFile = line.hasOption(METRIX_DSL_FILE)
                ? context.getFileSystem().getPath(line.getOptionValue(METRIX_DSL_FILE))
                : null;

        Path remedialActionFile = line.hasOption(REMEDIAL_ACTIONS_FILE)
                ? context.getFileSystem().getPath(line.getOptionValue(REMEDIAL_ACTIONS_FILE))
                : null;

        Path outputDir = line.hasOption(OUTPUT_DIR)
                ? context.getFileSystem().getPath(line.getOptionValue(OUTPUT_DIR))
                : null;

        context.getOutputStream().println("Loading case ...");

        Network network = Network.read(caseFile, context.getShortTimeExecutionComputationManager(), ImportConfig.load(), null);

        MetrixParameters parameters = MetrixParameters.load();

        MetrixConfig config = MetrixConfig.load();

        ContingenciesProvider contingenciesProvider = null;
        if (contingenciesFile != null) {
            contingenciesProvider = new GroovyDslContingenciesProvider(contingenciesFile);
        }

        TimeSeriesMappingConfig mappingConfig = new TimeSeriesMappingConfig(network);

        MetrixDslData metrixDslData = null;
        if (metrixDslFile != null) {
            ReadOnlyTimeSeriesStore store = new ReadOnlyTimeSeriesStoreCache() {
                @Override
                public boolean timeSeriesExists(String timeSeriesName) {
                    return true;
                }
            };
            metrixDslData = MetrixDslDataLoader.load(metrixDslFile, network, parameters, store, mappingConfig);
        }

        context.getOutputStream().println("Writing DIE ...");

        // write DIE
        new MetrixInputData(MetrixNetwork.create(network, contingenciesProvider, null, parameters, remedialActionFile), metrixDslData, parameters)
                .write(outputDir, true, config.isConstantLossFactor());
    }
}