diff --git a/docs/gettingstarted.md b/docs/gettingstarted.md new file mode 100644 index 0000000..03b5590 --- /dev/null +++ b/docs/gettingstarted.md @@ -0,0 +1,15 @@ +# Getting started + +Besides the functional documentation, there are other resources to get you started with PowSyBl. + +## PyPowSyBl notebooks +Have a look at our [PyPowSyBl notebooks](https://github.com/powsybl/pypowsybl-notebooks)! + +## Java tutorials +Check our [Java tutorials](https://github.com/powsybl/powsybl-tutorials) + +## Java dependency management for beginners +You want to start experiencing with Java but you are having a hard time with Maven? Use [powsybl-starter](https://github.com/powsybl/powsybl-starter) that allows you to use PowSyBl main functionalities and start working from here! + +## Start with Itools +Find information on Itools commands and how to use PowSyBl distribution [here](itools/index.md). diff --git a/docs/index.md b/docs/index.md index 094603b..dc77fb6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,6 +8,7 @@ hidden: true --- releasetrain.md +gettingstarted.md ``` @@ -37,7 +38,7 @@ The 🚂 repositories are released every two to three months through a [release - [Documentation](https://powsybl.readthedocs.io/projects/powsybl-dynawo) - [GitHub repository](https://github.com/powsybl/powsybl-dynawo) - **powsybl-metrix**: multi-variant network simulation - - [documentation](https://powsybl.readthedocs.io/projects/powsybl-metrix) + - [Documentation](https://powsybl.readthedocs.io/projects/powsybl-metrix) - [GitHub repository](https://github.com/powsybl/powsybl-metrix)
@@ -66,8 +67,8 @@ The 🚂 repositories are released every two to three months through a [release ## 🧐 Advanced features - **powsybl-afs**: Application File System to organize and store business data - - [documentation](https://powsybl.readthedocs.io/projects/powsybl-afs) + - [Documentation](https://powsybl.readthedocs.io/projects/powsybl-afs) - [GitHub repository](https://github.com/powsybl/powsybl-afs) - **powsybl-hpc**: High Performance Computing modules - - [documentation](https://powsybl.readthedocs.io/projects/powsybl-hpc) + - [Documentation](https://powsybl.readthedocs.io/projects/powsybl-hpc) - [GitHub repository](https://github.com/powsybl/powsybl-hpc) diff --git a/docs/itools/examples.md b/docs/itools/examples.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/itools/index.md b/docs/itools/index.md new file mode 100644 index 0000000..c16b972 --- /dev/null +++ b/docs/itools/index.md @@ -0,0 +1,12 @@ +# Run PowSyBl commands with Itools + +```{toctree} +--- +caption: Contents of this website +maxdepth: 2 +hidden: true +--- + +installation.md +examples.md +``` diff --git a/docs/itools/installation.md b/docs/itools/installation.md new file mode 100644 index 0000000..8a94748 --- /dev/null +++ b/docs/itools/installation.md @@ -0,0 +1,80 @@ +# Installation of a basic PowSyBl distribution + +Follow these simple steps to get familiar with the PowSyBl environment. Below are instructions to install a basic PowSyBl distribution and to start running iTools commands. + +Please note that this PowSyBl distribution is functional on Windows and Linux but is not supported for MacOS yet. + +## Installation + +### Installation from binaries + +Start by downloading the [latest version of a PowSyBl distribution](https://github.com/powsybl/powsybl-distribution). +Unzip the downloaded package. You can now add `/powsybl-distribution-/bin` to your environment variable `PATH`. + +### Installation from sources + +It is also possible to install PowSyBl distribution from sources. + +First download the sources of [`powsybl-distribution` repository](https://github.com/powsybl/powsybl-distribution): + +``` +$ git clone https://github.com/powsybl/powsybl-distribution.git +``` + +If you want to work on a stable version, go to [the latest release tag](https://github.com/powsybl/powsybl-distribution/releases/latest): + +``` +$ git checkout tags/ -b latest-release +``` + +Generate a basic PowSyBl distribution by launching from the root repository: + +``` +$ cd +$ mvn clean package +``` + +The distribution is generated in `/target`. You can then add `/target/powsybl-distribution-/bin` to your environment variable `PATH`. + +## Test your installation + +Launch the `itools --help` command in your terminal to check that everything went smoothly. + +``` +$> itools --help +usage: itools [OPTIONS] COMMAND [ARGS] + +Available options are: + --config-name Override configuration file name + +Available commands are: + +Computation: + compare-security-analysis-results Compare security analysis results + loadflow Run loadflow + loadflow-validation Validate load-flow results of a network + security-analysis Run security analysis + +Data conversion: + convert-network convert a network from one format to another + +Misc: + plugins-info List the available plugins + +Script: + run-script run script (only groovy is supported) + +``` + +## Set a default configuration + +You can set a default configuration by copying the provided configuration file in the `.itools` repository +in your `HOME` (note that you will need to create this repository if it does not exist): + +``` +$ mkdir /.itools +$ cp /resources/config/config.yml /.itools/config.yml +``` + +This step is not mandatory **if you already have a custom configuration file and the necessary configuration modules are filled**. +For more information on configuration, go to the [related documentation]().