DES-sim 1.0.1__tar.gz

des_sim-1.0.1/LICENSE

@@ -0,0 +1,7 @@
+MIT
+BSD-3-Clause
+MIT AND (Apache-2.0 OR BSD-2-Clause)
+MIT OR GPL-2.0-or-later OR (FSFUL AND BSD-2-Clause)
+GPL-3.0-only WITH Classpath-Exception-2.0 OR BSD-3-Clause
+LicenseRef-Special-License OR CC0-1.0 OR Unlicense
+LicenseRef-Proprietary

des_sim-1.0.1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: DES_sim
+Version: 1.0.1
+Author-email: Leroy Tomas <leroy.tomas@hs-offenburg.de>
+License: MIT
+        BSD-3-Clause
+        MIT AND (Apache-2.0 OR BSD-2-Clause)
+        MIT OR GPL-2.0-or-later OR (FSFUL AND BSD-2-Clause)
+        GPL-3.0-only WITH Classpath-Exception-2.0 OR BSD-3-Clause
+        LicenseRef-Special-License OR CC0-1.0 OR Unlicense
+        LicenseRef-Proprietary
+Keywords: DES,mosaik,simulation,HP,CHP,PV
+Requires-Python: ==3.10.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools<81
+Requires-Dist: mosaik==3.2.0
+Requires-Dist: mosaik-api==3.0.3
+Requires-Dist: mosaik-api-v3==3.0.9
+Requires-Dist: mosaik-heatpump==1.0.1
+Requires-Dist: mosaik-pv==1.2.1
+Requires-Dist: mosaik-pvlib==1.0
+Requires-Dist: mosaik-csv
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: plotly==5.24.1
+Requires-Dist: nest_asyncio
+Requires-Dist: nbformat==5.10.4
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Provides-Extra: opti
+Requires-Dist: ipykernel; extra == "opti"
+Requires-Dist: ipynbname; extra == "opti"
+Requires-Dist: tqdm; extra == "opti"
+Requires-Dist: pyDOE; extra == "opti"
+Provides-Extra: docs
+Requires-Dist: sphinx==7.4.5; extra == "docs"
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "docs"
+Requires-Dist: m2r2==0.3.3.post2; extra == "docs"
+
+# District Energy System(DES)
+
+This project uses the mosaik package to simulate heat pump in conjuction with a CHP unit to meet the heat and electricity demand of a housing district.
+
+## Installation
+
+To get started first create a new conda env with:
+conda create --name myenv python=3.10.13
+
+Second, activate the environment and install the package:
+conda activate myenv
+pip install .
+
+*(If you plan to modify the core models in the `src/` folder, install in editable mode instead using `pip install -e .`)*
+
+After that you can run the simulation script from the project root with:
+python main_sim.py
+
+*Note: Configuration is pulled from data/inputs/input_params.json, and outputs are saved to data/outputs/.*
+
+### Installing dependencies
+Install the recommended dependencies with:
+```
+pip install . docs
+
+```
+## Documentation
+
+The documentation for the individual models is available [here](docs/index.md)
+
+## Recommended vscode-extensions
+- GitLens -Git supercharged: Nice graphical git support
+- autopep8: Autoformatting in pep8. Install and press (strg+alt+F)
+- Better Comments: Highlighting of comments syntax
+- Code Spell Checker: Spelling checker
+- Drawio.io Integration: UML-Diagrams, etc. in vs-code
+- Edit csv: Editing csv files like tables in excel
+- Rainbow CSV: Color highlighting in csv files
+- autoDocstring: Python Docstring generator (Generates Docstrings in different styles (Google, sphinx, etc...))
+
+## Note:
+**src** Folder: 
+- Do not rename it to "code". It will cause name clashes with the internal python module "code".

des_sim-1.0.1/README.md

