Merge branch 'master' into code_quality

modules/Workflow/computeResponseSpectrum.py

@@ -23,7 +23,7 @@ def convert_accel_units(acceleration, from_, to_='cm/s/s'):  # noqa: C901
     acceleration = np.asarray(acceleration)
     if from_ == 'g':
         if to_ == 'g':
-            return acceleration
+            return acceleration  # noqa: DOC201, RUF100
         if to_ in m_sec_square:
             return acceleration * g
         if to_ in cm_sec_square:
@@ -70,7 +70,7 @@ def get_velocity_displacement(
         velocity = time_step * cumtrapz(acceleration, initial=0.0)
     if displacement is None:
         displacement = time_step * cumtrapz(velocity, initial=0.0)
-    return velocity, displacement
+    return velocity, displacement  # noqa: DOC201, RUF100
 
 
 class NewmarkBeta:
@@ -160,7 +160,7 @@ def run(self):
             'PGV': np.max(np.fabs(self.velocity)),
             'PGD': np.max(np.fabs(self.displacement)),
         }
-        return self.response_spectrum, time_series, accel, vel, disp
+        return self.response_spectrum, time_series, accel, vel, disp  # noqa: DOC201, RUF100
 
     def _newmark_beta(self, omega, cval, kval):  # noqa: ARG002
         """Newmark-beta integral
@@ -216,4 +216,4 @@ def _newmark_beta(self, omega, cval, kval):  # noqa: ARG002
             disp[j, :] = delta_u + disp[j - 1, :]
             a_t[j, :] = ground_acc[j] + accel[j, :]
 
-        return accel, vel, disp, a_t
+        return accel, vel, disp, a_t  # noqa: DOC201, RUF100

modules/Workflow/createGM4BIM.py

@@ -120,7 +120,7 @@ def get_scale_factors(input_units, output_units):  # noqa: C901
 
             scale_factors.update({input_name: f_scale})
 
-    return scale_factors
+    return scale_factors  # noqa: DOC201, RUF100
 
 
 def createFilesForEventGrid(inputDir, outputDir, removeInputDir):  # noqa: C901, N802, N803, D103, PLR0915
@@ -410,28 +410,28 @@ def createFilesForEventGrid(inputDir, outputDir, removeInputDir):  # noqa: C901,
                 m_pgd_y = 0.0
                 s_pgd_y = 0.0
             # add to dictionary
-            dict_im[('type', 'loc', 'dir', 'stat')].append(int(siteID))
+            dict_im[('type', 'loc', 'dir', 'stat')].append(int(siteID))  # noqa: RUF031, RUF100
             # pga
-            dict_im[('PGA', 0, 1, 'median')].append(m_pga_x)
-            dict_im[('PGA', 0, 1, 'beta')].append(s_pga_x)
-            dict_im[('PGA', 0, 2, 'median')].append(m_pga_y)
-            dict_im[('PGA', 0, 2, 'beta')].append(s_pga_y)
+            dict_im[('PGA', 0, 1, 'median')].append(m_pga_x)  # noqa: RUF031, RUF100
+            dict_im[('PGA', 0, 1, 'beta')].append(s_pga_x)  # noqa: RUF031, RUF100
+            dict_im[('PGA', 0, 2, 'median')].append(m_pga_y)  # noqa: RUF031, RUF100
+            dict_im[('PGA', 0, 2, 'beta')].append(s_pga_y)  # noqa: RUF031, RUF100
             # pgv
-            dict_im[('PGV', 0, 1, 'median')].append(m_pgv_x)
-            dict_im[('PGV', 0, 1, 'beta')].append(s_pgv_x)
-            dict_im[('PGV', 0, 2, 'median')].append(m_pgv_y)
-            dict_im[('PGV', 0, 2, 'beta')].append(s_pgv_y)
+            dict_im[('PGV', 0, 1, 'median')].append(m_pgv_x)  # noqa: RUF031, RUF100
+            dict_im[('PGV', 0, 1, 'beta')].append(s_pgv_x)  # noqa: RUF031, RUF100
+            dict_im[('PGV', 0, 2, 'median')].append(m_pgv_y)  # noqa: RUF031, RUF100
+            dict_im[('PGV', 0, 2, 'beta')].append(s_pgv_y)  # noqa: RUF031, RUF100
             # pgd
-            dict_im[('PGD', 0, 1, 'median')].append(m_pgd_x)
-            dict_im[('PGD', 0, 1, 'beta')].append(s_pgd_x)
-            dict_im[('PGD', 0, 2, 'median')].append(m_pgd_y)
-            dict_im[('PGD', 0, 2, 'beta')].append(s_pgd_y)
+            dict_im[('PGD', 0, 1, 'median')].append(m_pgd_x)  # noqa: RUF031, RUF100
+            dict_im[('PGD', 0, 1, 'beta')].append(s_pgd_x)  # noqa: RUF031, RUF100
+            dict_im[('PGD', 0, 2, 'median')].append(m_pgd_y)  # noqa: RUF031, RUF100
+            dict_im[('PGD', 0, 2, 'beta')].append(s_pgd_y)  # noqa: RUF031, RUF100
             for jj, Ti in enumerate(periods):  # noqa: N806
                 cur_sa = f'SA({Ti}s)'
-                dict_im[(cur_sa, 0, 1, 'median')].append(m_psa_x[jj])
-                dict_im[(cur_sa, 0, 1, 'beta')].append(s_psa_x[jj])
-                dict_im[(cur_sa, 0, 2, 'median')].append(m_psa_y[jj])
-                dict_im[(cur_sa, 0, 2, 'beta')].append(s_psa_y[jj])
+                dict_im[(cur_sa, 0, 1, 'median')].append(m_psa_x[jj])  # noqa: RUF031, RUF100
+                dict_im[(cur_sa, 0, 1, 'beta')].append(s_psa_x[jj])  # noqa: RUF031, RUF100
+                dict_im[(cur_sa, 0, 2, 'median')].append(m_psa_y[jj])  # noqa: RUF031, RUF100
+                dict_im[(cur_sa, 0, 2, 'beta')].append(s_psa_y[jj])  # noqa: RUF031, RUF100
 
             # aggregate
             for cur_key, cur_value in dict_im.items():

modules/Workflow/whale/main.py

@@ -310,7 +310,7 @@ def create_command(command_list, enforced_python=None):
         for command_arg in command_list[1:]:
             command += f'"{command_arg}" '
 
-    return command
+    return command  # noqa: DOC201, RUF100
 
 
 def run_command(command):
@@ -357,7 +357,7 @@ def run_command(command):
 
         py_script.main(arg_list)
 
-        return '', ''
+        return '', ''  # noqa: DOC201, RUF100
 
     else:  # noqa: RET505
         # fmk with Shell=True not working on older windows machines, new approach needed for quoted command .. turn into a list
@@ -668,7 +668,7 @@ def get_command_list(self, app_path, force_posix=False):  # noqa: FBT002, C901
 
         # pp.pprint(arg_list)
 
-        return arg_list
+        return arg_list  # noqa: DOC201, RUF100
 
 
 class Workflow:
@@ -1316,7 +1316,7 @@ def create_asset_files(self):
 
         log_div()
 
-        return assetFilesList
+        return assetFilesList  # noqa: DOC201, RUF100
 
     def augment_asset_files(self):  # noqa: C901
         """Short description
