diff --git a/docs/manual/loadflow_configuration.md b/docs/manual/loadflow_configuration.md index 79df1f4b8bf0b1658099f25538b649dab7a3f70e..4f25ecadcae16d3f509bdfc1d5748f42bce01435 100644 --- a/docs/manual/loadflow_configuration.md +++ b/docs/manual/loadflow_configuration.md @@ -28,13 +28,13 @@ with the following input parameters: ### Configuration Parameters for the Heat Load -| Parameter | Description | Unit | Type | Remark | -|-----------------|-----------------------------------------------------------------------|------|--------|-----------------------------------------------------------------------------------------------------------------------------| -| lp_type | Type of heat load profile | - | sting | Options: BERNIER; CONSTANT; VARIABLE; FROMFILE | -| lp_inputdir | Path to folder containing the heat load source file | — | string | - | -| lp_outdir | Path to output directory for generated profiles and figures | — | string | Creates folder if not existing | -| lp_filename | Name of the input file containing the heat load data | — | string | Optional; only used if `lp_type` is FROMFILE | -| lp_inputcolumn | Name of the column in the input file that contains the heat load data | - | string | Optional; only used if `lp_type` is FROMFILE | +| Parameter | Description | Unit | Type | Remark | +|-----------------|-----------------------------------------------------------------------|------|--------|-------------------------------------------------------------------------------------------------------------------------------| +| lp_type | Type of heat load profile | - | sting | Options: BERNIER; CONSTANT; VARIABLE; FROMFILE | +| lp_inputdir | Path to folder containing the heat load source file | — | string | - | +| lp_outdir | Path to output directory for generated profiles and figures | — | string | Creates folder if not existing | +| lp_filename | Name of the input CSV file containing the heat load data | — | string | The fourth row in the file must contain the column names; Optional; only used if `lp_type` is FROMFILE | +| lp_inputcolumn | Name of the column in the input file that contains the heat load data | - | string | Heat load data in unit kW; Optional; only used if `lp_type` is FROMFILE | | lp_smoothing | Type of smoothing applied to the load data | — | string | Options: D (daily), M (monthly), Y (yearly). Optional; only used if `lp_type` is FROMFILE | | lp_scale | Scaling factor applied to the load values | — | scalar | Scaling factor for the load profile. Optional; only used if `lp_type` is FROMFILE | | lp_minscaleflow | Minimum scaling factor for flow | - | scalar | To avoid very lowe flowrates affecting numerical performance. Optional; only used if `lp_type` is FROMFILE or VARIABLE | @@ -86,6 +86,10 @@ The column with heat load or flow rate data is defined in the `**_inpucolumn` pa For a variable flow rate, an example of such a file is provided in the `input` subdirectory of the working directory of the example from a [BHE with a daily-variable flow rate profile](../examples/variable_flow_rate/variable_flow_rate.md) +> **_NOTE:_** The heat load in the CSV datafile has unit kW and the first four rows in the datafile are considered header lines; +> make sure the column names are defines in row 4. + + > The simulation internally operates on a uniform time array, which is generated based on the parameters `nyear` and `nled` > in the main simulation configuration. Both heat load and flow rate profiles are interpolated or indexed to match this simulation time array. diff --git a/pyproject.toml b/pyproject.toml index e6c14bbbf190b4f15388448d065307478aab18d6..02d786483544c24c0715d9e09e70e229caacb7f0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "geoloop" -version = "1.0.3" +version = "1.0.4" description = "This is a Python package for simulation of (deep) vertical Borehole Heat Exchanger (BHE) systems" authors = [ { name = "Zanne Korevaar", email = "zanne.korevaar@tno.nl" }, diff --git a/src/geoloop/constants.py b/src/geoloop/constants.py index 827212e3605eab7e737a28e382095023a27d54f2..e3f775258acaf1060334ef7308b9a5d2deaefe23 100644 --- a/src/geoloop/constants.py +++ b/src/geoloop/constants.py @@ -32,6 +32,7 @@ units_dict = { "k_s_res": "W/mK", "fluid_percent": "%", "insu_z": "m", + "insu_k": "W/mK", "insu_dr": "%", "k_g_res": "W/mK", } @@ -70,6 +71,7 @@ format_dict = { "k_s_res": "$k_{s-res}$", "fluid_percent": "$fluid_{percent}$", "insu_z": "$insu_{z}$", + "insu_k": "$insu_{k}$", "insu_dr": "$insu_{dr}$", "k_g_res": "$k_{g-res}$", }