read me with the installation proedure

Signed-off-by: Edoardo De Din <ededin@eonerc.rwth-aachen.de>
sede-open · Jun 27, 2022 · 68ff696 · 68ff696
1 parent e07a399
commit 68ff696
Show file tree

Hide file tree

Showing 55 changed files with 66 additions and 49 deletions.
diff --git a/.gitignore b/.gitignore
@@ -20,6 +20,8 @@ csv_files/plots/
 powerflow/powerflow
 venv_ext
 covee_env
+dist
+build
 *.csv
 *.eps
 *.png

diff --git a/Dockerfile b/Dockerfile
@@ -7,5 +7,3 @@ RUN apt-get update -y \
     && apt install python3-pip -y  \
     && apt-get install python3-venv -y \
     && apt-get install sudo -y 
-
-COPY ../conf.json tmp/
diff --git a/Makefile b/Makefile
@@ -1,11 +1,14 @@
 SHELL := /bin/bash
 
 init:
-	python3 ./setup/createEnv.py -y
+	python3 ./create_env/createEnv.py -y
 	source covee_env/bin/activate -y && \
-	pip install --upgrade pip && \
-	pip install -r ./setup/requirements.txt
+	pip install --upgrade pip
+	pip install .
 clean:
 	sudo rm -R -f covee_env
 	rm -R -f __pycache__
-	rm -R -f covee_env.egg-info
+	rm -R -f covee_env.egg-info
+	rm -R -f covee.egg-info
+	rm -R -f dist
+	rm -R -f build
diff --git a/README.md b/README.md
@@ -1,7 +1,33 @@
 # CoVee
 
-CoVee is a Python package implementing several voltage control methods.
+CoVee is a Python package that can be used to implement and test several voltage control methods.
+
+## Installation
+
+### User 
+
+Install the covee package with
+
+    $ python setup.py install
+
+### Virtual Environment (only for Linux)
+
+Create a virtual environment and install the covee package with
+
+    $ make init
+
+### Docker version with docker-compose
+
+    $ sudo docker-compose up
+    $ sudo docker exec -it (CONTAINER) bash
+    $ cd covee
+    $ make init
+    $ covee_env/bin/python3 covee_main.py
+
 
 ## License
 
