Flow decomposition interface

Interface of a flow decomposition task

License	Mozilla Public License, Version 2.0
Categories	Unity Business Logic Libraries Game Development
GroupId	com.farao-community.farao
ArtifactId	farao-flow-decomposition-api
Last Version	2.1.1
Release Date	Aug 17, 2020
Type	jar
Description	Flow decomposition interface Interface of a flow decomposition task
Project URL	http://www.farao-community.com/farao-flow-decomposition-api

Download farao-flow-decomposition-api

Filename	Size
farao-flow-decomposition-api-2.1.1.pom
farao-flow-decomposition-api-2.1.1.jar	12 KB
farao-flow-decomposition-api-2.1.1-tests.jar	13 KB
farao-flow-decomposition-api-2.1.1-test-sources.jar	7 KB
farao-flow-decomposition-api-2.1.1-sources.jar	9 KB
farao-flow-decomposition-api-2.1.1-javadoc.jar	74 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.farao-community.farao/farao-flow-decomposition-api/ -->
<dependency>
    <groupId>com.farao-community.farao</groupId>
    <artifactId>farao-flow-decomposition-api</artifactId>
    <version>2.1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.farao-community.farao/farao-flow-decomposition-api/
implementation 'com.farao-community.farao:farao-flow-decomposition-api:2.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.farao-community.farao/farao-flow-decomposition-api/
implementation ("com.farao-community.farao:farao-flow-decomposition-api:2.1.1")

Apache Buildr

'com.farao-community.farao:farao-flow-decomposition-api:jar:2.1.1'

Apache Ivy

<dependency org="com.farao-community.farao" name="farao-flow-decomposition-api" rev="2.1.1">
  <artifact name="farao-flow-decomposition-api" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.farao-community.farao', module='farao-flow-decomposition-api', version='2.1.1')
)

Scala SBT

libraryDependencies += "com.farao-community.farao" % "farao-flow-decomposition-api" % "2.1.1"

Leiningen

[com.farao-community.farao/farao-flow-decomposition-api "2.1.1"]

Dependencies

compile (5)

Group / Artifact	Type	Version
com.powsybl : powsybl-commons	jar	3.5.0
com.powsybl : powsybl-loadflow-api	jar	3.5.0
com.powsybl : powsybl-sensitivity-api	jar	3.5.0
com.farao-community.farao : farao-crac-file-api	jar	2.1.1
com.farao-community.farao : farao-flow-decomposition-results-api	jar	2.1.1

test (5)

Group / Artifact	Type	Version
ch.qos.logback : logback-classic	jar	1.2.3
com.google.jimfs : jimfs	jar	1.1
com.powsybl : powsybl-commons	test-jar	3.5.0
junit : junit	jar	4.12
org.mockito : mockito-core	jar	2.19.0

Project Modules

There are no modules declared in this project.

FARAO - core

FARAO stands for Fully Autonomous Remedial Actions Optimisation. It is an open-source toolbox that aims at providing a modular engine for remedial actions optimisation.

farao-core repository contains the main features of FARAO. It provides a command line tool to interact with these features.

For detailed information about FARAO toolbox, please refer to the detailed documentation.

This project and everyone participating in it is governed by the FARAO Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

In order to build farao-core, you need the following environment available:

• Install JDK (11 or greater),
• Install Maven latest version.

Installing

Before installing farao-core, you need to install OR-Tools, a software suite for optimisation that is used by FARAO remedial actions optimiser.

Please refer to OR-tools website for installation instructions.

To build farao-core, enter on the command line:

$> git clone https://github.com/farao-community/farao-core.git
$> cd farao-core
$> ./install.sh

FARAO also needs a loadflow engine and a sensitivity calculation engine at runtime. You may use any engine integrated in PowSyBl framework.

Hades2 tool from RTE is available as a freeware for demonstration purpose. For more information about how to get and install Hades2 loadflow and sensitivity computation, please refer to the dedicated documentation.

Running

In order for FARAO to run without error, you will need to configure your itools platform. itools is a command line interface provided by PowSyBl framework.

Two options are available:

1. First, you can use the one provided by FARAO. It is saved in the etc directory of the installation, and is called config.yml. You just have to copy-paste it in $HOME/.itools directory.

2. Expert users can also adapt it to their own needs.

For using itools, enter on the command line:

cd <install-prefix>/bin
./itools help

For more information about itools, do not hesitate to visit PowSyBl documentation.

License

This project is licensed under the Mozilla Public License 2.0 - see the LICENSE.txt file for details.

FARAO community

The FARAO open-source power systems toolbox community

Versions

Version
2.1.1 Aug 17, 2020
2.1.0 Aug 7, 2020
2.0.0 Mar 20, 2020
1.2.0 Nov 18, 2019
1.1.0 Aug 28, 2019
1.0.2 Jul 31, 2019
1.0.1 Jul 9, 2019
1.0.0 Apr 23, 2019