Repository navigation
Doc overview - #140
Doc overview#140alicecaron wants to merge 4 commits into
Conversation
Signed-off-by: CARON Alice <alice.caron@rte-france.com>
08424f9 to
cf52a24
Compare
|
Another probably stupid question: is it easy to modify the SVG, for example to modify the text inside a box? |
|
@nicow-elia, do you think the schemas could complement C4 or is it basically the same thing? Same question goes for C4 schemas: is it easy to modify them? |
Yes you can easily, by installing for instance the drawio client from here https://github.com/jgraph/drawio-desktop/releases/tag/v31.1.8 and then you can import the svg, modify it and export to a new svg |
Signed-off-by: CARON Alice <alice.caron@rte-france.com>
Signed-off-by: CARON Alice <alice.caron@rte-france.com>
So-Fras
left a comment
There was a problem hiding this comment.
Thank you for the huge effort!
I left some comments, to be discussed.
There was a problem hiding this comment.
I would put the "short circuit simulation" part in front of the "Simulation APIs" box too because we have an API for short-circuit simulations.
There was a problem hiding this comment.
powsybl-network-diagram --> powsybl-network-viewer
The powsybl-network-viewer repository does not provide map view only. It is where you can find all the interactivity with the diagrams:
- The moving of the nodes
- The callback mechanism when hovering
- ...
|
|
||
| ``` | ||
|
|
||
| Powsybl is a framework for power system modeling, simulations and visualization. It supports a wide range of power system models and simulation methods. The code is divided into several repositories, the goal is to be as modulable as possible. |
There was a problem hiding this comment.
| Powsybl is a framework for power system modeling, simulations and visualization. It supports a wide range of power system models and simulation methods. The code is divided into several repositories, the goal is to be as modulable as possible. | |
| Powsybl is a framework for power system modeling, simulations and visualization. It supports a wide range of power system models and simulation methods. Its codebase is organized into multiple repositories to promote modularity, flexibility, and maintainability. |
| - 🚂 **powsybl-core**: grid model, exchange formats, simulation APIs | ||
| - [Documentation](https://powsybl.readthedocs.io/projects/powsybl-core) | ||
| - [GitHub repository](https://github.com/powsybl/powsybl-core) | ||
| Here is the overview of how it is functionally organized: |
There was a problem hiding this comment.
| Here is the overview of how it is functionally organized: | |
| "Below is an overview of the functional structure." |
There was a problem hiding this comment.
There are repositories missing like powsybl-metrix and powsybl-open-sc, powsybl-optimizer, powsybl-open-loadflow-gpu with the other simulation tools.
For visualization, there are also powsybl-network-viewer, pypowsybl-jupyter and powsybl-dev-tools.
Then you also have what we call the "advanced" features: hpc, afs
And the bindings (Python, Julia)
And the servers + network store (let's see if we keep them first)
And a lot of other repositories for very different purposes
Should we be exhaustive here regarding the 48 repositories? If this is an overview, maybe we can be exhaustive here for the repositories and keep the powsybl-core maven modules and the powsybl-core detailed schema for another schema that we use for the powsybl-core part.
|
|
||
|  | ||
|
|
||
| The main repository is [powsybl-core](https://github.com/powsybl/powsybl-core). |
There was a problem hiding this comment.
I think that this part should go under the "Core features" section, without the simulation and visualization parts.
|
|
||
| | Documentation | Github | Description | | ||
| |----------------------------------------------------------------------------------|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | [Documentation](https://powsybl.readthedocs.io/projects/powsybl-open-loadflow) | [powsybl-open-loadflow](https://github.com/powsybl/powsybl-open-loadflow) | Loadflow, security analysis and sensitivity analysis | |
There was a problem hiding this comment.
I would still separate Simulation APIs and simulators, it seems to me that it is clearer.
Sometimes, we have the API but not the simulator, sometimes it's the opposite, sometimes, we have both...
|
|
||
| | Documentation | Github | Description | | ||
| |---------------------------------------------------------------------------|----------------------------------------------------------------|----------------------------------------------| | ||
| | [Documentation](https://powsybl.readthedocs.io/projects/powsybl-diagram) | [powsybl-diagram](https://github.com/powsybl/powsybl-diagram) | network-area diagrams, single-line diagrams | |
There was a problem hiding this comment.
We should add powsybl-network-viewer here too!
|
|
||
| <br/> | ||
|
|
||
| A visualization repository is available, using the IIDM network modelisation of powsybl-core. It mainly generates SVG for detailed voltage level and area diagrams: |
There was a problem hiding this comment.
| A visualization repository is available, using the IIDM network modelisation of powsybl-core. It mainly generates SVG for detailed voltage level and area diagrams: | |
| A visualization repository is available, using the IIDM network modelisation of powsybl-core. It mainly generates SVG for single-line diagrams and network-area diagrams: |
Signed-off-by: CARON Alice <alice.caron@rte-france.com>
3bf7372 to
db40f9d
Compare
Please check if the PR fulfills these requirements
Does this PR already have an issue describing the problem?
No
What kind of change does this PR introduce?
New schemes in the documentation for Powsybl overview explanations.