diff --git a/process/data_structure/__init__.py b/process/data_structure/__init__.py index 97722324db..a2f6351e01 100644 --- a/process/data_structure/__init__.py +++ b/process/data_structure/__init__.py @@ -1,3 +1,5 @@ +"""Module containing data structure variables""" + from process.data_structure import ( blanket_variables, build_variables, diff --git a/process/data_structure/blanket_variables.py b/process/data_structure/blanket_variables.py index 3d287f924c..0eb0f89713 100644 --- a/process/data_structure/blanket_variables.py +++ b/process/data_structure/blanket_variables.py @@ -1,11 +1,4 @@ -"""This library contains routines that can be shared by the blanket modules used in PROCESS. - -These include: -- component_volumes -- component_masses -- thermo_hydraulic_model - - +"""Module containing variables for the blanket models Acronyms for this module: @@ -21,8 +14,6 @@ OB Outboard HCD Heating & Current Drive FCI Flow Channel Insert - -Any changes within a subroutine or function code will have a comment explaining the change """ from dataclasses import dataclass @@ -38,6 +29,8 @@ class BlktModelTypes(IntEnum): @dataclass(slots=True) class BlanketData: + """Dataclass holding blanket variables""" + vol_shld_inboard: float = 0.0 """Volume of inboard shield (m3)""" diff --git a/process/data_structure/build_variables.py b/process/data_structure/build_variables.py index c5fd2f0b98..7888944d8f 100644 --- a/process/data_structure/build_variables.py +++ b/process/data_structure/build_variables.py @@ -1,3 +1,5 @@ +"""Module containing variables for the build models""" + from dataclasses import dataclass from enum import IntEnum from types import DynamicClassAttribute @@ -51,6 +53,8 @@ def description(self): @dataclass(slots=True) class BuildData: + """Dataclass holding build variables""" + rminor_min: float = 0.25 """Minimum allowed minor radius (m)""" diff --git a/process/data_structure/buildings_variables.py b/process/data_structure/buildings_variables.py index a58bca38c7..f1e99bdbdd 100644 --- a/process/data_structure/buildings_variables.py +++ b/process/data_structure/buildings_variables.py @@ -1,3 +1,5 @@ +"""Module containing variables for the buildings models""" + from dataclasses import dataclass from enum import IntEnum @@ -13,6 +15,8 @@ class BuildingsModel(IntEnum): @dataclass(slots=True) class BuildingsData: + """Dataclass holding buildings variables""" + admv: float = 1.0e5 """administration building volume (m3)""" diff --git a/process/data_structure/ccfe_hcpb_variables.py b/process/data_structure/ccfe_hcpb_variables.py index 5b0e86958d..1ece668535 100644 --- a/process/data_structure/ccfe_hcpb_variables.py +++ b/process/data_structure/ccfe_hcpb_variables.py @@ -1,16 +1,12 @@ -""" -This module contains the PROCESS CCFE HCPB blanket model -based on CCFE HCPB model from the PROCESS engineering paper -PROCESS Engineering paper (M. Kovari et al.) -### References -- Kovari et al., Fusion Engineering and Design 104 (2016) 9-20 -""" +"""Module containing variables for the CCFE HCPB models""" from dataclasses import dataclass @dataclass(slots=True) class CCFEHCPBData: + """Dataclass holding CCFE HCPB variables""" + armour_density: float = 0.0 """FW armour density [kg/m3]""" diff --git a/process/data_structure/constraint_variables.py b/process/data_structure/constraint_variables.py index 7e50e7bf88..6b26483816 100644 --- a/process/data_structure/constraint_variables.py +++ b/process/data_structure/constraint_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables for the constraints""" + from dataclasses import dataclass @dataclass(slots=True) class ConstraintData: + """Dataclass holding constraint variables""" + p_hcd_injected_min_mw: float = 0.1 """minimum auxiliary power (MW) (`constraint equation 40`)""" diff --git a/process/data_structure/cost_2015_variables.py b/process/data_structure/cost_2015_variables.py index 55ca6c12df..4a78dc2b5c 100644 --- a/process/data_structure/cost_2015_variables.py +++ b/process/data_structure/cost_2015_variables.py @@ -1,3 +1,5 @@ +"""Module containing variables for the costs 2015 models""" + from dataclasses import dataclass, field import numpy as np @@ -5,6 +7,8 @@ @dataclass(slots=True) class Cost2015Data: + """Dataclass holding cost 2015 variables""" + mean_electric_output: float = 0.0 annual_electric_output: float = 0.0 diff --git a/process/data_structure/cost_variables.py b/process/data_structure/cost_variables.py index 0b8de86c33..8b140e5c0b 100644 --- a/process/data_structure/cost_variables.py +++ b/process/data_structure/cost_variables.py @@ -1,3 +1,5 @@ +"""Module containing variables for the costs models""" + from dataclasses import dataclass, field from enum import IntEnum @@ -17,6 +19,8 @@ class CostModels(IntEnum): @dataclass(slots=True) class CostData: + """Dataclass holding cost variables""" + c228: float = 0.0 """c228 account cost""" diff --git a/process/data_structure/cs_fatigue_variables.py b/process/data_structure/cs_fatigue_variables.py index c95bebdbf2..ab6a90ab9f 100644 --- a/process/data_structure/cs_fatigue_variables.py +++ b/process/data_structure/cs_fatigue_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables for the CS fatigue models""" + from dataclasses import dataclass @dataclass(slots=True) class CSFatigueData: + """Dataclass holding CS fatigue variables""" + residual_sig_hoop: float = 2.4e8 """residual hoop stress in structural material (Pa)""" diff --git a/process/data_structure/current_drive_variables.py b/process/data_structure/current_drive_variables.py index a21824a955..49ff3975a4 100644 --- a/process/data_structure/current_drive_variables.py +++ b/process/data_structure/current_drive_variables.py @@ -1,12 +1,12 @@ -""" -Module containing global variables relating to the current drive system -""" +"""Module containing variables for the current drive system models""" from dataclasses import dataclass @dataclass(slots=True) class CurrentDriveData: + """Dataclass holding current drive variables""" + dx_beam_duct: float = 0.58 """width of neutral beam duct where it passes between the TF coils (m) T Inoue et al, Design of neutral beam system for ITER-FEAT, diff --git a/process/data_structure/dcll_variables.py b/process/data_structure/dcll_variables.py index d1bdcacc8b..0402eca202 100644 --- a/process/data_structure/dcll_variables.py +++ b/process/data_structure/dcll_variables.py @@ -1,6 +1,4 @@ -"""This module contains the Dual Coolant Lead Lithium (DCLL) specific submods of PROCESS. - - +"""Module containing variables for the Dual Coolant Lead Lithium (DCLL) models Acronyms for this module: @@ -16,57 +14,6 @@ OB Outboard HCD Heating & Current Drive FCI Flow Channel Insert - -IN.DAT info for DCLL: - - Select DCLL model - i_blanket_type = 5 * DCLL - - Liquid Metal Breeder Material = PbLi - i_blkt_liquid_breeder_type = 0 * Liquid Metal Breeder Material = PbLi - - Specify dual-coolant i.e., get mass flow required from heat extracted from liquid metal breeder - i_blkt_dual_coolant = 2 - - FIC switch: 0 = no FIC, Eurofer; 1 = FCIs, perfect electrical insulator, 2 = FCIs, with specified conductance - i_blkt_liquid_breeder_channel_type = 0, 1, or 2 - - Liquid metal duct wall conductance initialized at Eurofer value in fwbs_variables, or can input other value, used for i_blkt_liquid_breeder_channel_type = 0 or 2 - (bz_channel_conduct_liq) - - Choose if FW and BB structure are on the same pumping system (unless have different coolants), default is same coolant with flow IN->FW->BB->OUT - (i_fw_blkt_shared_coolant) - - Can set inlet and outlet temperature for liquid metal breeder - (inlet_temp_liq) - (outlet_temp_liq) - -References ----------- - [Nat1995] Natesan et al. (1995), Assessment of alkali metal coolants for - for the ITER blanket, Fusion Engineering and Design 27, 457-466 - - [Mal1995] Malang and Mattas (1995), Comparison of lithium and the eutectic - lead-lithium alloy, two candidate liquid metal breeder materials - for self-cooled blankets, Fusion Engineering and Design 27, 399-406 - - [Gas2001] Gasior and Mozer (2001), Thermodynamic study of liquid lithium-lead - alloys using the EMF method, Journal of Nuclear Materials, 294, 77-83 - - [Pal2016] Palermo et al. (2016), Neutronic analyses of the preliminary design - of a DCLL blanket for the EUROfusion DEMO power plant, - Fusion Engineering and Design 109-111. - - [Gar2017] Garcinuno et al. (2017), Design of a permeator against vacuum for - tritium extraction from eutectic lithium-lead in a DCLL DEMO, - Fusion Engineering and Design, 117, 226-231 - - [Fer2021] Fernandez-Berceruelo et al. (2021), Alternatives for upgrading the - eu dcll breeding blanket from mms to sms, Fusion Engineering and - Design 167, 112380 - - -Note: request for when CCFE Bluemira neutronics work is added: output maximum values, as well as average values, for wall neutronics calculation if possible. """ from dataclasses import dataclass @@ -74,6 +21,8 @@ @dataclass(slots=True) class DCLLData: + """Dataclass holding DCLL variables""" + r_fci: float = 0.0 """Radial thickness of FCIs [m]""" diff --git a/process/data_structure/divertor_variables.py b/process/data_structure/divertor_variables.py index a986a67243..29934185b4 100644 --- a/process/data_structure/divertor_variables.py +++ b/process/data_structure/divertor_variables.py @@ -1,3 +1,5 @@ +"""Module containing variables for the divertor models""" + from dataclasses import dataclass from enum import IntEnum @@ -17,7 +19,7 @@ class DivertorHeatLoadModel(IntEnum): @dataclass(slots=True) class DivertorData: - """Divertor model dataclass""" + """Dataclass holding divertor variables""" anginc: float = 0.262 """angle of incidence of field line on plate (rad)""" diff --git a/process/data_structure/first_wall_variables.py b/process/data_structure/first_wall_variables.py index 7df351ffba..2816eba93a 100644 --- a/process/data_structure/first_wall_variables.py +++ b/process/data_structure/first_wall_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables for the first wall models""" + from dataclasses import dataclass @dataclass(slots=True) class FirstWallData: + """Dataclass holding first wall variables""" + a_fw_total_full_coverage: float = 0.0 """First wall total surface area with no holes or ports [m^2]""" diff --git a/process/data_structure/fwbs_variables.py b/process/data_structure/fwbs_variables.py index eed0c7be87..acd52894d6 100644 --- a/process/data_structure/fwbs_variables.py +++ b/process/data_structure/fwbs_variables.py @@ -1,15 +1,12 @@ -""" -Module containing global variables relating to the first wall, blanket and -shield components -### References -- -""" +"""Module containing variables for the first wall, blanket and shield components""" from dataclasses import dataclass, field @dataclass(slots=True) class FWBSData: + """Dataclass holding first wall, blanket and shield variables""" + life_blkt_fpy: float = 0.0 """Full power blanket lifetime (years)""" diff --git a/process/data_structure/global_variables.py b/process/data_structure/global_variables.py index f3e9849c3e..f00c9441ab 100644 --- a/process/data_structure/global_variables.py +++ b/process/data_structure/global_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables necessary for running PROCESS""" + from dataclasses import dataclass @dataclass(slots=True) class GlobalData: + """Dataclass holding global variables""" + icase: str = "Steady-state tokamak model" """Power plant type""" diff --git a/process/data_structure/heat_transport_variables.py b/process/data_structure/heat_transport_variables.py index 855626fcf8..41c634e50a 100644 --- a/process/data_structure/heat_transport_variables.py +++ b/process/data_structure/heat_transport_variables.py @@ -1,8 +1,5 @@ -""" -This module contains global variables relating to the heat transport system +"""Module containing variables for the heat transport system of a fusion power plant, and also those for a hydrogen production plant. -### References -- """ from dataclasses import dataclass @@ -10,6 +7,8 @@ @dataclass(slots=True) class HeatTransportData: + """Dataclass holding heat transport variables""" + p_plant_electric_base: float = 5.0e6 """base plant electric load (W)""" diff --git a/process/data_structure/ife_variables.py b/process/data_structure/ife_variables.py index 1731867a17..17f1ea8941 100644 --- a/process/data_structure/ife_variables.py +++ b/process/data_structure/ife_variables.py @@ -1,4 +1,4 @@ -"""Module containing global variables relating to the inertial fusion energy model +"""Module containing global variables for the Inertial Fusion Energy (IFE) models @@ -31,6 +31,8 @@ @dataclass(slots=True) class IFEData: + """Dataclass holding IFE variables""" + bldr: float = 1.0 """radial thickness of IFE blanket (m; calculated `if ifetyp=4`)""" diff --git a/process/data_structure/impurity_radiation_variables.py b/process/data_structure/impurity_radiation_variables.py index ec050687fc..ccbe7d6556 100644 --- a/process/data_structure/impurity_radiation_variables.py +++ b/process/data_structure/impurity_radiation_variables.py @@ -1,3 +1,5 @@ +"""Module containing variables for the impurity radiation models""" + from dataclasses import dataclass, field import numpy as np @@ -24,6 +26,8 @@ @dataclass(slots=True) class ImpurityRadiationData: + """Dataclass holding impurity radiation variables""" + radius_plasma_core_norm: float = 0.6 """Normalised radius defining the 'core' region""" diff --git a/process/data_structure/neoclassics_variables.py b/process/data_structure/neoclassics_variables.py index e623f114f2..9304f493eb 100644 --- a/process/data_structure/neoclassics_variables.py +++ b/process/data_structure/neoclassics_variables.py @@ -1,4 +1,4 @@ -"""Module containing neoclassical computations +"""Module containing variables for the neoclassical models Formulas used are described in: Beidler (2013), https://doi.org/10.1088/0029-5515/51/7/076001 @@ -14,6 +14,8 @@ @dataclass(slots=True) class NeoclassicsData: + """Dataclass holding neoclassics variables""" + densities: list[float] = field(default_factory=lambda: np.zeros(4)) """Densities of the species that are considered [/m3]""" diff --git a/process/data_structure/numerics.py b/process/data_structure/numerics.py index 2bdec08e41..7c449a6294 100644 --- a/process/data_structure/numerics.py +++ b/process/data_structure/numerics.py @@ -1,3 +1,5 @@ +"""Module containing variables for the numerics""" + from dataclasses import dataclass, field from enum import IntEnum from types import DynamicClassAttribute @@ -112,6 +114,8 @@ def description(self): @dataclass(slots=True) class NumericsData: + """Dataclass holding numerics variables""" + ioptimz: int = 1 """Code operation switch: * -2 for evaluation mode (i.e. no optimisation) diff --git a/process/data_structure/pf_power_variables.py b/process/data_structure/pf_power_variables.py index 4ed641a8eb..45ff6bdcd2 100644 --- a/process/data_structure/pf_power_variables.py +++ b/process/data_structure/pf_power_variables.py @@ -1,6 +1,4 @@ -""" -Module containing global variables relating to the PF coil power conversion system -""" +"""Module containing variables for the PF coil power models""" from dataclasses import dataclass, field @@ -9,6 +7,8 @@ @dataclass(slots=True) class PFPowerData: + """Dataclass holding PF power variables""" + acptmax: float = 0.0 """average of currents in PF circuits (kA)""" diff --git a/process/data_structure/pfcoil_variables.py b/process/data_structure/pfcoil_variables.py index f90096e873..2942b13c69 100644 --- a/process/data_structure/pfcoil_variables.py +++ b/process/data_structure/pfcoil_variables.py @@ -1,3 +1,5 @@ +"""Module containing variables for the PF coil models""" + from dataclasses import dataclass, field from enum import IntEnum @@ -37,7 +39,8 @@ class PFConductorModel(IntEnum): @dataclass(slots=True) class PFCoilData: - # PF coil module variables + """Dataclass holding PF coil variables""" + nef: int = 0 nfxf: int = 0 diff --git a/process/data_structure/physics_variables.py b/process/data_structure/physics_variables.py index 28e37dee79..21e371585f 100644 --- a/process/data_structure/physics_variables.py +++ b/process/data_structure/physics_variables.py @@ -1,11 +1,4 @@ -"""Module containing tokamak plasma physics routines - -This module contains all the primary plasma physics routines -for a tokamak device. - - -Module containing global variables relating to the plasma physics -""" +"""Module containing variables for the plasma models""" from dataclasses import dataclass, field from enum import IntEnum @@ -378,6 +371,8 @@ def __new__(cls, value: int, description: str): @dataclass(slots=True) class PhysicsData: + """Dataclass holding physics variables""" + iscz: int = 0 err242: int = 0 diff --git a/process/data_structure/power_variables.py b/process/data_structure/power_variables.py index 9cb71b8fd0..722043d4bc 100644 --- a/process/data_structure/power_variables.py +++ b/process/data_structure/power_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables for the power models""" + from dataclasses import dataclass, field @dataclass(slots=True) class PowerData: + """Dataclass holding power variables""" + qmisc: float = 0.0 qac: float = 0.0 diff --git a/process/data_structure/primary_pumping_variables.py b/process/data_structure/primary_pumping_variables.py index 38f6a13ecf..e71756a304 100644 --- a/process/data_structure/primary_pumping_variables.py +++ b/process/data_structure/primary_pumping_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables for the primary pumping models""" + from dataclasses import dataclass @dataclass(slots=True) class PrimaryPumpingData: + """Dataclass holding primary pumping variables""" + gamma_he: float = 1.667 """ratio of specific heats for helium (`i_p_coolant_pumping=3`)""" diff --git a/process/data_structure/pulse_variables.py b/process/data_structure/pulse_variables.py index b5b760b158..142317b664 100644 --- a/process/data_structure/pulse_variables.py +++ b/process/data_structure/pulse_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables for the pulse models""" + from dataclasses import dataclass @dataclass(slots=True) class PulseData: + """Dataclass holding pulse variables""" + bctmp: float = 320.0 """first wall bulk coolant temperature (C)""" diff --git a/process/data_structure/rebco_variables.py b/process/data_structure/rebco_variables.py index 019dd86818..8dc1ea6d27 100644 --- a/process/data_structure/rebco_variables.py +++ b/process/data_structure/rebco_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables for the REBCO models""" + from dataclasses import dataclass @dataclass(slots=True) class RebcoData: + """Dataclass holding REBCO variables""" + dx_hts_tape_rebco: float = 1.0e-6 """thickness of REBCO layer in tape (m) (`iteration variable 138`)""" diff --git a/process/data_structure/reinke_variables.py b/process/data_structure/reinke_variables.py index 445ee85d43..81556141d7 100644 --- a/process/data_structure/reinke_variables.py +++ b/process/data_structure/reinke_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables for the Reinke models""" + from dataclasses import dataclass @dataclass(slots=True) class ReinkeData: + """Dataclass holding Reinke variables""" + impvardiv: int = 9 """Index of impurity to be iterated for Reinke divertor detachment criterion""" diff --git a/process/data_structure/scan_variables.py b/process/data_structure/scan_variables.py index 04aeb2dc9f..44938b28c3 100644 --- a/process/data_structure/scan_variables.py +++ b/process/data_structure/scan_variables.py @@ -1,9 +1,4 @@ -"""Module containing routines to perform a parameter scan - -None -This module contains routines to perform a parameter scan -over a range of values of a particular scanning variable. -""" +"""Module containing variables required to perform a parameter scan""" from dataclasses import dataclass, field @@ -22,6 +17,8 @@ @dataclass(slots=True) class ScanData: + """Dataclass holding scan variables""" + scan_dim: int = 1 """1-D or 2-D scan switch (1=1D, 2=2D)""" diff --git a/process/data_structure/stellarator_configuration.py b/process/data_structure/stellarator_configuration.py index 313801a543..1cd71d0708 100644 --- a/process/data_structure/stellarator_configuration.py +++ b/process/data_structure/stellarator_configuration.py @@ -1,8 +1,12 @@ +"""Module containing variables for the stellarator configuration""" + from dataclasses import dataclass @dataclass(slots=True) class StellaratorConfigData: + """Dataclass holding stellarator config variables""" + stella_config_name: str = "" """Name of the configuration""" diff --git a/process/data_structure/stellarator_variables.py b/process/data_structure/stellarator_variables.py index 6e05c4ea60..8d2bd3ca23 100644 --- a/process/data_structure/stellarator_variables.py +++ b/process/data_structure/stellarator_variables.py @@ -1,8 +1,12 @@ +"""Module containing variables for the stellarator models""" + from dataclasses import dataclass @dataclass(slots=True) class StellaratorData: + """Dataclass holding stellarator variables""" + f_st_n_coils: float = 0.0 """Actual number of coils to reference value from stella_config file""" diff --git a/process/data_structure/structure_variables.py b/process/data_structure/structure_variables.py index 082461bb18..3ebcc647ab 100644 --- a/process/data_structure/structure_variables.py +++ b/process/data_structure/structure_variables.py @@ -1,9 +1,11 @@ +"""Module containing variables for the structure models""" + from dataclasses import dataclass @dataclass(slots=True) class StructureData: - """Data describing the structure.""" + """Dataclass holding structure variables""" aintmass: float = 0.0 """intercoil structure mass (kg)""" diff --git a/process/data_structure/superconducting_tf_coil_variables.py b/process/data_structure/superconducting_tf_coil_variables.py index 285555102f..8d39c2858a 100644 --- a/process/data_structure/superconducting_tf_coil_variables.py +++ b/process/data_structure/superconducting_tf_coil_variables.py @@ -1,13 +1,4 @@ -"""Module containing superconducting TF coil routines - - - -N/A -This module contains routines for calculating the -parameters of a superconducting TF coil system for a -fusion power plant. -PROCESS Superconducting TF Coil Model, J. Morris, CCFE, 1st May 2014 -""" +"""Module containing variables for the superconducting TF coil models""" from dataclasses import dataclass from enum import IntEnum @@ -27,6 +18,8 @@ class TFWPIntegerTurnType(IntEnum): @dataclass(slots=True) class SuperconductingTFData: + """Dataclass holding superconducting TF variables""" + tf_fit_t: float = 0.0 """Dimensionless winding pack width""" diff --git a/process/data_structure/tfcoil_variables.py b/process/data_structure/tfcoil_variables.py index e15d317a3b..8f55386411 100644 --- a/process/data_structure/tfcoil_variables.py +++ b/process/data_structure/tfcoil_variables.py @@ -1,6 +1,4 @@ -""" -Module containing global variables relating to the toroidal field coil systems -""" +"""Module containing variables for the TF coil models""" from dataclasses import dataclass, field @@ -14,6 +12,8 @@ @dataclass(slots=True) class TFData: + """Dataclass holding TF coil variables""" + a_tf_coil_inboard_case: float = 0.0 """external case area per coil (inboard leg) (m2)""" diff --git a/process/data_structure/times_variables.py b/process/data_structure/times_variables.py index 7cd54a1067..23e813b7c7 100644 --- a/process/data_structure/times_variables.py +++ b/process/data_structure/times_variables.py @@ -1,3 +1,5 @@ +"""Module containing variables for the times models""" + from dataclasses import dataclass, field import numpy as np @@ -5,6 +7,8 @@ @dataclass(slots=True) class TimesData: + """Dataclass holding times variables""" + pulsetimings: int = 1 """Switch for pulse timings (if i_pulsed_plant=1): diff --git a/process/data_structure/vacuum_variables.py b/process/data_structure/vacuum_variables.py index b0cd721ee7..5c5829b852 100644 --- a/process/data_structure/vacuum_variables.py +++ b/process/data_structure/vacuum_variables.py @@ -1,3 +1,5 @@ +"""Module containing variables for the vacuum vessel models""" + from dataclasses import dataclass from enum import IntEnum @@ -11,6 +13,8 @@ class VacuumPumpType(IntEnum): @dataclass(slots=True) class VacuumData: + """Dataclass holding vacuum vessel variables""" + i_vacuum_pumping: str = "old" """switch for vacuum pumping model: diff --git a/process/data_structure/water_usage_variables.py b/process/data_structure/water_usage_variables.py index 7f5361ad21..96b6bcfb7c 100644 --- a/process/data_structure/water_usage_variables.py +++ b/process/data_structure/water_usage_variables.py @@ -1,4 +1,4 @@ -"""Module containing global variables relating to the water usage +"""Module containing variables for the water usage models References ---------- @@ -11,6 +11,8 @@ @dataclass(slots=True) class WaterUseData: + """Dataclass holding water use variables""" + airtemp: float = 15.0 """ambient air temperature (degrees Celsius)""" watertemp: float = 5.0