@@ -0,0 +1,43 @@
+# District Energy System(DES)
+
+This project uses the mosaik package to simulate heat pump in conjuction with a CHP unit to meet the heat and electricity demand of a housing district.
+
+## Installation
+
+To get started first create a new conda env with:
+conda create --name myenv python=3.10.13
+
+Second, activate the environment and install the package:
+conda activate myenv
+pip install .
+
+*(If you plan to modify the core models in the `src/` folder, install in editable mode instead using `pip install -e .`)*
+
+After that you can run the simulation script from the project root with:
+python main_sim.py
+
+*Note: Configuration is pulled from data/inputs/input_params.json, and outputs are saved to data/outputs/.*
+
+### Installing dependencies
+Install the recommended dependencies with:
+```
+pip install . docs
+
+```
+## Documentation
+
+The documentation for the individual models is available [here](docs/index.md)
+
+## Recommended vscode-extensions
+- GitLens -Git supercharged: Nice graphical git support
+- autopep8: Autoformatting in pep8. Install and press (strg+alt+F)
+- Better Comments: Highlighting of comments syntax
+- Code Spell Checker: Spelling checker
+- Drawio.io Integration: UML-Diagrams, etc. in vs-code
+- Edit csv: Editing csv files like tables in excel
+- Rainbow CSV: Color highlighting in csv files
+- autoDocstring: Python Docstring generator (Generates Docstrings in different styles (Google, sphinx, etc...))
+
+## Note:
+**src** Folder: 
+- Do not rename it to "code". It will cause name clashes with the internal python module "code".

des_sim-1.0.1/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+license-files = ["LICENSE"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project]
+name = "DES_sim"
+authors = [{name = "Leroy Tomas", email = "leroy.tomas@hs-offenburg.de"}]
+version = "1.0.1"
+license = {file = "LICENSE"}    
+requires-python = "==3.10.13"
+readme = "README.md"
+keywords = ["DES", "mosaik", "simulation", "HP", "CHP", "PV"]
+
+# add necessary dependencies of the repo. They can be installed via "pip install ."
+dependencies = [
+    "setuptools<81",
+    "mosaik==3.2.0",
+    "mosaik-api==3.0.3",
+    "mosaik-api-v3==3.0.9",
+    "mosaik-heatpump==1.0.1",
+    "mosaik-pv==1.2.1",
+    "mosaik-pvlib==1.0",
+    "mosaik-csv",
+    "pandas",
+    "numpy",
+    "matplotlib",
+    "plotly==5.24.1",
+    "nest_asyncio",
+    "nbformat==5.10.4"
+]
+
+[project.optional-dependencies]
+# add optional dependencies of the repo. They could be installed via "pip install .[dev]" 
+dev = [
+    "pytest",
+    "flake8",
+]
+
+opti = [
+    "ipykernel",
+    "ipynbname",
+    "tqdm",
+    "pyDOE"
+]
+
+# add optional dependencies of the repo. They could be installed via "pip install .[docs]" 
+docs = [
+    "sphinx==7.4.5",
+    "sphinx-rtd-theme==2.0.0",
+    "m2r2==0.3.3.post2",
+]

des_sim-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