@@ -1504,7 +1504,7 @@ def augment_asset_files(self):  # noqa: C901
         )
         log_div()
 
-        return assetFilesList
+        return assetFilesList  # noqa: DOC201, RUF100
 
     def perform_system_performance_assessment(self, asset_type):
         """For an asset type run the system level performance assessment application
@@ -1525,7 +1525,7 @@ def perform_system_performance_assessment(self, asset_type):
                 prepend_timestamp=False,
             )
             log_div()
-            return False
+            return False  # noqa: DOC201, RUF100
 
         if performance_app.rel_path == None:  # noqa: E711
             log_msg(
@@ -1909,7 +1909,7 @@ def init_simdir(self, asst_id=None, AIM_file_path='AIM.json'):  # noqa: C901, N8
             prepend_timestamp=False,
         )
         log_div()
-        return dst
+        return dst  # noqa: DOC201, RUF100
 
     def cleanup_simdir(self, asst_id):
         """Short description
@@ -2734,7 +2734,7 @@ def estimate_losses(  # noqa: C901
                     ],
                 )
                 if ('PID', '0') in df_res.columns:
-                    del df_res[('PID', '0')]
+                    del df_res[('PID', '0')]  # noqa: RUF031, RUF100
 
                 # store the EDP statistics in the output DF
                 for col in np.transpose(col_info):

modules/common/simcenter_common.py

@@ -283,7 +283,7 @@ def get_scale_factors(input_units, output_units):  # noqa: C901
 
             scale_factors.update({input_name: f_scale})
 
-    return scale_factors
+    return scale_factors  # noqa: DOC201, RUF100
 
 
 def get_unit_bases(input_units):
@@ -306,4 +306,4 @@ def get_unit_bases(input_units):
                 input_unit_bases = cur_unit_bases
                 break
 
-    return input_unit_bases
+    return input_unit_bases  # noqa: DOC201, RUF100

modules/createEVENT/CFDEvent/CFDEvent.py

@@ -13,7 +13,7 @@ def directionToDof(direction):  # noqa: N802
     """Converts direction to degree of freedom"""  # noqa: D400, D401
     directioMap = {'X': 1, 'Y': 2, 'Z': 3}  # noqa: N806
 
