fiqus 2026.1.0__py3-none-any.whl → 2026.1.2__py3-none-any.whl

tests/utils/generate_reference_files_ConductorAC.py

@@ -1,57 +1,57 @@
-import os
-import shutil
-import sys
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '../../'))) # Add the path to the fiqus package to the system path
-from fiqus.data.DataFiQuS import FDM
-from fiqus.utils.Utils import FilesAndFolders as Util
-from fiqus import MainFiQuS as mf
-
-
-# Generate reference files for the models below:
-model_names = [
-    "TEST_CAC_Strand_adaptiveMesh",
-    "TEST_CAC_Strand_hexFilaments",
-    "TEST_CAC_wireInChannel",
-]
-# The run types for the models above:
-run_types = [
-    'geometry_and_mesh', 
-    'start_from_yaml', 
-    'start_from_yaml',
-]
-
-for model_name, run_type in zip(model_names, run_types):
-    # get path to the input file:
-    input_file = os.path.join(
-        os.path.dirname(os.path.dirname(__file__)),
-        "_inputs",
-        model_name,
-        f"{model_name}.yaml",
-    )
-
-    # select _references folder as the output folder:
-    output_folder = os.path.join(
-        os.path.dirname(os.path.dirname(__file__)), "_references", model_name
-    )
-
-    # if the output folder exists, remove it:
-    if os.path.exists(output_folder):
-        shutil.rmtree(output_folder)
-
-    # Create the output folder:
-    os.makedirs(output_folder)
-
-    # Cast input yaml file to FDM
-    data_model: FDM = Util.read_data_from_yaml(input_file, FDM)
-
-    data_model.run.overwrite = True
-
-    # Make the run type start_from_yaml:
-    data_model.run.type = run_type
-
-    fiqus_instance = mf.MainFiQuS(
-        fdm=data_model, model_folder=output_folder, input_file_path=input_file
-    )
-
-    # remove fiqus_instance to avoid memory issues:
-    del fiqus_instance
+import os
+import shutil
+import sys
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '../../'))) # Add the path to the fiqus package to the system path
+from fiqus.data.DataFiQuS import FDM
+from fiqus.utils.Utils import FilesAndFolders as Util
+from fiqus import MainFiQuS as mf
+
+
+# Generate reference files for the models below:
+model_names = [
+    "TEST_CAC_Strand_adaptiveMesh",
+    "TEST_CAC_Strand_hexFilaments",
+    "TEST_CAC_wireInChannel",
+]
+# The run types for the models above:
+run_types = [
+    'geometry_and_mesh', 
+    'start_from_yaml', 
+    'start_from_yaml',
+]
+
+for model_name, run_type in zip(model_names, run_types):
+    # get path to the input file:
+    input_file = os.path.join(
+        os.path.dirname(os.path.dirname(__file__)),
+        "_inputs",
+        model_name,
+        f"{model_name}.yaml",
+    )
+
+    # select _references folder as the output folder:
+    output_folder = os.path.join(
+        os.path.dirname(os.path.dirname(__file__)), "_references", model_name
+    )
+
+    # if the output folder exists, remove it:
+    if os.path.exists(output_folder):
+        shutil.rmtree(output_folder)
+
+    # Create the output folder:
+    os.makedirs(output_folder)
+
+    # Cast input yaml file to FDM
+    data_model: FDM = Util.read_data_from_yaml(input_file, FDM)
+
+    data_model.run.overwrite = True
+
+    # Make the run type start_from_yaml:
+    data_model.run.type = run_type
+
+    fiqus_instance = mf.MainFiQuS(
+        fdm=data_model, model_folder=output_folder, input_file_path=input_file
+    )
+
+    # remove fiqus_instance to avoid memory issues:
+    del fiqus_instance

tests/utils/helpers.py

@@ -3,7 +3,7 @@ import itertools
 import operator
 import os
 import unittest
-from pathlib import Path
+from typing import List
 
 import numpy as np
 
@@ -32,6 +32,10 @@ class Paths:
         self.input_file = os.path.join(self.inputs_folder, f'{model_name}.yaml')
         self.model_file = os.path.join(self.model_folder, f'{model_name}.{f_extension}')
         self.reference_file = os.path.join(self.references_folder, f'{model_name}.{f_extension}')
+        self.reference_vi_file = os.path.join(self.references_folder, f'{model_name}.vi')
+        self.reference_geo_yaml_file = os.path.join(self.references_folder, f'geometry.yaml')
+        self.reference_mesh_yaml_file = os.path.join(self.references_folder, f'mesh.yaml')
+        self.reference_regions_file = os.path.join(self.references_folder, f'{model_name}.regions')
 
 
 def filecmp(filename1, filename2):
@@ -95,3 +99,74 @@ def assert_two_parameters(true_value, test_value):
             test_case.assertListEqual(list(test_value), list(true_value))
     else:
         test_case.assertEqual(test_value, true_value)
+
+
+def assert_equal_readable_files(file1: str, file2: str, verbose: bool = False) -> None:
+    """
+    Assert that two readable (e.g. csv or cond) files are equal
+    :param file1: full path to the first file
+    :type file1: str
+    :param file2: full path to the second file
+    :type file2: str
+    :param verbose: if ture more is printed to the output
+    :type verbose: bool
+    :return: Nothing, however it asserts using unittest testcase
+    :rtype: None
+    """
+    test_case = unittest.TestCase()
+
+    # Load files to compare
+    with open(file1, "r") as f1, open(file2, "r") as f2:
+        file1 = f1.readlines()
+        file2 = f2.readlines()
+
+    flag_equal = True
+    for line in file2:
+        if line not in file1:
+            if verbose:
+                print(f"Found line that appears in File2 but not in File1: {line}")
+            flag_equal = False
+    for line in file1:
+        if line not in file2:
+            if verbose:
+                print(f"Found line that appears in File1 but not in File2: {line}")
+            flag_equal = False
+
+    # Display message and assert files have the same entries
+    if flag_equal:
+        if verbose:
+            print('Files {} and {} have the same entries.'.format(file1, file2))
+    test_case.assertEqual(flag_equal, True)
+
+
+def compare_conductors_dicts(dict1, dict2, max_relative_error=1e-6):
+    """
+    Function that compares two conductor dicts and returns message list describing differences
+    If there are no differences the list is empty
+    :param dict1: reference dict to compare
+    :param dict2: output dict to compare
+    :param max_relative_error: maximum relative difference of values
+
+    """
+
+    the_same_flag = True
+    for brick_id in dict1.keys():
+        if dict1[brick_id] != dict2[brick_id]:
+            pass
+        else:
+            for key, value1 in dict1[brick_id].items():
+                value2 = dict2[brick_id][key]
+                if key in ['SHAPE', 'DRIVELABEL']:
+                    if value1 == value2:
+                        pass
+                    else:
+                        the_same_flag = False
+                else:
+                    if abs(float(value1) - float(value2)) < max_relative_error * float(value2):
+                        pass
+                    elif float(value1) == float(value2):  # both zero
+                        pass
+                    else:
+                        the_same_flag = False
+
+    return the_same_flag