des_sim-1.0.1/src/DES_sim.egg-info/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: DES_sim
+Version: 1.0.1
+Author-email: Leroy Tomas <leroy.tomas@hs-offenburg.de>
+License: MIT
+        BSD-3-Clause
+        MIT AND (Apache-2.0 OR BSD-2-Clause)
+        MIT OR GPL-2.0-or-later OR (FSFUL AND BSD-2-Clause)
+        GPL-3.0-only WITH Classpath-Exception-2.0 OR BSD-3-Clause
+        LicenseRef-Special-License OR CC0-1.0 OR Unlicense
+        LicenseRef-Proprietary
+Keywords: DES,mosaik,simulation,HP,CHP,PV
+Requires-Python: ==3.10.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools<81
+Requires-Dist: mosaik==3.2.0
+Requires-Dist: mosaik-api==3.0.3
+Requires-Dist: mosaik-api-v3==3.0.9
+Requires-Dist: mosaik-heatpump==1.0.1
+Requires-Dist: mosaik-pv==1.2.1
+Requires-Dist: mosaik-pvlib==1.0
+Requires-Dist: mosaik-csv
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: plotly==5.24.1
+Requires-Dist: nest_asyncio
+Requires-Dist: nbformat==5.10.4
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Provides-Extra: opti
+Requires-Dist: ipykernel; extra == "opti"
+Requires-Dist: ipynbname; extra == "opti"
+Requires-Dist: tqdm; extra == "opti"
+Requires-Dist: pyDOE; extra == "opti"
+Provides-Extra: docs
+Requires-Dist: sphinx==7.4.5; extra == "docs"
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "docs"
+Requires-Dist: m2r2==0.3.3.post2; extra == "docs"
+
+# District Energy System(DES)
+
+This project uses the mosaik package to simulate heat pump in conjuction with a CHP unit to meet the heat and electricity demand of a housing district.
+
+## Installation
+
+To get started first create a new conda env with:
+conda create --name myenv python=3.10.13
+
+Second, activate the environment and install the package:
+conda activate myenv
+pip install .
+
+*(If you plan to modify the core models in the `src/` folder, install in editable mode instead using `pip install -e .`)*
+
+After that you can run the simulation script from the project root with:
+python main_sim.py
+
+*Note: Configuration is pulled from data/inputs/input_params.json, and outputs are saved to data/outputs/.*
+
+### Installing dependencies
+Install the recommended dependencies with:
+```
+pip install . docs
+
+```
+## Documentation
+
+The documentation for the individual models is available [here](docs/index.md)
+
+## Recommended vscode-extensions
+- GitLens -Git supercharged: Nice graphical git support
+- autopep8: Autoformatting in pep8. Install and press (strg+alt+F)
+- Better Comments: Highlighting of comments syntax
+- Code Spell Checker: Spelling checker
+- Drawio.io Integration: UML-Diagrams, etc. in vs-code
+- Edit csv: Editing csv files like tables in excel
+- Rainbow CSV: Color highlighting in csv files
+- autoDocstring: Python Docstring generator (Generates Docstrings in different styles (Google, sphinx, etc...))
+
+## Note:
+**src** Folder: 
+- Do not rename it to "code". It will cause name clashes with the internal python module "code".

des_sim-1.0.1/src/DES_sim.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+LICENSE
+README.md
+pyproject.toml
+src/DES_sim.egg-info/PKG-INFO
+src/DES_sim.egg-info/SOURCES.txt
+src/DES_sim.egg-info/dependency_links.txt
+src/DES_sim.egg-info/requires.txt
+src/DES_sim.egg-info/top_level.txt
+src/des_sim/__init__.py
+src/des_sim/models/3wayvalve.py
+src/des_sim/models/EnTransformer.py
+src/des_sim/models/__init__.py
+src/des_sim/models/battery.py
+src/des_sim/models/boiler_model_v2.py
+src/des_sim/models/chp_model_v2.py
+src/des_sim/models/collector.py
+src/des_sim/models/controller.py
+src/des_sim/models/controller_mosaik.py
+src/des_sim/models/pvlib_model.py
+src/des_sim/utils/__init__.py
+src/des_sim/utils/helpers.py
+src/des_sim/utils/visu_v2_prep.py

des_sim-1.0.1/src/DES_sim.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

des_sim-1.0.1/src/DES_sim.egg-info/requires.txt

@@ -0,0 +1,29 @@
+setuptools<81
+mosaik==3.2.0
+mosaik-api==3.0.3
+mosaik-api-v3==3.0.9
+mosaik-heatpump==1.0.1
+mosaik-pv==1.2.1
+mosaik-pvlib==1.0
+mosaik-csv
+pandas
+numpy
+matplotlib
+plotly==5.24.1
+nest_asyncio
+nbformat==5.10.4
+
+[dev]
+pytest
+flake8
+
+[docs]
+sphinx==7.4.5
+sphinx-rtd-theme==2.0.0
+m2r2==0.3.3.post2
+
+[opti]
+ipykernel
+ipynbname
+tqdm
+pyDOE

des_sim-1.0.1/src/DES_sim.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+des_sim
+utils

des_sim-1.0.1/src/des_sim/__init__.py

@@ -0,0 +1 @@
+# Marks the des_sim directory as an importable Python package.

des_sim-1.0.1/src/des_sim/models/3wayvalve.py

