Add .rst docs

.gitignore

@@ -10,10 +10,6 @@ executable_scripts/results
 site/
 syngrid/config_version.py
 examples/.ipynb_checkpoints/
-docs/source/images/dev/sequence/pylovo_sequence_postcode_id.clip
-docs/source/images/dev/sequence/pylovo_sequence_network.clip
-docs/build/*
-docs/meta/*
 # for macOS users
 *.DS_Store
 # when setup.py is run

docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 07ec192d67b7422021a329a651b65bc9
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/autoapi/maptool/config/index.rst.txt

@@ -0,0 +1,39 @@
+:py:mod:`maptool.config`
+========================
+
+.. py:module:: maptool.config
+
+
+Module Contents
+---------------
+
+.. py:data:: URBS_CONDA_ENV_NAME
+   :value: 'urbs310'
+
+
+
+.. py:data:: URBS_RUN_FILE_PATH
+   :value: '../urbs'
+
+
+
+.. py:data:: URBS_RESULT_PLOT_SAVE_PATH
+   :value: 'maptool/urbs_results/plots/'
+
+
+
+.. py:data:: URBS_RESULT_PATH
+   :value: '../urbs/result/'
+
+
+
+.. py:data:: URBS_RESULT_FILENAME
+   :value: 'flex_all_tsam_coordinated_flexible_step1.h5'
+
+
+
+.. py:data:: URBS_RESULT_HDF_LOCATION_PATH
+   :value: '../urbs/result/Trans-Dist-20230613T1603/flex_all_tsam_coordinated_flexible_step1.h5'
+
+
+

docs/build/html/_sources/autoapi/maptool/index.rst.txt

@@ -0,0 +1,51 @@
+:py:mod:`maptool`
+=================
+
+.. py:module:: maptool
+
+
+Subpackages
+-----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+   network_editor/index.rst
+   postcode_editor/index.rst
+   urbs_editor/index.rst
+   urbs_results/index.rst
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   config/index.rst
+
+
+Package Contents
+----------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   maptool.create_app
+
+
+
+.. py:function:: create_app(test_config=None)
+
+   Flask factory that sets up the application and sets the default webpage template. 
+   It also connects the subpage blueprints to the app
+
+   :param test_config: application config file name, defaults to None
+   :type test_config: string, optional
+   :return: application object reference
+   :rtype: Flask Application Object
+
+

docs/build/html/_sources/autoapi/maptool/network_editor/generateEditableNetwork/index.rst.txt

@@ -0,0 +1,81 @@
+:py:mod:`maptool.network_editor.generateEditableNetwork`
+========================================================
+
+.. py:module:: maptool.network_editor.generateEditableNetwork
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   maptool.network_editor.generateEditableNetwork.extractPropertiesFromNet
+   maptool.network_editor.generateEditableNetwork.createFeatures
+   maptool.network_editor.generateEditableNetwork.extractStdTypes
+   maptool.network_editor.generateEditableNetwork.createGeoJSONofNetwork
+
+
+
+.. py:function:: extractPropertiesFromNet(input)
+
+   helper function creating a properties dict for secondary features (e.g. loads of a bus) to be included in the properties
+   of the final feature geoJSON
+
+   :param input: contains all secondary features of a type for a single primary feature
+   :type input: dict
+   :return: json containing key value pairs of secondary feature properties and their values for every primary feature
+   :rtype: dict
+
+
+.. py:function:: createFeatures(isLines, ppdata, featureName, featureProperties, propertyGroupNames, propertyGroupFeatures)
+
+   creates and returns a geoJSON object for a feature of the original pandapower network
+
+   :param isLines: flag for if the geojson object to create is going to be a line or point object
+   :type isLines: bool
+   :param ppdata: the pandapower network object
+   :type ppdata: dict
+   :param featureName: determines how we handle feature extraction and geojson creation
+   :type featureName: string
+   :param featureProperties: contains the names of all properties for a feature (e.g. bus, line etc)
+   :type featureProperties: list[string]
+   :param propertyGroupNames: only relevant for bus features; contains names of all secondary features we want to add (switch, sgen, load)
+   :type propertyGroupNames: list[string]
+   :param propertyGroupFeatures: only relevant for bus features; contains the names of all properties for a secondary feature
+   :type propertyGroupFeatures: list[list[string]]
+   :return: geoJSON dict containing all features of a single type (bus, line etc) of a network
+   :rtype: dict 
+
+
+.. py:function:: extractStdTypes(ppdata)
+
+   std_types are already saved in a convenient datastructure in the pandapower network, so we just extract them as is
+
+   :return: json string of all std_types grouped by feature (line, trafo)
+   :rtype: string
+
+
+.. py:function:: createGeoJSONofNetwork(net, bus, trafo, line, ext_grid, std_types)
+
+   creates the final json object that contains geoJSON objects for every feature type we want to display on the GUI map
+
+   :param net: the pandapower network
+   :type net: dict
+   :param bus: flag determining whether we want to include buses in the displayable network
+   :type bus: bool
+   :param trafo: flag determining whether we want to include trafos in the displayable network
+   :type trafo: bool
+   :param line: flag determining whether we want to include lines in the displayable network
+   :type line: bool
+   :param ext_grid: flag determining whether we want to include ext_grids in the displayable network
+   :type ext_grid: bool
+   :param std_types: flag determining whether we want to include std_types in the frontend editor
+   :type std_types: bool
+   :return: json object containing geojsons for every feature of the original pdp net we want to display
+   :rtype: dict
+
+

docs/build/html/_sources/autoapi/maptool/network_editor/index.rst.txt

@@ -0,0 +1,24 @@
+:py:mod:`maptool.network_editor`
+================================
+
+.. py:module:: maptool.network_editor
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   generateEditableNetwork/index.rst
+   recreatePandapowerNetwork/index.rst
+   routes/index.rst
+
+
+Package Contents
+----------------
+
+.. py:data:: bp
+
+   
+

docs/build/html/_sources/autoapi/maptool/network_editor/recreatePandapowerNetwork/index.rst.txt

@@ -0,0 +1,41 @@
+:py:mod:`maptool.network_editor.recreatePandapowerNetwork`
+==========================================================
+
+.. py:module:: maptool.network_editor.recreatePandapowerNetwork
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   maptool.network_editor.recreatePandapowerNetwork.createFeatureFromGeoJSONProperties
+   maptool.network_editor.recreatePandapowerNetwork.recreatePandapowerNetwork
+
+
+
+.. py:function:: createFeatureFromGeoJSONProperties(featureProperties, featureListElement)
+
+   creates a dict of key value pairs containing the properties of a feature and their respecive values and makes sure they have the correct type
+
+   :param featureProperties: dict containing names and data types of all properties for a feature type (e.g bus, line etc)
+   :type featureProperties: dict
+   :param featureListElement: dict containing data for a single feature that was returned from the frontend
+   :type featureListElement: dict
+
+
+.. py:function:: recreatePandapowerNetwork(net_features)
+
+   fills in an empty pandapower network one feature at a time by extracting each feature's properties, setting their correct type and 
+   adding it to the network object. 
+
+   :param net_features: json containing the network features extracted and returned from the frontend
+   :type net_features: dict
+   :return: newly created and filled pandapower network
+   :rtype: dict
+
+

docs/build/html/_sources/autoapi/maptool/network_editor/routes/index.rst.txt

@@ -0,0 +1,54 @@
+:py:mod:`maptool.network_editor.routes`
+=======================================
+
+.. py:module:: maptool.network_editor.routes
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   maptool.network_editor.routes.networks
+   maptool.network_editor.routes.networkProperties
+   maptool.network_editor.routes.editableNetwork
+   maptool.network_editor.routes.urbs_results
+
+
+
+.. py:function:: networks()
+
+   once the Select Network button in the postcode view is pressed, we return the editable network view 
+
+   :return: path to the network editor html file
+   :rtype: string
+
+
+.. py:function:: networkProperties()
+
+   on networks window load the frontend fetches the network properties json file as well
+
+   :return: json dict containing the properties of every network feature the user can edit
+   :rtype: dict
+
+
+.. py:function:: editableNetwork()
+
+   on networks window load the frontend fetches a network based on the plz id, kcid and bcid the user selected in the postcode editor.
+
+   :return: json string of the pandapower network the user has requested
+   :rtype: string
+
+
+.. py:function:: urbs_results()
+
+   fetched when the "Finish Editing" button is clicked in the network editor
+
+   :return: response indicating successful data transfer
+   :rtype: JavaScript Fetch API Response
+
+

docs/build/html/_sources/autoapi/maptool/postcode_editor/index.rst.txt

@@ -0,0 +1,22 @@
+:py:mod:`maptool.postcode_editor`
+=================================
+
+.. py:module:: maptool.postcode_editor
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   routes/index.rst
+
+
+Package Contents
+----------------
+
+.. py:data:: bp
+
+   
+