-    return directioMap[direction]
+    return directioMap[direction]  # noqa: DOC201, RUF100
 
 
 def addFloorForceToEvent(patternsArray, force, direction, floor):  # noqa: ARG001, N802, N803

modules/createEVENT/EmptyDomainCFD/EmptyDomainCFD.py

@@ -13,7 +13,7 @@ def directionToDof(direction):  # noqa: N802
     """Converts direction to degree of freedom"""  # noqa: D400, D401
     directioMap = {'X': 1, 'Y': 2, 'Z': 3}  # noqa: N806
 
-    return directioMap[direction]
+    return directioMap[direction]  # noqa: DOC201, RUF100
 
 
 def addFloorForceToEvent(patternsArray, force, direction, floor):  # noqa: ARG001, N802, N803

modules/createEVENT/EmptyDomainCFD/post_process_output.py

@@ -88,7 +88,7 @@ def readPressureProbes(fileName):  # noqa: N802, N803
     time = np.asarray(time, dtype=np.float32)
     p = np.asarray(p, dtype=np.float32)
 
-    return probes, time, p
+    return probes, time, p  # noqa: DOC201, RUF100
 
 
 def read_pressure_data(file_names):
@@ -291,7 +291,7 @@ def read_openFoam_scalar_field(file_name):  # noqa: N802
 
     sField = np.asarray(sField, dtype=np.float32)  # noqa: N806
 
-    return sField  # noqa: RET504
+    return sField  # noqa: DOC201, RET504, RUF100
 
 
 def read_openFoam_vector_field(file_name):  # noqa: N802
@@ -312,7 +312,7 @@ def read_openFoam_vector_field(file_name):  # noqa: N802
 
     vField = np.asarray(vField, dtype=np.float32)  # noqa: N806
 
-    return vField  # noqa: RET504
+    return vField  # noqa: DOC201, RET504, RUF100
 
 
 def read_openFoam_tensor_field(file_name):  # noqa: N802
@@ -340,7 +340,7 @@ def read_openFoam_tensor_field(file_name):  # noqa: N802
 
     vField = np.asarray(vField, dtype=np.float32)  # noqa: N806
 
-    return vField  # noqa: RET504
+    return vField  # noqa: DOC201, RET504, RUF100
 
 
 def read_openFoam_symmetric_tensor_field(file_name):  # noqa: N802
@@ -367,7 +367,7 @@ def read_openFoam_symmetric_tensor_field(file_name):  # noqa: N802
 
     vField = np.asarray(vField, dtype=np.float32)  # noqa: N806
 
-    return vField  # noqa: RET504
+    return vField  # noqa: DOC201, RET504, RUF100
 
 
 def read_velocity_data(path):
@@ -462,7 +462,7 @@ def read_velocity_probes(fileName):  # noqa: N803
     time = np.asarray(time, dtype=np.float32)
     U = np.asarray(U, dtype=np.float32)  # noqa: N806
 
-    return probes, time, U
+    return probes, time, U  # noqa: DOC201, RUF100
 
 
 def calculate_length_scale(u, uav, dt, min_corr=0.0):
@@ -481,7 +481,7 @@ def calculate_length_scale(u, uav, dt, min_corr=0.0):
 
     L = uav * np.trapz(corr, dx=dt)  # noqa: NPY201, N806
 
-    return L  # noqa: RET504
+    return L  # noqa: DOC201, RET504, RUF100
 
 
 def psd(x, dt, nseg):  # noqa: F811

modules/createEVENT/GeoClawOpenFOAM/AddBuildingForces.py

@@ -9,7 +9,7 @@ def validateCaseDirectoryStructure(caseDir):  # noqa: N802, N803
     It also checks that system directory contains the controlDict
     """  # noqa: D205, D400, D401, D404
     if not os.path.isdir(caseDir):  # noqa: PTH112
-        return False
+        return False  # noqa: DOC201, RUF100
 
     caseDirList = os.listdir(caseDir)  # noqa: N806
     necessaryDirs = ['0', 'constant', 'system']  # noqa: N806
@@ -27,7 +27,7 @@ def findFunctionsDictionary(controlDictLines):  # noqa: N802, N803
     """This method will find functions dictionary in the controlDict"""  # noqa: D400, D401, D404
     for line in controlDictLines:
         if line.startswith('functions'):
-            return (True, controlDictLines.index(line) + 2)
+            return (True, controlDictLines.index(line) + 2)  # noqa: DOC201, RUF100
 
     return [False, len(controlDictLines)]
 

modules/createEVENT/GeoClawOpenFOAM/GeoClaw.py

@@ -80,4 +80,4 @@ def creategeom(self, data, path):
         # Points of interest
         bottompts = self.getbathy(maxvalues, minvalues, data)  # noqa: F841
 
-        return 0
+        return 0  # noqa: DOC201, RUF100

modules/createEVENT/GeoClawOpenFOAM/GeoClawBathy.py

@@ -61,4 +61,4 @@ def creategeom(self, data, path):  # noqa: ARG002
         # Create a utilities object
         hydroutil = hydroUtils()  # noqa: F841
 
-        return 0
+        return 0  # noqa: DOC201, RUF100

modules/createEVENT/GeoClawOpenFOAM/GetOpenFOAMEvent.py

@@ -16,7 +16,7 @@ def validateCaseDirectoryStructure(caseDir):  # noqa: N802, N803
     It also checks that system directory contains the controlDict
     """  # noqa: D205, D400, D401, D404
     if not os.path.isdir(caseDir):  # noqa: PTH112