@@ -0,0 +1,132 @@
+import mosaik_api
+from des_sim.utils import helpers
+
+class ThreeWayValve():
+    '''
+    A class representing a three-way valve.
+    It takes an input flow and splits it into two output flows based on a defined share.
+    The temperature is assumed to be the same for all flows.
+    Attributes:
+    - flows: A dictionary containing the input and output flows.
+    - out1_share: The fraction of the input flow that goes to output 1. Could be preset in the params, or also dynamically assigned by another entity.
+    - out2_share(optional) : The fraction of the input flow that goes to output 2. If provided, out1_share is adjusted accordingly.
+    
+    '''
+    def __init__(self, params={}):
+    
+        self.flows = {
+            'in' : 0,
+            'out_1' : 0,
+            'out_2' : 0,
+            'temp' : 0
+        } 
+        self.out1_share = params.get('out1_share', 0.5) # how much of the input flow goes to out_1
+        if 'out2_share' in params.keys():
+            self.out1_share = 1 - params.get('out2_share')
+
+    
+    def step(self, time):
+
+        self.flows['out_1'] = self.flows['in'] * self.out1_share
+        self.flows['out_2'] = self.flows['in'] * (1 - self.out1_share)
+
+    def get_init_attrs(self):
+        '''
+        Simply returns a list of all user defined attributes in this class. 
+        Useful to add to the attrs list in META.
+        '''
+        attr_list = helpers.flatten_attrs(self, list(vars(self).keys()))
+        return attr_list
+
+#-------------------------Mosaik Back-end-------------------------------
+META = {
+    'type': 'time-based',
+    'models': {
+        'Valve': {
+            'public': True,
+            'params': ['params'],
+            'attrs': ['status'],
+        },
+    },
+}
+
+class SimInterface(mosaik_api.Simulator):
+    def __init__(self):
+        
+        super().__init__(META)
+        self.time_resolution = None
+        self.models = dict()  # contains the model instances
+        self.sid = None
+        self.step_size = None
+        self.eid_prefix = None
+        self.time = 0
+        
+        
+    def init(self, sid, time_resolution, step_size, params, same_time_loop=False):
+        self.time_resolution = float(time_resolution)
+        if self.time_resolution != 1.0:
+            print('WARNING: %s got a time_resolution other than 1.0, which \
+                can not be handled by this simulator.', sid)
+        self.sid = sid # simulator id
+        self.step_size = step_size
+        if same_time_loop:
+            self.meta['type'] = 'event-based'
+
+        self.eid_prefix = params.get('eid_prefix')
+        
+        self.dummy_object = ThreeWayValve(params)
+        self.meta['models']['Valve']['attrs'] = self.dummy_object.get_init_attrs()
+        # self.meta['models']['Transformer']['trigger'] = self.dummy_object.get_init_attrs()
+
+        return self.meta
+    
+    def create(self, num, model, params):
+        entities = []
+
+        next_eid = len(self.models) #if create called a second time, eid will not repeat
+        for i in range(next_eid, next_eid + num):
+            eid = '%s%d' % (self.eid_prefix, i)
+            self.models[eid] = ThreeWayValve(params)
+            entities.append({'eid': eid, 'type': model})
+        return entities
+            
+    def step(self, time, inputs, max_advance):
+        for eid, attrs in inputs.items():
+            if self.meta['type'] == 'event-based':
+                if time != self.time:
+                    self.time = time
+                    setattr(self.models[eid], 'step_executed', False)
+            for attr, src_ids in attrs.items():
+                if len(src_ids) > 1:
+                    raise ValueError('Too many inputs for attribute %s' % attr)
+                for val in src_ids.values():
+                    helpers.set_nested_attr(self.models[eid], attr, val)
+
+            self.models[eid].step_size = self.step_size
+
+        for eid, model in self.models.items():
+            model.step(time)
+
+        if self.meta['type'] == 'event-based':
+            return None
+        else:
+            return time + self.step_size
+    
+    def get_data(self, outputs):
+        data = {}
+        for eid, attrs in outputs.items():
+            data[eid] = {}
+            for attr in attrs:
+                if attr not in self.meta['models']['Valve'][
+                        'attrs']:
+                    raise ValueError('Unknown output attribute: %s' % attr)
+                data['time'] = self.time
+                data[eid][attr] = helpers.get_nested_attr(self.models[eid], attr)
+                    
+        return data
+
+def main():
+    return mosaik_api.start_simulation(SimInterface())
+
+if __name__ == '__main__':
+    main()