Minor changes to comments and .gitignore

Author: SHerrboldt

src/geophires_monte_carlo/MC_GeoPHIRES3.py

@@ -342,7 +342,7 @@ def main(command_line_args=None):
     # get the values off the command line
     parser = argparse.ArgumentParser()
     parser.add_argument('Code_File', help='Code File')
-    parser.add_argument('Input_file', help='Input file')
+    parser.add_argument('Input_file', help='Inputs file')
     parser.add_argument('MC_Settings_file', help='MC Settings file')
     parser.add_argument('MC_OUTPUT_FILE', help='Output file', nargs='?')
 
@@ -448,7 +448,7 @@ def main(command_line_args=None):
         if '-9999.0' not in line and len(s) > 1:
             line = line.strip()
             if len(line) > 10:
-                line, sep, tail = line.partition(', (')  # strip off the Input Variable Values
+                line, sep, tail = line.partition(', (')  # strip off the Inputs Variable Values
                 line = line.replace('(', '').replace(')', '')  # strip off the ()
                 results.append([float(y) for y in line.split(',')])
         else:

src/geophires_x/.gitignore

@@ -135,8 +135,8 @@ Examples\Test2.json
 /temperature.txt
 all_messages_conf.log
 
-Doublet.dat
-Doublet.out
+Doublet_default.dat
+
 FOFT_A3Q23.csv
 FOFT_A3Q28.csv
 GENER

src/geophires_x/CylindricalReservoir.py

