powsybl-core
powsybl-core copied to clipboard
powsybl
A framework to build power system oriented software
PowSyBl Core
PowSyBl (Power System Blocks) is an open source framework written in Java, that makes it easy to write complex software for power systems’ simulations and analysis. Its modular approach allows developers to extend or customize its features.
PowSyBl is part of the LF Energy Foundation, a project of The Linux Foundation that supports open source innovation projects within the energy and electricity sectors.
Read more at https://www.powsybl.org !
This project and everyone participating in it is governed by the PowSyBl Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
PowSyBl vs PowSyBl Core
This document describes how to build the code of PowSyBl Core. If you just want to run PowSyBl demos, please visit https://www.powsybl.org/ where downloads will be available soon. If you want guidance on how to start building your own application based on PowSyBl, please visit the http://www.powsybl.org/docs/tutorials/ page.
The PowSyBl Core project is not a standalone project. Read on to learn how to modify the core code, be it for fun, for diagnosing bugs, for improving your understanding of the framework, or for preparing pull requests to suggest improvements! PowSyBl Core provides library code to build all kinds of applications for power systems: a complete and extendable grid model, support for common exchange formats, APIs for power simulations an analysis, and support for local or distributed computations. For deployment, powsybl-core also provides iTools, a tool to build cross-platform integrated command-line applications. To build cross-platform graphical applications, please visit the PowSyBl GSE repository https://github.com/powsybl/powsybl-gse page.
Environment requirements
Powsybl-core project is fully written in Java, so you only need few requirements:
- JDK (11 or greater)
- Maven (3.3.9 or greater)
To run all the tests, simply launch the following command from the root of the repository:
$> mvn package
Modify some existing tests or create your own new tests to experiment with the framework! If it suits you better, import the project in an IDE and use the IDE to launch your own main classes. If you know java and maven and want to do things manually, you can also use maven directly to compute the classpath of all the project jars and run anything you want with it.
Read Contributing.md for more in-depth explanations on how to run code.
Read Install to generate an installed iTools distribution, a standalone external folder that contains all the built objects required to run powsybl programs.
Install
An iTools distribution can be generated and installed. The installation is a standalone external folder that contains all
the built objects required to run powsybl programs through the itools command-line interface. This repository contains
the install.sh script to do so easily. By default, the install.sh will compile code and copy the resulting iTools
distribution to the install folder.
$> ./install.sh
A more detailled description of the install.sh script options follows:
Targets
| Target | Description |
|---|---|
| clean | Clean modules |
| compile | Compile modules |
| package | Compile modules and create a distributable package |
| install | Compile modules and install it |
| docs | Generate the documentation (Javadoc) |
| help | Display this help |
Options
The install.sh script options are saved in the install.cfg configuration file. This configuration file is loaded and
updated each time you use the install.sh script.
Global options
| Option | Description | Default value |
|---|---|---|
| --help | Display this help | |
| --prefix | Set the installation directory | $HOME/powsybl |
Default configuration file
# -- Global options --
powsybl_prefix=$HOME/powsybl
powsybl