From e3ff63d30635ca91cbccd6fb6f849e1df0775611 Mon Sep 17 00:00:00 2001 From: Sophie Frasnedo Date: Wed, 28 Aug 2024 16:05:31 +0200 Subject: [PATCH 1/6] Add getting started resources Signed-off-by: Sophie Frasnedo --- docs/gettingstarted.md | 13 +++++++++++++ docs/index.md | 1 + docs/itools.md | 0 3 files changed, 14 insertions(+) create mode 100644 docs/gettingstarted.md create mode 100644 docs/itools.md diff --git a/docs/gettingstarted.md b/docs/gettingstarted.md new file mode 100644 index 0000000..e74143b --- /dev/null +++ b/docs/gettingstarted.md @@ -0,0 +1,13 @@ +# Getting started + +## 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.md). diff --git a/docs/index.md b/docs/index.md index 094603b..506c902 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,6 +8,7 @@ hidden: true --- releasetrain.md +gettingstarted.md ``` diff --git a/docs/itools.md b/docs/itools.md new file mode 100644 index 0000000..e69de29 From fcc35ce96fcd3f8bbf540efe96c33e74c34cb394 Mon Sep 17 00:00:00 2001 From: Sophie Frasnedo Date: Thu, 29 Aug 2024 15:41:03 +0200 Subject: [PATCH 2/6] Reorganize files Signed-off-by: Sophie Frasnedo --- docs/gettingstarted.md | 2 ++ docs/{itools.md => itools/examples.md} | 0 docs/itools/index.md | 12 +++++++ docs/itools/installation.md | 50 ++++++++++++++++++++++++++ 4 files changed, 64 insertions(+) rename docs/{itools.md => itools/examples.md} (100%) create mode 100644 docs/itools/index.md create mode 100644 docs/itools/installation.md diff --git a/docs/gettingstarted.md b/docs/gettingstarted.md index e74143b..4c125d6 100644 --- a/docs/gettingstarted.md +++ b/docs/gettingstarted.md @@ -1,5 +1,7 @@ # Getting started +Beside the functional documentation + ## PyPowSyBl notebooks Have a look at our [PyPowSyBl notebooks](https://github.com/powsybl/pypowsybl-notebooks)! diff --git a/docs/itools.md b/docs/itools/examples.md similarity index 100% rename from docs/itools.md rename to docs/itools/examples.md 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..854a2eb --- /dev/null +++ b/docs/itools/installation.md @@ -0,0 +1,50 @@ +# 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 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`. + +You can now use iTools commands in your terminal: + +``` +$> 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) + +``` +**Optional**: 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, go to the [documentation page of the configuration](). + +## Installation from sources + + From b6b26d88101c698e729ed86b76f12c2e482bf493 Mon Sep 17 00:00:00 2001 From: Sophie Frasnedo Date: Thu, 29 Aug 2024 15:45:00 +0200 Subject: [PATCH 3/6] Fix getting started Signed-off-by: Sophie Frasnedo --- docs/gettingstarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gettingstarted.md b/docs/gettingstarted.md index 4c125d6..75b89cb 100644 --- a/docs/gettingstarted.md +++ b/docs/gettingstarted.md @@ -12,4 +12,4 @@ Check our [Java tutorials](https://github.com/powsybl/powsybl-tutorials) 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.md). +Find information on Itools commands and how to use PowSyBl distribution [here](itools/index.md). From f58767942cf0687f8569c97170c327da5aca44d7 Mon Sep 17 00:00:00 2001 From: Sophie Frasnedo Date: Thu, 29 Aug 2024 16:00:08 +0200 Subject: [PATCH 4/6] Complete installation documentation Signed-off-by: Sophie Frasnedo --- docs/itools/installation.md | 46 ++++++++++++++++++++++++++++++------- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/docs/itools/installation.md b/docs/itools/installation.md index 854a2eb..8a94748 100644 --- a/docs/itools/installation.md +++ b/docs/itools/installation.md @@ -4,12 +4,41 @@ Follow these simple steps to get familiar with the PowSyBl environment. Below ar Please note that this PowSyBl distribution is functional on Windows and Linux but is not supported for MacOS yet. -## Installation from binaries +## 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`. -You can now use iTools commands in your terminal: +### 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 @@ -36,15 +65,16 @@ Script: run-script run script (only groovy is supported) ``` -**Optional**: You can set a default configuration by copying the provided configuration file in the `.itools` repository + +## 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, go to the [documentation page of the configuration](). - -## Installation from sources - +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](). From 40412ba3364ccfbc811d795a9de2fc4d51e5c023 Mon Sep 17 00:00:00 2001 From: Sophie Frasnedo Date: Thu, 29 Aug 2024 16:01:16 +0200 Subject: [PATCH 5/6] Fix missing capital letters Signed-off-by: Sophie Frasnedo --- docs/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 506c902..dc77fb6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -38,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)
@@ -67,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) From 399d059263541d8a1eded7ed7d1a41f23b7e8e17 Mon Sep 17 00:00:00 2001 From: Sophie Frasnedo Date: Mon, 2 Sep 2024 13:11:09 +0200 Subject: [PATCH 6/6] Fix incomplete sentence in getting started Signed-off-by: Sophie Frasnedo --- docs/gettingstarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gettingstarted.md b/docs/gettingstarted.md index 75b89cb..03b5590 100644 --- a/docs/gettingstarted.md +++ b/docs/gettingstarted.md @@ -1,6 +1,6 @@ # Getting started -Beside the functional documentation +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)!