PyFemtet 1.9.0__tar.gz → 1.9.2__tar.gz

{pyfemtet-1.9.0 → pyfemtet-1.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyfemtet
-Version: 1.9.0
+Version: 1.9.2
 Summary: Design parameter optimization using Femtet.
 License-Expression: MIT
 License-File: LICENSE

{pyfemtet-1.9.0 → pyfemtet-1.9.2}/pyfemtet/opt/history/_history.py

@@ -372,11 +372,21 @@ class ColumnManager:
     column_dtypes: dict[str, type]
     meta_columns: list[str]
 
-    @staticmethod
-    def columns_to_keep_even_if_nan():
-        return [
-            "messages",
-        ]
+    def columns_to_keep_even_if_nan(self) -> list[str]:
+        out = ["messages"]
+        # objective
+        for name in self.get_obj_names():
+            out.append(name)
+            out.append(CorrespondingColumnNameRuler.direction_name(name))
+        # constraint
+        for name in self.get_cns_names():
+            out.append(name)
+            out.append(CorrespondingColumnNameRuler.cns_lower_bound_name(name))
+            out.append(CorrespondingColumnNameRuler.cns_upper_bound_name(name))
+        # other_output
+        for name in self.get_other_output_names():
+            out.append(name)
+        return out
 
     def initialize(
         self,
@@ -955,6 +965,72 @@ class Records:
         self.loaded_meta_columns = loaded_meta_columns
         self.loaded_df = loaded_df
 
+    @staticmethod
+    def _incompatible_setting_detail(
+        category_en: str,
+        category_jp: str,
+        added: set[str],
+        removed: set[str],
+    ) -> str | None:
+        if not added and not removed:
+            return None
+        category = _(en_message=category_en, jp_message=category_jp)
+        lines = []
+        if added:
+            lines.append(
+                _(
+                    en_message="  Extra {category}: {names}",
+                    jp_message="  余分な{category}: {names}",
+                    category=category,
+                    names=", ".join(sorted(added)),
+                )
+            )
+        if removed:
+            lines.append(
+                _(
+                    en_message="  Missing {category}: {names}",
+                    jp_message="  足りない{category}: {names}",
+                    category=category,
+                    names=", ".join(sorted(removed)),
+                )
+            )
+        return "\n".join(lines)
+
+    @staticmethod
+    def _incompatible_setting_message(details: list[str]) -> str:
+        detail = "\n".join(details)
+        return _(
+            en_message="The current script settings do not match "
+            "the history CSV file loaded via history_path.\n"
+            "\n"
+            "[The current setting incompatibilities]\n"
+            "{detail}\n"
+            "\n"
+            "[Countermeasure]\n"
+            "When resuming optimization with history_path, "
+            "the settings must be compatible with the previous run. "
+            "To fix this, choose one of the following options:\n"
+            "  1. Restore the settings to match the previous run.\n"
+            "  2. Remove the history_path argument to start a new optimization.\n"
+            "  3. Delete the history CSV file (and the .db file with the same name, if it exists) "
+            "to discard the previous history and start fresh.",
+            jp_message="現在のスクリプトの設定が、"
+            "history_path で読み込んだ履歴 CSV ファイルの内容と一致しません。\n"
+            "\n"
+            "[現在の設定の不整合点]\n"
+            "{detail}\n"
+            "\n"
+            "[対策]\n"
+            "history_path を指定して最適化を再開する場合、"
+            "設定は前回の実行と整合している必要があります。"
+            "以下のいずれかの方法で対処してください:\n"
+            "  1. 前回の実行と同じ設定に戻す。\n"
+            "  2. history_path の指定を削除して新しい最適化を開始する。\n"
+            "  3. 履歴 CSV ファイル（および同名の .db ファイルがあればそれも）を削除し、"
+            "前回の履歴を破棄して最初からやり直す。",
+            detail=detail,
+        )
+
     def check_problem_compatibility(self):
         # 読み込んだデータがないのであれば何もしない
         if self.loaded_df is None:
@@ -968,6 +1044,8 @@ class Records:
             self.loaded_meta_columns,
         )
 
+        incompatible_details: list[str] = []
+
         # prm_names が過不足ないか
         loaded_prm_names = set(
             self.column_manager._filter_prm_names(loaded_columns, loaded_meta_columns)
@@ -976,7 +1054,13 @@ class Records:
         if not (
             len(loaded_prm_names - prm_names) == len(prm_names - loaded_prm_names) == 0
         ):
-            raise RuntimeError("Incompatible parameter setting.")
+            detail = self._incompatible_setting_detail(
+                "parameter", "パラメータ",
+                added=prm_names - loaded_prm_names,
+                removed=loaded_prm_names - prm_names,
+            )
+            if detail:
+                incompatible_details.append(detail)
 
         # obj_names が増えていないか
         loaded_obj_names = set(
@@ -986,7 +1070,13 @@ class Records:
         )
         obj_names = set(self.column_manager.get_obj_names())
         if len(obj_names - loaded_obj_names) > 0:
-            raise RuntimeError("Incompatible objective setting.")
+            detail = self._incompatible_setting_detail(
+                "objective", "目的関数",
+                added=obj_names - loaded_obj_names,
+                removed=set(),
+            )
+            if detail:
+                incompatible_details.append(detail)
 
         # cns_names が過不足ないか
         # TODO: cns の上下限は変更されてはならない。
@@ -999,7 +1089,18 @@ class Records:
         if not (
             len(loaded_cns_names - cns_names) == len(cns_names - loaded_cns_names) == 0
         ):
-            raise RuntimeError("Incompatible constraint setting.")
+            detail = self._incompatible_setting_detail(
+                "constraint", "拘束条件",
+                added=cns_names - loaded_cns_names,
+                removed=loaded_cns_names - cns_names,
+            )
+            if detail:
+                incompatible_details.append(detail)
+
+        if incompatible_details:
+            raise RuntimeError(
+                self._incompatible_setting_message(incompatible_details)
+            )
 
     def reinitialize_record_with_loaded_data(
         self, column_order_mode: str = ColumnOrderMode.per_category
@@ -1126,7 +1227,7 @@ class Records:
         self.df_wrapper.set_df(df)
 
     def remove_nan_columns(
-        self, df, meta_columns, columns_to_keep: str | list[str] = None
+        self, df, meta_columns, columns_to_keep: list[str] | None = None
     ) -> tuple[pd.DataFrame, tuple[str]]:
         """
 
@@ -1134,6 +1235,7 @@ class Records:
             df:
             meta_columns:
             columns_to_keep: Allowing these columns to all NaN values.
+                If None, use self.column_manager.columns_to_keep_even_if_nan().
 
         Returns:
             Removed DataFrame and corresponding meta_columns.

{pyfemtet-1.9.0 → pyfemtet-1.9.2}/pyfemtet/opt/interface/_femtet_interface/_femtet_parametric.py

@@ -243,7 +243,7 @@ def _parametric_objective(Femtet, parametric_result_index):
     return dll.GetPrmResult(parametric_result_index)
 
 
-def solve_via_parametric_dll(Femtet) -> bool:
+def solve_via_parametric_dll(Femtet, clear_sweep_table: bool = True) -> bool:
     csv_processor = get_csv_processor(Femtet)
 
     # remove previous csv if exists
@@ -255,11 +255,12 @@ def solve_via_parametric_dll(Femtet) -> bool:
     dll = _get_dll_with_set_femtet(Femtet)
 
     # reset existing sweep table
-    dll.ClearPrmSweepTable.restype = ctypes.c_bool
-    succeed = dll.ClearPrmSweepTable()
-    if not succeed:
-        logger.error('Failed to remove existing sweep table!')  # 通常ありえないので error
-        return False
+    if clear_sweep_table:
+        dll.ClearPrmSweepTable.restype = ctypes.c_bool
+        succeed = dll.ClearPrmSweepTable()
+        if not succeed:
+            logger.error('Failed to remove existing sweep table!')  # 通常ありえないので error
+            return False
 
     # solve
     dll.PrmCalcExecute.restype = ctypes.c_bool

{pyfemtet-1.9.0 → pyfemtet-1.9.2}/pyfemtet/opt/interface/_femtet_interface/femtet_interface.py

@@ -174,6 +174,7 @@ class FemtetInterface(COMInterface):
         self._warn_if_undefined_variable = True
         self.api_response_warning_time = 10  # mesh, solve, re-execute を除くマクロ実行警告時間
         self.save_screenshot: Literal["result", "model", "none"] = "model"
+        self._clear_parametric_sweep_table: bool = True
 
         # connect to Femtet
         self._connect_and_open_femtet()
@@ -1011,7 +1012,7 @@ class FemtetInterface(COMInterface):
                 if_error=SolveError,
                 error_message=Msg.ERR_PARAMETRIC_SOLVE_FAILED,
                 is_Gaudi_method=True,
-                args=(self.Femtet,),
+                args=(self.Femtet, self._clear_parametric_sweep_table),
             )
 
             # parametric analysis の場合

{pyfemtet-1.9.0 → pyfemtet-1.9.2}/pyproject.toml

@@ -34,7 +34,7 @@ dependencies = [
 
 #[project.optional-dependencies]
 #brep = ["brepmatching>=0.1.8,<0.2"]
-version = "1.9.0"
+version = "1.9.2"
 
 [project.urls]
 Repository = "https://github.com/pyfemtet/pyfemtet"