@@ -42,7 +42,7 @@ def __init__(self, model: Model):
         super().__init__(model)  # initialize the parent parameters and variables
 
         self.InputDepth = self.ParameterDict[self.InputDepth.Name] = floatParameter(
-            "Cylindrical Reservoir Input Depth",
+            "Cylindrical Reservoir Inputs Depth",
             DefaultValue=3.0,
             Min=0.1,
             Max=15,
@@ -182,7 +182,7 @@ def read_parameters(self, model: Model) -> None:
                     # Just handle special cases for this class - the call to super set all the values,
                     # including the value unique to this class.
 
-                    if ParameterToModify.Name == 'Cylindrical Reservoir Input Depth':
+                    if ParameterToModify.Name == 'Cylindrical Reservoir Inputs Depth':
                         if 'Cylindrical Reservoir Output Depth' not in model.InputParameters:
                             # If input depth is set and not output, assume output is the same as input
                             self.OutputDepth.value = self.InputDepth.value

src/geophires_x/GeoPHIRESUtils.py

@@ -252,7 +252,7 @@ def density_water_kg_per_m3(Twater_degC: float, pressure: Optional[PlainQuantity
             return CP.PropsSI('D', 'T', celsius_to_kelvin(Twater_degC), 'Q', 0, 'Water')
 
     except (NotImplementedError, ValueError) as e:
-        raise ValueError(f'Input temperature & pressure ({Twater_degC}, {pressure}) '
+        raise ValueError(f'Inputs temperature & pressure ({Twater_degC}, {pressure}) '
                          f'are out of range or otherwise could not be used to calculate water density.') from e
 
 
@@ -298,7 +298,7 @@ def viscosity_water_Pa_sec(
             return CP.PropsSI('V', 'T', celsius_to_kelvin(Twater_degC), 'Q', 0, 'Water')
 
     except (NotImplementedError, ValueError) as e:
-        raise ValueError(f'Input temperature & pressure ({Twater_degC}, {pressure}) '
+        raise ValueError(f'Inputs temperature & pressure ({Twater_degC}, {pressure}) '
                          f'are out of range or otherwise could not be used to calculate water viscosity.') from e
 
 
@@ -334,7 +334,7 @@ def heat_capacity_water_J_per_kg_per_K(
             return CP.PropsSI('C', 'T', celsius_to_kelvin(Twater_degC), 'Q', 0, 'Water')
 
     except (NotImplementedError, ValueError) as e:
-        raise ValueError(f'Input temperature & pressure ({Twater_degC}, {pressure}) '
+        raise ValueError(f'Inputs temperature & pressure ({Twater_degC}, {pressure}) '
                          f'are out of range or otherwise could not be used to calculate heat capacity of water.') from e
 
 
@@ -384,16 +384,16 @@ def vapor_pressure_water_kPa(temperature_degC: float) -> float:
     """
 
     if not isinstance(temperature_degC, (int, float)):
-        raise ValueError(f'Input temperature ({temperature_degC}) must be a number')
+        raise ValueError(f'Inputs temperature ({temperature_degC}) must be a number')
     if temperature_degC < 0:
-        raise ValueError(f'Input temperature ({temperature_degC}C) must be greater than or equal to 0')
+        raise ValueError(f'Inputs temperature ({temperature_degC}C) must be greater than or equal to 0')
 
     try:
         return (quantity(CP.PropsSI('P', 'T', celsius_to_kelvin(temperature_degC), 'Q', 0, 'Water'), 'Pa')
                     .to('kPa').magnitude)
 
     except (NotImplementedError, ValueError) as e:
-        raise ValueError(f'Input temperature ({temperature_degC}C) is out of range or otherwise not implemented') from e
+        raise ValueError(f'Inputs temperature ({temperature_degC}C) is out of range or otherwise not implemented') from e
 
 
 @lru_cache
@@ -414,7 +414,7 @@ def entropy_water_kJ_per_kg_per_K(temperature_degC: float, pressure: Optional[Pl
     try:
         temperature_degC = float(temperature_degC)
     except ValueError:
-        raise TypeError(f'Input temperature ({temperature_degC}) must be a float')
+        raise TypeError(f'Inputs temperature ({temperature_degC}) must be a float')
 
     try:
         if pressure is not None:
@@ -423,7 +423,7 @@ def entropy_water_kJ_per_kg_per_K(temperature_degC: float, pressure: Optional[Pl
         else:
             return CP.PropsSI('S', 'T', celsius_to_kelvin(temperature_degC), 'Q', 0, 'Water') * 1e-3
     except (NotImplementedError, ValueError) as e:
-        raise ValueError(f'Input temperature {temperature_degC} is out of range or otherwise not implemented') from e
+        raise ValueError(f'Inputs temperature {temperature_degC} is out of range or otherwise not implemented') from e
 
 
 @lru_cache
@@ -444,7 +444,7 @@ def enthalpy_water_kJ_per_kg(temperature_degC: float, pressure: Optional[PlainQu
     try:
         temperature_degC = float(temperature_degC)
     except ValueError:
-        raise TypeError(f'Input temperature ({temperature_degC}) must be a float')
+        raise TypeError(f'Inputs temperature ({temperature_degC}) must be a float')
 
     try:
         if pressure is not None:
@@ -454,7 +454,7 @@ def enthalpy_water_kJ_per_kg(temperature_degC: float, pressure: Optional[PlainQu
             return CP.PropsSI('H', 'T', celsius_to_kelvin(temperature_degC), 'Q', 0, 'Water') * 1e-3
 
     except (NotImplementedError, ValueError) as e:
-        raise ValueError(f'Input temperature {temperature_degC} is out of range or otherwise not implemented') from e
+        raise ValueError(f'Inputs temperature {temperature_degC} is out of range or otherwise not implemented') from e
 
 
 @lru_cache
@@ -471,7 +471,7 @@ def UtilEff_func(temperature_degC: float) -> float:
     """
 
     if not isinstance(temperature_degC, (int, float)):
-        raise ValueError(f'Input temperature ({temperature_degC}) must be a number')
+        raise ValueError(f'Inputs temperature ({temperature_degC}) must be a number')
 
     if temperature_degC < _T[0] or temperature_degC > _T[-1]:
         raise ValueError(f'Temperature ({temperature_degC}) must be within the range of {_T[0]} to {_T[-1]} degrees C.')
@@ -502,7 +502,7 @@ def read_input_file(return_dict_1, logger=None, input_file_name=None):
 
     # read input data (except input from optional filenames)
     if input_file_name is None:
-        logger.warning('Input file name not provided, checking sys.argv')
+        logger.warning('Inputs file name not provided, checking sys.argv')
         if len(sys.argv) > 1:
             input_file_name = sys.argv[1]
             logger.warning(f'Using input file from sys.argv: {input_file_name}')

src/geophires_x/OptionList.py

@@ -5,7 +5,7 @@
 
 class GeophiresInputEnum(str, Enum):
     """
-    Input enums have a name, integer input value, and string value
+    Inputs enums have a name, integer input value, and string value
 
     TODO implement from_int/from_input_string here instead of child classes
     """

src/geophires_x/Reservoir.py

@@ -289,7 +289,7 @@ def __init__(self, model: Model):
         self.fracnumb = self.ParameterDict[self.fracnumb.Name] = intParameter(
             "Number of Fractures",
             DefaultValue=10,
-            AllowableRange=list(range(1, 150, 1)),
+            AllowableRange=list(range(1, 99999, 1)),
             UnitType=Units.NONE,
             ErrMessage="assume default number of fractures (10)",
             ToolTipText="Number of identical parallel fractures in EGS fracture-based reservoir model."

src/geophires_x/SBTReservoir.py

@@ -388,7 +388,7 @@ def Calculate_Coaxial(self, model):
         # SBT v2 for co-axial heat exchanger with high-temperature capability
         # last update: January 14th, 2024
 
-        # 1. Input
+        # 1. Inputs
         # Generally, the user should only make changes to this section
 
         fluid = 1  # Heat transfer fluid selection: 1 = H2O; 2 = CO2

src/geophires_x/SurfacePlantAGS.py

@@ -129,7 +129,7 @@ def __init__(self, model: Model):
             ErrMessage="assume default Dead-state pressure (1e5 Pa)"
         )
 
-        # Input data for electricity generation with CO2
+        # Inputs data for electricity generation with CO2
         self.Turbine_isentropic_efficiency = self.ParameterDict[
             self.Turbine_isentropic_efficiency.Name] = floatParameter(
             "Isentropic Efficiency for CO2 Turbine",

src/geophires_x/SurfacePlantAbsorptionChiller.py

@@ -36,7 +36,7 @@ def __init__(self, model: Model):
         self.MyClass = self.__class__.__name__
         self.MyPath = __file__
 
-        # Input parameters absorption chiller
+        # Inputs parameters absorption chiller
         self.absorption_chiller_cop = self.ParameterDict[self.absorption_chiller_cop.Name] = floatParameter(
             "Absorption Chiller COP",
             value=0.7,

src/geophires_x/WellBores.py

@@ -443,7 +443,6 @@ def get_hydrostatic_pressure_kPa(
     https://workingincaes.inl.gov/SiteAssets/CAES%20Files/FORGE/inl_ext-16-38751%20GETEM%20User%20Manual%20Final.pdf
     """
     CP = 4.64E-7
-    #CP = 9.51E-2
     CT = 9E-4 / (30.796 * Trock_degC ** (-0.552))
     return 0 + 1. / CP * (math.exp(
         density_water_kg_per_m3(Tsurf_degC, pressure=lithostatic_pressure) * 9.81 * CP / 1000 * (
@@ -1011,7 +1010,7 @@ def __init__(self, model: Model):
             ToolTipText='; '.join([f'{it.int_value}: {it.value}' for it in WorkingFluid])
         )
 
-        # Input data for subsurface condition
+        # Inputs data for subsurface condition
         self.Nonvertical_length = self.ParameterDict[self.Nonvertical_length.Name] = floatParameter(
             "Nonvertical Length per Multilateral Section",
             DefaultValue=1000.0,