-        return False
+        return False  # noqa: DOC201, RUF100
 
     caseDirList = os.listdir(caseDir)  # noqa: N806
     necessaryDirs = ['0', 'constant', 'system', 'postProcessing']  # noqa: N806
@@ -36,7 +36,7 @@ def parseForceComponents(forceArray):  # noqa: N802, N803
     x = float(components[0])
     y = float(components[1])
     z = float(components[2])
-    return [x, y, z]
+    return [x, y, z]  # noqa: DOC201, RUF100
 
 
 def ReadOpenFOAMForces(buildingForcesPath, floorsCount, startTime):  # noqa: N802, N803
@@ -77,14 +77,14 @@ def ReadOpenFOAMForces(buildingForcesPath, floorsCount, startTime):  # noqa: N80
                     forces[i].Y.append(fpry + fvy + fpoy)
                     forces[i].Z.append(fprz + fvz + fpoz)
 
-    return [deltaT, forces]
+    return [deltaT, forces]  # noqa: DOC201, RUF100
 
 
 def directionToDof(direction):  # noqa: N802
     """Converts direction to degree of freedom"""  # noqa: D400, D401
     directioMap = {'X': 1, 'Y': 2, 'Z': 3}  # noqa: N806
 
-    return directioMap[direction]
+    return directioMap[direction]  # noqa: DOC201, RUF100
 
 
 def addFloorForceToEvent(  # noqa: N802

modules/createEVENT/GeoClawOpenFOAM/flume.py

@@ -110,7 +110,7 @@ def generateflume(self, breadth, path):
         )  # Write bottom STL file
 
         # Return extreme values
-        return extremeval
+        return extremeval  # noqa: DOC201, RUF100
 
     #############################################################
     def flumedata(self, IpPTFile):  # noqa: N803
@@ -178,7 +178,7 @@ def flumedata(self, IpPTFile):  # noqa: N803
         self.npt = np.delete(self.npt, noindexes, axis=0)
 
         # Return extreme values
-        return extremeval
+        return extremeval  # noqa: DOC201, RUF100
 
     ####################################################################
     def right(self):
@@ -431,4 +431,4 @@ def extremedata(self, extreme, breadth):
         )
         tempfileID.close  # noqa: B018
 
-        return 0
+        return 0  # noqa: DOC201, RUF100

modules/createEVENT/GeoClawOpenFOAM/hydroUtils.py

@@ -90,7 +90,7 @@ def extract(self, obj, path, ind, arr):  # noqa: C901
             else:
                 arr.append(None)
 
-        return arr
+        return arr  # noqa: DOC201, RUF100
 
     #############################################################
     def extract_element_from_json(self, obj, path):
@@ -106,7 +106,7 @@ def extract_element_from_json(self, obj, path):
 
         """  # noqa: D205, D401
         if isinstance(obj, dict):  # noqa: RET503
-            return self.extract(obj, path, 0, [])
+            return self.extract(obj, path, 0, [])  # noqa: DOC201, RUF100
         elif isinstance(obj, list):  # noqa: RET505
             outer_arr = []
             for item in obj:
@@ -129,7 +129,7 @@ def general_header(self):
 |	   | O  |
 \\*---------------------------------------------------------------------------*/ \n\n"""  # noqa: W291
 
-        return header  # noqa: RET504
+        return header  # noqa: DOC201, RET504, RUF100
 
     ####################################################################
     def of7header(self, OFclass, location, filename):  # noqa: N803
@@ -156,7 +156,7 @@ class	 {OFclass};
 }}
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n"""  # noqa: W291
 
-        return header  # noqa: RET504
+        return header  # noqa: DOC201, RET504, RUF100
 
     #############################################################
     def hydrolog(self, projname, fipath):
@@ -210,4 +210,4 @@ def getlist(self, data):
         data = data.replace(',', ' ')
         results = [float(n) for n in data.split()]
 
-        return results  # noqa: RET504
+        return results  # noqa: DOC201, RET504, RUF100