From 1e641a40c3a51f81fe30ddbe540b1cdc6d32a09e Mon Sep 17 00:00:00 2001 From: BeneharoRB Date: Tue, 23 Apr 2024 10:36:46 +0200 Subject: [PATCH] Index update --- docs/index.md | 65 ---------------------------------------------- docs/index.rst | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+), 65 deletions(-) delete mode 100644 docs/index.md create mode 100644 docs/index.rst diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index a969a01..0000000 --- a/docs/index.md +++ /dev/null @@ -1,65 +0,0 @@ -## Install package - -pylovo is developed as a Python package and can be installed with -`pip`, ideally by using a [virtual environment]. Required Python dependencies are installed in the background. Open up a -terminal, clone and install pylovo with: - -``` sh -git clone git@gitlab.lrz.de:tum-ens/pylovo.git -``` - -Install the package with pip editable from local repository, developer option installs additional packages: - -=== "User" - - ``` sh - cd pylovo - pip install -e . - ``` - -=== "Developer" - - ``` sh - cd pylovo - pip install -e .[dev] - ``` - ---- -_Rest to delete?_ - -### Software preparation - -The main script runs in Python, in addition you would need, unless you connect to a already constructed pylovo database: - -1. [PostgreSQL]: the default database management system -2. [PostGIS]: extension for PostgreSQL -3. [pgRouting]: extension for PostgreSQL - -[//]: # (5. The branch result_analysis presents the plot_result.py where according to pandapower result from step 3, the grid generation result will be analysed to multiple perspectives including:) - -[//]: # () - -[//]: # ( * some general overviews of total numbers of transformers, loads, cable length, etc.;) - -[//]: # ( * numerical statistics of each size of transformers;) - -[//]: # ( * spatial distribution of transformers;) - -[//]: # ( * load estimation of household; ) - -[//]: # ( * spatial detialed picture of a single distribution grid (picked by random index);) - -[//]: # () - -[//]: # (users can by commenting or uncommenting corresponding codes in plot_result.py to select the required plots.) - - -[virtual environment]: https://realpython.com/what-is-pip/#using-pip-in-a-python-virtual-environment - -[PostgreSQL]: https://www.postgresql.org/ - -[PostGIS]: https://postgis.net/install/ - -[pgRouting]: https://pgrouting.org/ - -[osm2po]: https://osm2po.de/ \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..b7cb89c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,70 @@ +.. pylovo gui documentation master file, created by sphinx-quickstart on Wed Jul 12 12:49:48 2023 + +pylovo +****************************************************************** +python tool for low-voltage distribution grid generation +=========================================================== +This tool provides a comprehensive public-data-based module to generate synthetic low-voltage distribution grids for a +freely-selected research area. The main data input is the buildings, roads and transformers geographic data that are obtained +from OpenStreetMap, with additional auxiliary datasets including postal code area polygons (to identify and select +research areas), consumer categories (to estimate loading performances of different types of buildings and households) +and infrastructure parameters, etc. The result outputs a feasible solution of aggregated distribution grid networks +within the research scope and automatically analyses the important grid statistics to enable the user to evaluate the +general grid properties for the generated synthetic grids. + +At the current state of the project the data is prepared for Bavaria, but will be extended to Germany. +Due to the large amount of data, external users need to setup a local posgresql database for the grid generation process. +All the geographic data during the process is presented in PostGIS Geometry format where a Spatial Reference System +should be defined to recognize the exact positions. For the Spatial Reference System by default, the SRID is selected as epsg:3035 since here the +basic unit of geographic analysis is meter. When transforming to pandapower network, the geodata should be presented +as lon/lat coordination which is epsg:4326 (automatically done in script), be careful of the two different reference +system settings; + +A comprehensive documentation can be found under https://pylovo.readthedocs.io/en/latest/ +A step by step tutorial to understand the product of this tool in jupyter notebooks can be found under examples. + +In this documentation you can find instructions and information on: + + +* how to install pylovo in :doc:`docs_pylovo/installation`. +* how to generate grids in :doc:`grid_generation`. + +.. image:: images/grid_generation/grid_generation_part_forchheim.png + :width: 300 + :alt: Default view + + +* how the grids are generated in :doc:`grid_generation/explanation/grid_generation_process`. +* how to create grid classes and representative grids in :doc:`classification/index`. + +.. image:: images/classification/classification_3grids.png + :width: 600 + :alt: Default view + + +* how to visualise your results in :doc:`visualisation/index`. + +.. image:: images/visualisation/contextily.png + :width: 300 + :alt: Default view + +Contents +=============== + +.. toctree:: + :maxdepth: 2 + + docs_pylovo/installation + grid_generation/index + classification/index + visualisation/index + docs_sphinx/index + +Legal Notice +========================== +`MIT License `_ , Copyright (C) 2023-2024 Beneharo Reveron Baecker + +Acknowledgement +========================== +The development of this software has been supported by contributions of the following persons: Soner Candas, Deniz Tepe, +Tong Ye, Daniel Baur, Julian Zimmer and Berkay Olgun. \ No newline at end of file