5602410238

pending completion

Build # 5602410238

Build Type

push

github-actions

Committed by

web-flow

Commit Message

Add a new GHE district test with new network template models (#561)

* New network model and its coupling

* Bug fix

* Refer to load ids in relevant couplings

* New coupling definitions

* Add test script for new template

* Avoid potential fail if more buildings added

* Changes due to new g-function csv format

* Format fixing

* Modify sys_params for new test

* Avoid overriding final parameters

* Revise relative path of ghe_dir

* Pre-commit changes

* fix ghe text syntax

* update borefield pytest skip reason with more detail

* make resources_dir relative path NOT platform-aware, so it will always work in Modelica

* Revert "make resources_dir relative path NOT platform-aware, so it will always work in Modelica"

This reverts commit 845b19035.

* Change gfunction.mat path to modelica path

* pre-commit changes

---------

Co-authored-by: Nathan Moore <nathan.moore@nrel.gov>

Run Details

889 of 1063 branches covered (83.63%)

Branch coverage included in aggregate %.

14 of 14 new or added lines in 2 files covered. (100.0%)

2475 of 2744 relevant lines covered (90.2%)

1.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.26

/geojson_modelica_translator/model_connectors/plants/borefield.py

# :copyright (c) URBANopt, Alliance for Sustainable Energy, LLC, and other contributors.
# See also https://github.com/urbanopt/geojson-modelica-translator/blob/develop/LICENSE.md

import logging
import math
import os
from pathlib import Path

import pandas as pd
import scipy.io as sio

from geojson_modelica_translator.model_connectors.plants.plant_base import (
    PlantBase
)
from geojson_modelica_translator.modelica.package_parser import PackageParser
from geojson_modelica_translator.utils import ModelicaPath, simple_uuid

logger = logging.getLogger(__name__)
logging.basicConfig(
    level=logging.INFO,
    format='%(asctime)s - %(levelname)s: %(message)s',
    datefmt='%d-%b-%y %H:%M:%S',
)


class Borefield(PlantBase):
    model_name = 'Borefield'

    def __init__(self, system_parameters):
        super().__init__(system_parameters)
        self.id = 'borFie_' + simple_uuid()
        self.borefield_name = 'Borefield_' + simple_uuid()

        self.required_mo_files.append(os.path.join(self.template_dir, 'GroundTemperatureResponse.mo'))

    def to_modelica(self, scaffold):
        """
        Create timeSeries models based on the data in the buildings and geojsons

        :param scaffold: Scaffold object, Scaffold of the entire directory of the project.
        """

        template_data = {
            "gfunction": {
                "input_path": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.ghe_dir"
                )
            },
            "soil": {
                "initial_ground_temperature": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.soil.undisturbed_temp"
                ),
                "conductivity": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.soil.conductivity"
                ),
                "volumetric_heat_capacity": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.soil.rho_cp"
                ),
            },
            "fill": {
                "conductivity": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.grout.conductivity"
                ),
                "volumetric_heat_capacity": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.grout.rho_cp"
                ),
            },
            "configuration": {
                "borehole_configuration": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.pipe.arrangement"
                ),
                "nominal_mass_flow_per_borehole": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.design.flow_rate"
                ),
                "flow_type": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.design.flow_type"
                ),
                "borehole_height": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.ghe_specific_params[0].borehole.length"
                ),
                "borehole_diameter": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.ghe_specific_params[0].borehole.diameter"
                ),
                "borehole_buried_depth": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.ghe_specific_params[0].borehole.buried_depth"
                ),
                "number_of_boreholes": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.ghe_specific_params[0].borehole.number_of_boreholes"
                ),
            },
            "tube": {
                "outer_diameter": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.pipe.outer_diameter"
                ),
                "inner_diameter": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.pipe.inner_diameter"
                ),
                "conductivity": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.pipe.conductivity"
                ),
                "shank_spacing": self.system_parameters.get_param(
                    "$.district_system.fifth_generation.ghe_parameters.pipe.shank_spacing"
                ),
            },
        }

        # process g-function file
        if Path(template_data["gfunction"]["input_path"]).expanduser().is_absolute():
            gfunction = pd.read_csv(Path(template_data["gfunction"]["input_path"]) / "Gfunction.csv", header=0, usecols=[0, 2])
        else:
            sys_param_dir = Path(self.system_parameters.filename).parent.resolve()
            try:
                gfunction = pd.read_csv(sys_param_dir / template_data["gfunction"]["input_path"] / "Gfunction.csv", header=0, usecols=[0, 2])
            except FileNotFoundError:
                raise SystemExit(f'When using a relative path to your ghe_dir, your path \'{template_data["gfunction"]["input_path"]}\' must be relative to the dir your sys-param file is in.')
        template_data["gfunction"]["gfunction_file_rows"] = gfunction.shape[0] + 1

        # convert the values to match Modelica gfunctions
        for i in range(len(gfunction)):
            gfunction[gfunction.columns[0]].iloc[i] = math.exp(gfunction[gfunction.columns[0]].iloc[i]) * template_data["configuration"]["borehole_height"]**2 / (9 * template_data["soil"]["conductivity"] / template_data["soil"]["volumetric_heat_capacity"])
            gfunction[gfunction.columns[1]].iloc[i] = gfunction[gfunction.columns[1]].iloc[i] / (template_data["configuration"]["number_of_boreholes"] * 2 * math.pi * template_data["configuration"]["borehole_height"] * template_data["soil"]["conductivity"])

        # add zeros to the first row
        new_row = pd.Series({gfunction.columns[0]: 0, gfunction.columns[1]: 0})
        gfunction = pd.concat([gfunction.iloc[:0], pd.DataFrame([new_row]), gfunction.iloc[0:]]).reset_index(drop=True)

        # create borefield package paths
        b_modelica_path = ModelicaPath(self.borefield_name, scaffold.plants_path.files_dir, True)

        # add to dict and save MAT file to the borefield's resources folder
        data_dict = {'TStep': gfunction.values}
        gfunction_path = os.path.join(b_modelica_path.resources_dir, 'Gfunction.mat')
        sio.savemat(gfunction_path, data_dict)
        template_data["gfunction"]["gfunction_file_path"] = b_modelica_path.resources_relative_dir + "/Gfunction.mat"

        # process nominal mass flow rate
        if template_data["configuration"]["flow_type"] == "system":
            template_data["configuration"]["nominal_mass_flow_per_borehole"] = template_data["configuration"]["nominal_mass_flow_per_borehole"] / template_data["configuration"]["number_of_boreholes"]

        # process tube thickness
        if template_data["tube"]["outer_diameter"] and template_data["tube"]["inner_diameter"]:
            template_data["tube"]["thickness"] = (template_data["tube"]["outer_diameter"] - template_data["tube"]["inner_diameter"]) / 2
        else:
            template_data["tube"]["thickness"] = None

        # process shank spacing
        if template_data["tube"]["shank_spacing"] and template_data["tube"]["outer_diameter"]:
            template_data["tube"]["shank_spacing"] = (template_data["tube"]["shank_spacing"] + template_data["tube"]["outer_diameter"]) / 2
        else:
            template_data["tube"]["shank_spacing"] = None

        # load templates
        oneutube_template = self.template_env.get_template("BorefieldOneUTube.mot")
        twoutube_template = self.template_env.get_template("BorefieldTwoUTubes.mot")

        if template_data["configuration"]["borehole_configuration"] == "singleutube":
            plant_template = oneutube_template
            template_data["configuration"]["borehole_configuration"] = "Buildings.Fluid.Geothermal.Borefields.Types.BoreholeConfiguration.SingleUTube"
            template_data["configuration"]["borehole_type"] = "Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.OneUTube"
        elif template_data["configuration"]["borehole_configuration"] == "doubleutube":
            plant_template = twoutube_template
            template_data["configuration"]["borehole_configuration"] = "Buildings.Fluid.Geothermal.Borefields.Types.BoreholeConfiguration.DoubleUTubeSeries"
            template_data["configuration"]["borehole_type"] = "Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.TwoUTube"
        else:
            raise ValueError("The type of geothermal heat exchanger pipe arrangement is not supported.")

        self.run_template(
            plant_template,
            os.path.join(b_modelica_path.files_dir, "Borefield.mo"),
            project_name=scaffold.project_name,
            model_name=self.borefield_name,
            ghe_data=template_data
        )

        # generate Modelica package
        self.copy_required_mo_files(
            dest_folder=scaffold.plants_path.files_dir,
            within=f'{scaffold.project_name}.Plants')

        # Borefield_ package
        subpackage_models = ['Borefield']
        borefield_package = PackageParser.new_from_template(
            path=b_modelica_path.files_dir,
            name=self.borefield_name,
            order=subpackage_models,
            within=f"{scaffold.project_name}.Plants"
        )
        borefield_package.save()

        # Plants package
        package = PackageParser(scaffold.project_path)
        if 'Plants' not in package.order:
            package.add_model('Plants')
            package.save()

        package_models = [self.borefield_name] + [Path(mo).stem for mo in self.required_mo_files]
        plants_package = PackageParser(scaffold.plants_path.files_dir)
        if plants_package.order_data is None:
            plants_package = PackageParser.new_from_template(
                path=scaffold.plants_path.files_dir,
                name="Plants",
                order=package_models,
                within=scaffold.project_name)
        else:
            for model_name in package_models:
                plants_package.add_model(model_name)
        plants_package.save()

    def get_modelica_type(self, scaffold):
        return f'{scaffold.project_name}.Plants.{self.borefield_name}.Borefield'

