Merge branch 'release/v0.4.0'

Author: stroitzsch

.github/workflows/documentation.yml

@@ -0,0 +1,34 @@
+name: Documentation
+
+on: [push]
+
+jobs:
+  build-documentation:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+    - name: Fetch all repository branches and tags
+      run: |
+        git fetch --prune --unshallow
+    - name: Set up Python
+      uses: s-weigand/setup-conda@v1
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: |
+        conda install sphinx
+        pip install -r docs/requirements.txt
+    - name: Build documentation HTML with Sphinx
+      run: |
+        sphinx-multiversion docs docs/_build/html
+        cp docs/assets/gh-pages_index.html docs/_build/html/index.html
+        find docs/_build/html -type f -name "*.html" -exec sed -i 's/<li><p>\(.*\)<\/p>\(.*\)/<li>\1\2/g' {} +
+    - name: Deploy documentation HTML to Github Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_build/html/
+        keep_files: false

.github/workflows/pythontests.yml

@@ -3,13 +3,17 @@ name: Python tests
 on: [push]
 
 jobs:
-  build:
+  run-tests:
 
     runs-on: ${{ matrix.os }}
     strategy:
       max-parallel: 8
       matrix:
-        os: [windows-latest, macos-latest, ubuntu-latest]
+        os: [
+          windows-latest,
+          # macos-latest,
+          ubuntu-latest
+        ]
         python-version: [3.7]
 
     steps:
@@ -22,20 +26,18 @@ jobs:
         git submodule sync --recursive
         git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: s-weigand/setup-conda@v1
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install -e .
-        pip install -e cobmo
+        pip install -v -e .
     - name: Lint with flake8
       run: |
         pip install flake8
-        # stop the build if there are Python syntax errors or undefined names
+        # Stop the build if there are Python syntax errors or undefined names.
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. Line lengths should not exceed 120 characters.
+        # Exit-zero treats all errors as warnings. Line lengths should not exceed 120 characters.
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=120 --statistics
     - name: Test with pytest
       run: |

.gitignore

@@ -1,22 +1,30 @@
 
-\.idea/
+.idea
 
-\.vscode/
+.vscode
 
-*.egg-info/
+.spyproject
 
-*/__pycache__/
+*.egg-info
+
+*__pycache__
 
 *.pyc
 
-\.pytest_cache/
+.pytest_cache
+
+cache/
 
 *.sqlite
 
+*.sqlite-journal
+
 *.DS_Store
 
 docs/_build/
 
 results/*
 
 !results/README\.md
+
+config.yml

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 TUMCREATE <https://tum-create.edu.sg/>
+Copyright (c) 2018-2020 TUMCREATE <https://tum-create.edu.sg/>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,6 +4,10 @@
 
 The Flexible Distribution Grid Demonstrator (FLEDGE) is a software tool for optimal operation problems of electric and thermal distribution grids along with distributed energy resources (DERs), such as flexible building loads, electric vehicle (EV) chargers, distributed generators (DGs) and energy storage systems (ESS). To this end, it implements 1) electric grid models, 2) thermal grid models, 3) DER models, and 4) optimal operation problems.
 
+## Work in progress
+
+Please note that the repository is under active development and the interface may change without notice. Create an [issue](https://github.com/TUMCREATE-ESTL/fledge/issues) if you have ideas / comments / criticism that may help to make the tool more useful.
+
 ## Features
 
 - Electric grid models:
@@ -20,37 +24,37 @@ The Flexible Distribution Grid Demonstrator (FLEDGE) is a software tool for opti
     - Time series models for EV charging.
     - Linear models for flexible building loads.
 - Optimal operation problems:
-    - Obtain numerical optimization problem for combined optimal operation for electric / thermal grids with DERs via [Pyomo](https://github.com/Pyomo/pyomo).
+    - Obtain numerical optimization problem for combined optimal operation for electric / thermal grids with DERs.
     - Obtain electric / thermal optimal power flow solution.
     - Obtain distribution locational marginal prices (DLMPs) for the electric / thermal grids.
 
-## Work in Progress
-
-Please note that the repository is under active development and the interface may change without notice. Create an [issue](https://github.com/TUMCREATE-ESTL/fledge/issues) if you have ideas / comments / criticism that may help to make the tool more useful.
-
 ## Documentation
 
-The preliminary documentation is located at [fledge.readthedocs.io](https://fledge.readthedocs.io/).
+The preliminary documentation is located at [tumcreate-estl.github.io/fledge](https://tumcreate-estl.github.io/fledge).
 
 ## Installation
 
 1. Check requirements:
     - Python 3.7
     - [Gurobi Optimizer](http://www.gurobi.com/)
-2. Clone or download repository.
+2. Clone or download repository. Ensure that the `cobmo` submodule directory is loaded as well.
 3. In your Python environment, run:
-    1. `pip install -e path_to_repository`
-    2. `pip install -e path_to_repository/cobmo`
+    1. `pip install -v -e path_to_repository`
 
-Please also read [docs/intro.md](./docs/intro.md).
+Please also read [docs/getting_started.md](./docs/getting_started.md).
 
 ## Contributing
 
 If you are keen to contribute to this project, please see [docs/contributing.md](./docs/contributing.md).
 
+## Publications
+
+Information on citing FLEDGE and a list of related publications is available at [docs/publications.md](docs/publications.md).
+
 ## Acknowledgements
 
-- Sebastian Troitzsch implemented the initial version of FLEDGE and maintains this repository.
-- Sarmad Hanif and Kai Zhang developed the underlying electric grid modelling and approximation methodologies.
-- Mischa Grussmann developed the thermal grid modelling and aproximation methodologies.
 - This work was financially supported by the Singapore National Research Foundation under its Campus for Research Excellence And Technological Enterprise (CREATE) programme.
+- Sebastian Troitzsch implemented the initial version of FLEDGE and maintains this repository.
+- Sarmad Hanif and Kai Zhang developed the underlying electric grid modelling, fixed-point power flow solution and electric grid approximation methodologies.
+- Arif Ahmed implemented the implicit Z-bus power flow solution method.
+- Mischa Grussmann developed the thermal grid modelling and approximation methodologies.

cobmo

@@ -0,0 +1,23 @@
+building_name,weather_type,plant_cooling_type,plant_heating_type,storage_type
+tanjongpagar_building_1,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_2,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_3,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_4,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_5,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_6,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_7,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_8,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_9,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_10,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_11,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_12,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_13,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_14,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_15,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_16,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_17,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_18,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_19,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_20,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_21,singapore_iwec,cea_plant_cooling,cea_plant_heating,
+tanjongpagar_building_22,singapore_iwec,cea_plant_cooling,cea_plant_heating,

data/cobmo/singapore_tanjongpagar/buildings.csv

@@ -0,0 +1,23 @@
+scenario_name,building_name,parameter_set,linearization_type,initial_state_type,price_type,timestep_start,timestep_end,timestep_interval
+tanjongpagar_building_1,tanjongpagar_building_1,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_2,tanjongpagar_building_2,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_3,tanjongpagar_building_3,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_4,tanjongpagar_building_4,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_5,tanjongpagar_building_5,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_6,tanjongpagar_building_6,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_7,tanjongpagar_building_7,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_8,tanjongpagar_building_8,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_9,tanjongpagar_building_9,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_10,tanjongpagar_building_10,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_11,tanjongpagar_building_11,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_12,tanjongpagar_building_12,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_13,tanjongpagar_building_13,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_14,tanjongpagar_building_14,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_15,tanjongpagar_building_15,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_16,tanjongpagar_building_16,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_17,tanjongpagar_building_17,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_18,tanjongpagar_building_18,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_19,tanjongpagar_building_19,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_20,tanjongpagar_building_20,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_21,tanjongpagar_building_21,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00
+tanjongpagar_building_22,tanjongpagar_building_22,,create_linearization,cea_initial_state,,2017-01-02T00:00:00,2017-01-03T00:00:00,00:30:00

data/cobmo/singapore_tanjongpagar/scenarios.csv

@@ -0,0 +1,3 @@
+surface_type,heat_capacity,heat_transfer_coefficient_conduction_surface,absorptivity_surface,emissivity_surface,window_type,window_wall_ratio,sky_view_factor
+tanjongpagar_wall,0.0,786.269,0.6,0.95,tanjongpagar_window,0.29,0.5
+tanjongpagar_roof,0.0,1.336,0.6,0.94,tanjongpagar_window,0.0,1.0