-The project is released under the terms of the [MPL 2.0](https://mozilla.org/MPL/2.0/).
+The project is released under the terms of the [MPL 2.0](https://mozilla.org/MPL/2.0/).
+
+## Getting Started
+
diff --git a/cases/__init__.py → covee/__init__.py b/cases/__init__.py → covee/__init__.py
diff --git a/cases/LV_SOGNO_virtual_nodes.py → covee/cases/LV_SOGNO_virtual_nodes.py b/cases/LV_SOGNO_virtual_nodes.py → covee/cases/LV_SOGNO_virtual_nodes.py
diff --git a/control_strategies/__init__.py → covee/cases/__init__.py b/control_strategies/__init__.py → covee/cases/__init__.py
diff --git a/cases/case14.py → covee/cases/case14.py b/cases/case14.py → covee/cases/case14.py
diff --git a/cases/case30.py → covee/cases/case30.py b/cases/case30.py → covee/cases/case30.py
diff --git a/cases/case_10_nodes.py → covee/cases/case_10_nodes.py b/cases/case_10_nodes.py → covee/cases/case_10_nodes.py
diff --git a/cases/case_MV.py → covee/cases/case_MV.py b/cases/case_MV.py → covee/cases/case_MV.py
diff --git a/cases/case_cigre.py → covee/cases/case_cigre.py b/cases/case_cigre.py → covee/cases/case_cigre.py
diff --git a/cases/ieee124_2compensators.py → covee/cases/ieee124_2compensators.py b/cases/ieee124_2compensators.py → covee/cases/ieee124_2compensators.py
diff --git a/...es/Quadratic_Control_Centralized_CVXPY.py → ...es/Quadratic_Control_Centralized_CVXPY.py b/...es/Quadratic_Control_Centralized_CVXPY.py → ...es/Quadratic_Control_Centralized_CVXPY.py
@@ -6,7 +6,7 @@
 from scipy import sparse
 import coloredlogs, logging, threading
 
-import control_strategies.quadratic_control_cvxpy as quadratic_control
+import covee.control_strategies.quadratic_control_cvxpy as quadratic_control
 
 class Quadratic_Control():
 

diff --git a/...adratic_Control_Centralized_DualAscent.py → ...adratic_Control_Centralized_DualAscent.py b/...adratic_Control_Centralized_DualAscent.py → ...adratic_Control_Centralized_DualAscent.py
@@ -1,4 +1,4 @@
-import control_strategies.quadratic_control_dualascent as quadratic_control
+import covee.control_strategies.quadratic_control_dualascent as quadratic_control
 import numpy as np
 
 class Quadratic_Control():

diff --git a/...control_dualascent/algorithms/__init__.py → covee/control_strategies/__init__.py b/...control_dualascent/algorithms/__init__.py → covee/control_strategies/__init__.py
diff --git a/...eprecated/MPC_Control_Centralized_OSQP.py → ...eprecated/MPC_Control_Centralized_OSQP.py b/...eprecated/MPC_Control_Centralized_OSQP.py → ...eprecated/MPC_Control_Centralized_OSQP.py
diff --git a/...ted/Quadratic_Control_Centralized_OSQP.py → ...ted/Quadratic_Control_Centralized_OSQP.py b/...ted/Quadratic_Control_Centralized_OSQP.py → ...ted/Quadratic_Control_Centralized_OSQP.py
diff --git a/...ated/model_predictive_control/__init__.py → ...ated/model_predictive_control/__init__.py b/...ated/model_predictive_control/__init__.py → ...ated/model_predictive_control/__init__.py
diff --git a/...ed/model_predictive_control/additional.py → ...ed/model_predictive_control/additional.py b/...ed/model_predictive_control/additional.py → ...ed/model_predictive_control/additional.py
diff --git a/...d/model_predictive_control/matrix_calc.py → ...d/model_predictive_control/matrix_calc.py b/...d/model_predictive_control/matrix_calc.py → ...d/model_predictive_control/matrix_calc.py
diff --git a/...egies/quadratic_control_cvxpy/__init__.py → ...egies/quadratic_control_cvxpy/__init__.py b/...egies/quadratic_control_cvxpy/__init__.py → ...egies/quadratic_control_cvxpy/__init__.py
diff --git a/...ies/quadratic_control_cvxpy/additional.py → ...ies/quadratic_control_cvxpy/additional.py b/...ies/quadratic_control_cvxpy/additional.py → ...ies/quadratic_control_cvxpy/additional.py
diff --git a/...es/quadratic_control_cvxpy/matrix_calc.py → ...es/quadratic_control_cvxpy/matrix_calc.py b/...es/quadratic_control_cvxpy/matrix_calc.py → ...es/quadratic_control_cvxpy/matrix_calc.py
diff --git a/...dualascent/Quadratic_Active_Power_Batt.py → ...dualascent/Quadratic_Active_Power_Batt.py b/...dualascent/Quadratic_Active_Power_Batt.py → ...dualascent/Quadratic_Active_Power_Batt.py
diff --git a/...l_dualascent/Quadratic_Active_Power_PV.py → ...l_dualascent/Quadratic_Active_Power_PV.py b/...l_dualascent/Quadratic_Active_Power_PV.py → ...l_dualascent/Quadratic_Active_Power_PV.py
diff --git a/...ol_dualascent/Quadratic_Reactive_Power.py → ...ol_dualascent/Quadratic_Reactive_Power.py b/...ol_dualascent/Quadratic_Reactive_Power.py → ...ol_dualascent/Quadratic_Reactive_Power.py
diff --git a/.../quadratic_control_dualascent/__init__.py → .../quadratic_control_dualascent/__init__.py b/.../quadratic_control_dualascent/__init__.py → .../quadratic_control_dualascent/__init__.py
diff --git a/csv_files/__init__.py → ...control_dualascent/algorithms/__init__.py b/csv_files/__init__.py → ...control_dualascent/algorithms/__init__.py
diff --git a/...ntrol_dualascent/algorithms/algorithms.py → ...ntrol_dualascent/algorithms/algorithms.py b/...ntrol_dualascent/algorithms/algorithms.py → ...ntrol_dualascent/algorithms/algorithms.py
diff --git a/...gorithms/algorithms_controllable_loads.py → ...gorithms/algorithms_controllable_loads.py b/...gorithms/algorithms_controllable_loads.py → ...gorithms/algorithms_controllable_loads.py
diff --git a/...ntrol_dualascent/iteration_calculation.py → ...ntrol_dualascent/iteration_calculation.py b/...ntrol_dualascent/iteration_calculation.py → ...ntrol_dualascent/iteration_calculation.py
diff --git a/control_strategies/utils/__init__.py → covee/control_strategies/utils/__init__.py b/control_strategies/utils/__init__.py → covee/control_strategies/utils/__init__.py
diff --git a/control_strategies/utils/additional.py → covee/control_strategies/utils/additional.py b/control_strategies/utils/additional.py → covee/control_strategies/utils/additional.py
diff --git a/control_strategies/utils/select.py → covee/control_strategies/utils/select.py b/control_strategies/utils/select.py → covee/control_strategies/utils/select.py
@@ -13,7 +13,7 @@ def __init__(self, conf_dict):
 
     def select_control(self):
 
-        self.control_module = 'control_strategies.'+self.conf_dict["CONTROL_MODULE"]
+        self.control_module = 'covee.control_strategies.'+self.conf_dict["CONTROL_MODULE"]
         try: 
             module = import_module(self.control_module)
         except:
@@ -24,7 +24,7 @@ def select_control(self):
 
     def select_case(self):
 
-        self.case_module = 'cases.'+self.conf_dict["CASE_MODULE"]
+        self.case_module = 'covee.cases.'+self.conf_dict["CASE_MODULE"]
         try: 
             module = import_module(self.case_module)
         except:

diff --git a/powerflow/__init__.py → covee/csv_files/__init__.py b/powerflow/__init__.py → covee/csv_files/__init__.py
diff --git a/csv_files/save_results.py → covee/csv_files/save_results.py b/csv_files/save_results.py → covee/csv_files/save_results.py
diff --git a/covee_main_communication.py → covee/deprecated/covee_main_communication.py b/covee_main_communication.py → covee/deprecated/covee_main_communication.py
diff --git a/powerflow/powerflow_class/__init__.py → covee/powerflow/__init__.py b/powerflow/powerflow_class/__init__.py → covee/powerflow/__init__.py
diff --git a/...low/powerflow_class/csv_files/__init__.py → covee/powerflow/csv_files/__init__.py b/...low/powerflow_class/csv_files/__init__.py → covee/powerflow/csv_files/__init__.py
diff --git a/...owerflow_class/csv_files/read_profiles.py → covee/powerflow/csv_files/read_profiles.py b/...owerflow_class/csv_files/read_profiles.py → covee/powerflow/csv_files/read_profiles.py
@@ -41,9 +41,9 @@ def read_csv(self):
             # =============================================================
 
             cwd = os.getcwd()
-            wd = os.path.join(cwd, 'powerflow/powerflow_class/data/profiles/Test')
+            wd = os.path.join(cwd, 'covee/powerflow/data/profiles/Test')
             wd.replace("\\", "/")
-            wd1 = os.path.join(cwd, 'powerflow/powerflow_class/csv_files/profiles')
+            wd1 = os.path.join(cwd, 'covee/powerflow/csv_files/profiles')
             wd1.replace("\\", "/")        
             k = 1
             for key in profiles:

diff --git a/powerflow/powerflow_class/data/README.md → covee/powerflow/data/README.md b/powerflow/powerflow_class/data/README.md → covee/powerflow/data/README.md
diff --git a/...powerflow_class/data/profiles/__init__.py → covee/powerflow/data/profiles/__init__.py b/...powerflow_class/data/profiles/__init__.py → covee/powerflow/data/profiles/__init__.py
diff --git a/...ow_class/data/profiles/modify_profiles.py → ...owerflow/data/profiles/modify_profiles.py b/...ow_class/data/profiles/modify_profiles.py → ...owerflow/data/profiles/modify_profiles.py
@@ -3,7 +3,7 @@
 import os
 
 cwd = os.getcwd()
-wd = os.path.join(cwd, 'covee/powerflow/powerflow_class/data/profiles')
+wd = os.path.join(cwd, 'covee/powerflow/data/profiles')
 
 csv_file = '/Test/PV_profile.csv'
 profile = wd + csv_file

diff --git a/...profiles/simple_test_profiles/__init__.py → ...profiles/simple_test_profiles/__init__.py b/...profiles/simple_test_profiles/__init__.py → ...profiles/simple_test_profiles/__init__.py
diff --git a/powerflow/powerflow_class/runPF_class.py → covee/powerflow/runPF_class.py b/powerflow/powerflow_class/runPF_class.py → covee/powerflow/runPF_class.py
@@ -5,15 +5,15 @@
 from pypower.idx_gen import GEN_BUS, PG, QG, PMAX, PMIN, QMAX, QMIN, VG, GEN_STATUS
 from pypower.int2ext import int2ext
 
-from powerflow.powerflow_class.csv_files.read_profiles import read_profiles
+from covee.powerflow.csv_files.read_profiles import read_profiles
 
 from scipy.sparse import issparse, vstack, hstack, csr_matrix as sparse
 from numpy import flatnonzero as find
 
 import numpy as np
 from pypower.ppoption import ppoption
 
-from powerflow.powerflow_class.csv_files.read_profiles import read_profiles
+from covee.powerflow.csv_files.read_profiles import read_profiles
 
 
 

diff --git a/covee_main.py b/covee_main.py
@@ -3,13 +3,14 @@
 import coloredlogs, logging, threading
 import time
 import json
-from pypower.api import *
-from pypower.ext2int import ext2int
-import control_strategies.utils as utils
 from importlib import import_module
-from powerflow.powerflow_class.runPF_class import runPF_class
-from csv_files.save_results import save_results
 from alive_progress import alive_bar
+from pypower.api import *
+from pypower.ext2int import ext2int
+import covee.control_strategies.utils as utils
+from covee.powerflow.runPF_class import runPF_class
+from covee.csv_files.save_results import save_results
+
 
 '''
 coloredlogs.install(level='DEBUG',
@@ -25,7 +26,7 @@
 
 # Read json file and set Control Strategy and Case 
 # =====================================================================================================
-with open("./conf.json", "r") as f:
+with open("./examples/conf.json", "r") as f:
     conf_dict = json.load(f)
 
 module_obj = utils.select(conf_dict)

diff --git a/setup/createEnv.py → create_env/createEnv.py b/setup/createEnv.py → create_env/createEnv.py
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -5,19 +5,9 @@ services:
     build:
       context: '.'
       dockerfile: './Dockerfile'
-    networks: 
-      - edgeflex-network
     volumes:
-      - .:/centralized
-    command: bash -c "cd centralized && 
-                      make init &&
-                      cd .. &&
-                      /covee/covee/bin/python3 /covee/Control_main.py --ext_port 7071"
-    # command:          tail -F dfsdfödslk
+      - ./:/covee
+    stdin_open: true
+    # command: tail -F dgrthetyj
     ports:
-      - 7071:8000
-
-networks:
-  edgeflex-network:
-    external:
-      name: edgeflex-network
+      - 7071:8000
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,6 @@
+# CoVee - Getting Started
+
+
+
+
+
diff --git a/examples/__init__.py b/examples/__init__.py
diff --git a/conf.json → examples/conf.json b/conf.json → examples/conf.json
@@ -27,6 +27,6 @@
 
     "STATE_ESTIMATION": "no", "__comment__": "with yes, the control algorithm considers the full set of voltage nodes, as if the state estimation would be integrated / Not implemented yet" ,
 
-    "SAVE_PATH" : "csv_files/results",
-    "PLOT_PATH": "csv_files/plots"
+    "SAVE_PATH" : "covee/csv_files/results",
+    "PLOT_PATH": "covee/csv_files/plots"
 }
diff --git a/setup/setup.py → setup.py b/setup/setup.py → setup.py
@@ -15,7 +15,7 @@
 ],
 
 setup(
-    name="covee control",
+    name="covee",
     version="0.1",
     author="Edoardo De Din",
     author_email="acs-software@eonerc.rwth-aachen.de",

diff --git a/setup/requirements.txt b/setup/requirements.txt
diff --git a/setup/requirements_docker.txt b/setup/requirements_docker.txt
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,6 +20,8 @@ csv_files/plots/ @@
     powerflow/powerflow
     venv_ext
     covee_env
+    dist
+    build
     *.csv
     *.eps
     *.png
@@ Expand Down @@