1	# :copyright (c) URBANopt, Alliance for Sustainable Energy, LLC, and other contributors.
2	# See also https://github.com/urbanopt/geojson-modelica-translator/blob/develop/LICENSE.md
3
4	import logging	2✔
5	import math	2✔
6	import os	2✔
7	from pathlib import Path	2✔
8
9	import pandas as pd	2✔
10	import scipy.io as sio	2✔
11
12	from geojson_modelica_translator.model_connectors.plants.plant_base import (	2✔
13	PlantBase
14	)
15	from geojson_modelica_translator.modelica.package_parser import PackageParser	2✔
16	from geojson_modelica_translator.utils import ModelicaPath, simple_uuid	2✔
17
18	logger = logging.getLogger(__name__)	2✔
19	logging.basicConfig(	2✔
20	level=logging.INFO,
21	format='%(asctime)s - %(levelname)s: %(message)s',
22	datefmt='%d-%b-%y %H:%M:%S',
23	)
24
25
26	class Borefield(PlantBase):	2✔
27	model_name = 'Borefield'	2✔
28
29	def __init__(self, system_parameters):	2✔
30	super().__init__(system_parameters)	2✔
31	self.id = 'borFie_' + simple_uuid()	2✔
32	self.borefield_name = 'Borefield_' + simple_uuid()	2✔
33
34	self.required_mo_files.append(os.path.join(self.template_dir, 'GroundTemperatureResponse.mo'))	2✔
35
36	def to_modelica(self, scaffold):	2✔
37	"""
38	Create timeSeries models based on the data in the buildings and geojsons
39
40	:param scaffold: Scaffold object, Scaffold of the entire directory of the project.
41	"""
42
43	template_data = {	2✔
44	"gfunction": {
45	"input_path": self.system_parameters.get_param(
46	"$.district_system.fifth_generation.ghe_parameters.ghe_dir"
47	)
48	},
49	"soil": {
50	"initial_ground_temperature": self.system_parameters.get_param(
51	"$.district_system.fifth_generation.ghe_parameters.soil.undisturbed_temp"
52	),
53	"conductivity": self.system_parameters.get_param(
54	"$.district_system.fifth_generation.ghe_parameters.soil.conductivity"
55	),
56	"volumetric_heat_capacity": self.system_parameters.get_param(
57	"$.district_system.fifth_generation.ghe_parameters.soil.rho_cp"
58	),
59	},
60	"fill": {
61	"conductivity": self.system_parameters.get_param(
62	"$.district_system.fifth_generation.ghe_parameters.grout.conductivity"
63	),
64	"volumetric_heat_capacity": self.system_parameters.get_param(
65	"$.district_system.fifth_generation.ghe_parameters.grout.rho_cp"
66	),
67	},
68	"configuration": {
69	"borehole_configuration": self.system_parameters.get_param(
70	"$.district_system.fifth_generation.ghe_parameters.pipe.arrangement"
71	),
72	"nominal_mass_flow_per_borehole": self.system_parameters.get_param(
73	"$.district_system.fifth_generation.ghe_parameters.design.flow_rate"
74	),
75	"flow_type": self.system_parameters.get_param(
76	"$.district_system.fifth_generation.ghe_parameters.design.flow_type"
77	),
78	"borehole_height": self.system_parameters.get_param(
79	"$.district_system.fifth_generation.ghe_parameters.ghe_specific_params[0].borehole.length"
80	),
81	"borehole_diameter": self.system_parameters.get_param(
82	"$.district_system.fifth_generation.ghe_parameters.ghe_specific_params[0].borehole.diameter"
83	),
84	"borehole_buried_depth": self.system_parameters.get_param(
85	"$.district_system.fifth_generation.ghe_parameters.ghe_specific_params[0].borehole.buried_depth"
86	),
87	"number_of_boreholes": self.system_parameters.get_param(
88	"$.district_system.fifth_generation.ghe_parameters.ghe_specific_params[0].borehole.number_of_boreholes"
89	),
90	},
91	"tube": {
92	"outer_diameter": self.system_parameters.get_param(
93	"$.district_system.fifth_generation.ghe_parameters.pipe.outer_diameter"
94	),
95	"inner_diameter": self.system_parameters.get_param(
96	"$.district_system.fifth_generation.ghe_parameters.pipe.inner_diameter"
97	),
98	"conductivity": self.system_parameters.get_param(
99	"$.district_system.fifth_generation.ghe_parameters.pipe.conductivity"
100	),
101	"shank_spacing": self.system_parameters.get_param(
102	"$.district_system.fifth_generation.ghe_parameters.pipe.shank_spacing"
103	),
104	},
105	}
106
107	# process g-function file
108	if Path(template_data["gfunction"]["input_path"]).expanduser().is_absolute():	2!
109	gfunction = pd.read_csv(Path(template_data["gfunction"]["input_path"]) / "Gfunction.csv", header=0, usecols=[0, 2])	×
110	else:
111	sys_param_dir = Path(self.system_parameters.filename).parent.resolve()	2✔
112	try:	2✔
113	gfunction = pd.read_csv(sys_param_dir / template_data["gfunction"]["input_path"] / "Gfunction.csv", header=0, usecols=[0, 2])	2✔
114	except FileNotFoundError:	×
115	raise SystemExit(f'When using a relative path to your ghe_dir, your path \'{template_data["gfunction"]["input_path"]}\' must be relative to the dir your sys-param file is in.')	×
116	template_data["gfunction"]["gfunction_file_rows"] = gfunction.shape[0] + 1	2✔
117
118	# convert the values to match Modelica gfunctions
119	for i in range(len(gfunction)):	2✔
120	gfunction[gfunction.columns[0]].iloc[i] = math.exp(gfunction[gfunction.columns[0]].iloc[i]) * template_data["configuration"]["borehole_height"]*2 / (9 template_data["soil"]["conductivity"] / template_data["soil"]["volumetric_heat_capacity"])	2✔
121	gfunction[gfunction.columns[1]].iloc[i] = gfunction[gfunction.columns[1]].iloc[i] / (template_data["configuration"]["number_of_boreholes"] * 2 * math.pi * template_data["configuration"]["borehole_height"] * template_data["soil"]["conductivity"])	2✔
122
123	# add zeros to the first row
124	new_row = pd.Series({gfunction.columns[0]: 0, gfunction.columns[1]: 0})	2✔
125	gfunction = pd.concat([gfunction.iloc[:0], pd.DataFrame([new_row]), gfunction.iloc[0:]]).reset_index(drop=True)	2✔
126
127	# create borefield package paths
128	b_modelica_path = ModelicaPath(self.borefield_name, scaffold.plants_path.files_dir, True)	2✔
129
130	# add to dict and save MAT file to the borefield's resources folder
131	data_dict = {'TStep': gfunction.values}	2✔
132	gfunction_path = os.path.join(b_modelica_path.resources_dir, 'Gfunction.mat')	2✔
133	sio.savemat(gfunction_path, data_dict)	2✔
134	template_data["gfunction"]["gfunction_file_path"] = b_modelica_path.resources_relative_dir + "/Gfunction.mat"	2✔
135
136	# process nominal mass flow rate
137	if template_data["configuration"]["flow_type"] == "system":	2!
138	template_data["configuration"]["nominal_mass_flow_per_borehole"] = template_data["configuration"]["nominal_mass_flow_per_borehole"] / template_data["configuration"]["number_of_boreholes"]	×
139
140	# process tube thickness
141	if template_data["tube"]["outer_diameter"] and template_data["tube"]["inner_diameter"]:	2!
142	template_data["tube"]["thickness"] = (template_data["tube"]["outer_diameter"] - template_data["tube"]["inner_diameter"]) / 2	2✔
143	else:
144	template_data["tube"]["thickness"] = None	×
145
146	# process shank spacing
147	if template_data["tube"]["shank_spacing"] and template_data["tube"]["outer_diameter"]:	2!
148	template_data["tube"]["shank_spacing"] = (template_data["tube"]["shank_spacing"] + template_data["tube"]["outer_diameter"]) / 2	2✔
149	else:
150	template_data["tube"]["shank_spacing"] = None	×
151
152	# load templates
153	oneutube_template = self.template_env.get_template("BorefieldOneUTube.mot")	2✔
154	twoutube_template = self.template_env.get_template("BorefieldTwoUTubes.mot")	2✔
155
156	if template_data["configuration"]["borehole_configuration"] == "singleutube":	2!
157	plant_template = oneutube_template	2✔
158	template_data["configuration"]["borehole_configuration"] = "Buildings.Fluid.Geothermal.Borefields.Types.BoreholeConfiguration.SingleUTube"	2✔
159	template_data["configuration"]["borehole_type"] = "Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.OneUTube"	2✔
160	elif template_data["configuration"]["borehole_configuration"] == "doubleutube":	×
161	plant_template = twoutube_template	×
162	template_data["configuration"]["borehole_configuration"] = "Buildings.Fluid.Geothermal.Borefields.Types.BoreholeConfiguration.DoubleUTubeSeries"	×
163	template_data["configuration"]["borehole_type"] = "Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.TwoUTube"	×
164	else:
165	raise ValueError("The type of geothermal heat exchanger pipe arrangement is not supported.")	×
166
167	self.run_template(	2✔
168	plant_template,
169	os.path.join(b_modelica_path.files_dir, "Borefield.mo"),
170	project_name=scaffold.project_name,
171	model_name=self.borefield_name,
172	ghe_data=template_data
173	)
174
175	# generate Modelica package
176	self.copy_required_mo_files(	2✔
177	dest_folder=scaffold.plants_path.files_dir,
178	within=f'{scaffold.project_name}.Plants')
179
180	# Borefield_ package
181	subpackage_models = ['Borefield']	2✔
182	borefield_package = PackageParser.new_from_template(	2✔
183	path=b_modelica_path.files_dir,
184	name=self.borefield_name,
185	order=subpackage_models,
186	within=f"{scaffold.project_name}.Plants"
187	)
188	borefield_package.save()	2✔
189
190	# Plants package
191	package = PackageParser(scaffold.project_path)	2✔
192	if 'Plants' not in package.order:	2!
193	package.add_model('Plants')	2✔
194	package.save()	2✔
195
196	package_models = [self.borefield_name] + [Path(mo).stem for mo in self.required_mo_files]	2✔
197	plants_package = PackageParser(scaffold.plants_path.files_dir)	2✔
198	if plants_package.order_data is None:	2!
199	plants_package = PackageParser.new_from_template(	2✔
200	path=scaffold.plants_path.files_dir,
201	name="Plants",
202	order=package_models,
203	within=scaffold.project_name)
204	else:
205	for model_name in package_models:	×
206	plants_package.add_model(model_name)	×
207	plants_package.save()	2✔
208
209	def get_modelica_type(self, scaffold):	2✔
210	return f'{scaffold.project_name}.Plants.{self.borefield_name}.Borefield'	2✔

urbanopt / geojson-modelica-translator / 5602410238

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous