pyfemtet 0.8.9__tar.gz → 0.8.11__tar.gz

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyfemtet
-Version: 0.8.9
+Version: 0.8.11
 Summary: Design parameter optimization using Femtet.
 License: BSD-3-Clause
 Author: kazuma.naito
@@ -30,6 +30,7 @@ Requires-Dist: pandas (>=2.2.3,<3.0.0)
 Requires-Dist: plotly (>=5.22.0,<6.0.0)
 Requires-Dist: psutil (>=5.9.6,<6.0.0)
 Requires-Dist: pywin32 (>=306,<307) ; sys_platform == "win32"
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
 Requires-Dist: scipy (>=1.11.4,<2.0.0)
 Requires-Dist: torch (>=2.5.1,<2.6.0) ; sys_platform != "linux"
 Requires-Dist: torch (>=2.5.1,<2.6.0) ; sys_platform == "linux"

pyfemtet-0.8.11/pyfemtet/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.8.11"

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/_message/locales/ja/LC_MESSAGES/messages.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PROJECT VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2025-01-29 15:47+0900\n"
+"POT-Creation-Date: 2025-02-19 13:47+0900\n"
 "PO-Revision-Date: 2024-07-22 14:05+0900\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: ja\n"
@@ -16,7 +16,7 @@ msgstr ""
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.16.0\n"
+"Generated-By: Babel 2.17.0\n"
 
 #: pyfemtet/_message/messages.py:30
 msgid "hello!"
@@ -542,6 +542,14 @@ msgstr "ひとつの設計変数に対する目的関数の変化"
 msgid "The vertical axis is objective, and the horizontal axis is parameter."
 msgstr "縦軸は目的関数、横軸は設計変数です。"
 
+#: pyfemtet/_message/messages.py:201
+msgid "The importance of parameters evaluated by fANOVA"
+msgstr "fANOVA に基づくパラメータ重要度"
+
+#: pyfemtet/_message/messages.py:202
+msgid "The normalized relative importance of parameters. Please note that the importance is calculated from the overall relationship of the input-output response, rather than from a specific solution."
+msgstr "相対的なパラメータの重要度です。この重要度は特定の解におけるものではなく、入力-出力応答全体の関係から計算されていることに注意してください。"
+
 #~ msgid "The magnitude relationship is incorrect. "
 #~ msgstr ""
 

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/_message/locales/messages.pot

@@ -8,14 +8,14 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PROJECT VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2025-01-29 15:47+0900\n"
+"POT-Creation-Date: 2025-02-19 13:47+0900\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.16.0\n"
+"Generated-By: Babel 2.17.0\n"
 
 #: pyfemtet/_message/messages.py:30
 msgid "hello!"
@@ -541,3 +541,11 @@ msgstr ""
 msgid "The vertical axis is objective, and the horizontal axis is parameter."
 msgstr ""
 
+#: pyfemtet/_message/messages.py:201
+msgid "The importance of parameters evaluated by fANOVA"
+msgstr ""
+
+#: pyfemtet/_message/messages.py:202
+msgid "The normalized relative importance of parameters. Please note that the importance is calculated from the overall relationship of the input-output response, rather than from a specific solution."
+msgstr ""
+

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/_message/messages.py

@@ -198,4 +198,5 @@ class Message:
     DETAIL_PAGE_CONTOUR_DESCRIPTION = _('The axes are parameters, and the color shows objective value.')
     DETAIL_PAGE_SLICE_HEADER = _('The response of an objective versus one parameter')
     DETAIL_PAGE_SLICE_DESCRIPTION = _('The vertical axis is objective, and the horizontal axis is parameter.')
-
+    DETAIL_PAGE_IMPORTANCE_HEADER = _('The importance of parameters evaluated by fANOVA')
+    DETAIL_PAGE_IMPORTANCE_DESCRIPTION = _('The normalized relative importance of parameters. Please note that the importance is calculated from the overall relationship of the input-output response, rather than from a specific solution.')

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/_util/excel_parse_util.py

@@ -13,15 +13,15 @@ __all__ = [
 ]
 
 
-def parse_excel(book_path, sheet_name, keyword, required, optional) -> pd.DataFrame:
+def parse_excel(book_path, sheet_name, keyword, required, optional, raise_if_no_keyword=True) -> pd.DataFrame:
     """Excel シートからパラメータを取得します。
 
     シートのパースプロセスは以下の通りです。
 
     1. シート全体 (A1 セルから、値が入力されている最終セルまで) をデータに取り込みます。
-    2. すべてのセルが空白である列をデータから除きます。
-    3. すべてのセルが空白である行をデータから除きます。
-    4. 最も左上（上が優先）にある keyword に一致するセルより上および左の行・列をデータから除きます。
+    2. 最も左上（上が優先）にある keyword に一致するセルより上および左の行・列をデータから除きます。
+    3. その時点のデータの上から順に見てすべてのセルが空白である行以下の行をデータから除きます。
+    4. すべてのセルが空白である列をデータから除きます。
 
     Args:
         book_path: Excel book のパス。
@@ -29,6 +29,7 @@ def parse_excel(book_path, sheet_name, keyword, required, optional) -> pd.DataFr
         keyword (str): 必ず含まれるべき、表データの最初の列名として使う文字列。
         required (list[str]): 必ず含まれるべき、表データの列名として使う文字列のリスト。
         optional (list[str]): 表データの列名として使ってよい文字列のリスト。
+        raise_if_no_keyword (bool, optional): 指定されたシートに keyword が含まれない場合エラーにするかどうか。
 
     Returns:
 
@@ -41,21 +42,31 @@ def parse_excel(book_path, sheet_name, keyword, required, optional) -> pd.DataFr
     # 読み込み
     df = pd.read_excel(book_path, sheet_name, header=None)
 
-    # NaN のみからなる列を削除する
-    valid_columns = [col for col in df.columns if df[col].notna().sum()]
-    df = df[valid_columns]
-
-    # NaN のみからなる行を削除する
-    valid_rows = [row for row in df.index if df.loc[row].notna().sum()]
-    df = df.loc[valid_rows]
-
     # 「変数名」を左上とする表にする
-    df: pd.DataFrame
     idx = np.where(df.values == keyword)
+    if len(idx[0]) == 0:
+        if raise_if_no_keyword:
+            raise RuntimeError(f'keyword "{keyword}" is lacked in {sheet_name}. ')
+        else:
+            return pd.DataFrame()
+
     r = idx[0][0]
     c = idx[1][0]
     df = pd.DataFrame(df.iloc[1+r:, c:].values, columns=df.iloc[r, c:].values)
 
+    # NaN のみからなる行を最初に見つけるまでデータに追加する
+    valid_rows = []
+    for row in df.index:
+        if df.loc[row].notna().sum():
+            valid_rows.append(row)
+        else:
+            break
+    df = df.loc[valid_rows]
+
+    # NaN のみからなる列を削除する
+    valid_columns = [col for i, col in enumerate(df.columns) if df.iloc[:, i].notna().sum()]
+    df = df[valid_columns]
+
     # パースが成功しているかチェックする
     lack = True
     for col in df.columns:
@@ -76,8 +87,15 @@ class ParseBase:
     OPTIONAL_COLUMNS = []
 
     @classmethod
-    def parse(cls, book_path, sheet_name) -> pd.DataFrame:
-        return parse_excel(book_path, sheet_name, cls.KEYWORD, cls.REQUIRED_COLUMNS, cls.OPTIONAL_COLUMNS)
+    def parse(cls, book_path, sheet_name, raise_if_no_keyword=True) -> pd.DataFrame:
+        return parse_excel(
+            book_path,
+            sheet_name,
+            cls.KEYWORD,
+            cls.REQUIRED_COLUMNS,
+            cls.OPTIONAL_COLUMNS,
+            raise_if_no_keyword,
+        )
 
 
 class ParseAsParameter(ParseBase):

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/opt/_femopt.py

@@ -139,6 +139,7 @@ class FEMOpt:
         self.monitor_host_record = None
         self._hv_reference = None
         self._extra_space_dir = None
+        self._opt_exceptions = []
 
     # multiprocess 時に pickle できないオブジェクト参照の削除
     def __getstate__(self):
@@ -925,6 +926,7 @@ class FEMOpt:
             sleep(1)  # monitor が terminated 状態で少なくとも一度更新されなければ running のまま固まる
 
             # 全ての Exception を再表示
+            self._opt_exceptions = opt_exceptions
             for i, opt_exception in enumerate(opt_exceptions):
                 if opt_exception is not None:
                     print()

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/opt/_femopt_core.py

@@ -306,7 +306,7 @@ class Function:
                         fun.__globals__[varname] = _Scapegoat()
 
         self.fun = fun
-        self.name = name
+        self.name: str = name
         self.args = args
         self.kwargs = kwargs
 
@@ -325,7 +325,7 @@ class Function:
         args = self.args
         # Femtet 特有の処理
         if isinstance(fem, FemtetInterface):
-            args = (fem.Femtet, *args)
+            args = (fem.object_passed_to_functions, *args)
         return float(self.fun(*args, **self.kwargs))
 
     def _restore_constants(self):
@@ -853,7 +853,7 @@ class History:
 
         # 最小化問題に変換された objective values を取得
         raw_objective_values = df[self.obj_names].values
-        objective_values = np.full_like(raw_objective_values, np.nan)
+        objective_values = np.full_like(raw_objective_values, np.nan, dtype=float)
         for n_trial in range(len(raw_objective_values)):
             for obj_idx, (_, objective) in enumerate(objectives.items()):
                 objective_values[n_trial, obj_idx] = objective.convert(raw_objective_values[n_trial, obj_idx])

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/opt/interface/__init__.py

@@ -25,7 +25,7 @@ from pyfemtet.opt.interface._surrogate._base import SurrogateModelInterfaceBase
 from pyfemtet.opt.interface._surrogate._singletaskgp import PoFBoTorchInterface
 
 
-__all__ =[
+__all__ = [
     'FEMInterface',
     'NoFEM',
     'FemtetInterface',

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/opt/interface/_base.py

@@ -24,18 +24,27 @@ class FEMInterface(ABC):
 
     """
 
+    kwargs = None
+
     def __init__(
             self,
             **kwargs
     ):
         # restore のための情報保管
-        self.kwargs = kwargs
+        if self.kwargs is None:
+            self.kwargs = kwargs
+        else:
+            self.kwargs.update(kwargs)
 
     @abstractmethod
     def update(self, parameters: pd.DataFrame) -> None:
         """Updates the FEM analysis based on the proposed parameters."""
         raise NotImplementedError('update() must be implemented.')
 
+    @property
+    def object_passed_to_functions(self):
+        return self
+
     def check_param_value(self, param_name) -> float or None:
         """Checks the value of a parameter in the FEM model (if implemented in concrete class)."""
         pass
@@ -50,13 +59,13 @@ class FEMInterface(ABC):
         pass
 
     def load_parameter(self, opt) -> None:  # opt: AbstractOptimizer
-        raise NotImplementedError()
+        pass
 
     def load_objective(self, opt) -> None:  # opt: AbstractOptimizer
-        raise NotImplementedError()
+        pass
 
     def load_constraint(self, opt) -> None:  # opt: AbstractOptimizer
-        raise NotImplementedError()
+        pass
 
     def _setup_before_parallel(self, client) -> None:
         """Preprocessing before launching a dask worker (if implemented in concrete class).

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/opt/interface/_excel_interface.py

@@ -55,36 +55,36 @@ class ExcelInterface(FEMInterface):
         input_xlsm_path (str or Path):
             設計変数の定義を含む Excel ファイルのパスを指定
             します。
-            
+
         input_sheet_name (str):
             設計変数の定義を含むシートの名前を指定します。
-            
+
         output_xlsm_path (str or Path, optional):
             目的関数の定義を含む Excel ファイルのパスを指定
             します。指定しない場合は ``input_xlsm_path`` と
             同じと見做します。
-            
+
         output_sheet_name (str, optional):
             目的関数の定義を含む含むシートの名前を指定します。
             指定しない場合は ``input_sheet_name`` と同じと見
             做します。
-            
+
         procedure_name (str, optional):
             Excel マクロ関数名を指定します。指定しない場合は
             ``FemtetMacro.FemtetMain`` と見做します。
-            
+
         procedure_args (list or tuple, optional):
             Excel マクロ関数に渡す引数をリストまたはタプルで
             指定します。
-            
+
         connect_method (str, optional):
             Excel との接続方法を指定します。 'auto' または
-            'new' が利用可能です。デフォルトは 'auto' です。
-            
+            'new' が利用可能です。デフォルトは 'new' です。
+
         procedure_timeout (float or None, optional):
             Excel マクロ関数のタイムアウト時間を秒単位で指定
             します。 None の場合はタイムアウトなしとなります。
-            
+
         setup_xlsm_path (str or Path, optional):
             セットアップ時に呼ぶ関数を含む xlsm のパスです。
             指定しない場合は ``input_xlsm_path`` と
@@ -135,7 +135,7 @@ class ExcelInterface(FEMInterface):
     Attributes:
         input_xlsm_path (Path):
             設計変数の定義を含む Excel ファイルのパス。
-            
+
         input_sheet_name (str):
             設計変数の定義を含むシートの名前。
 
@@ -232,7 +232,7 @@ class ExcelInterface(FEMInterface):
             constraint_sheet_name: str = None,
             procedure_name: str = None,
             procedure_args: list or tuple = None,
-            connect_method: str = 'auto',  # or 'new'
+            connect_method: str = 'new',  # or 'auto'
             procedure_timeout: float or None = None,
             setup_xlsm_path: str or Path = None,
             setup_procedure_name: str = None,
@@ -257,7 +257,7 @@ class ExcelInterface(FEMInterface):
         self.output_sheet_name = output_sheet_name if output_sheet_name is not None else input_sheet_name
         self.constraint_xlsm_path = str(input_xlsm_path) if constraint_xlsm_path is None else str(constraint_xlsm_path)
         self.constraint_sheet_name = constraint_sheet_name or self.input_sheet_name
-        self.procedure_name = procedure_name or 'FemtetMacro.FemtetMain'
+        self.procedure_name = procedure_name
         self.procedure_args = procedure_args or []
         assert connect_method in ['new', 'auto']
         self.connect_method = connect_method
@@ -271,7 +271,8 @@ class ExcelInterface(FEMInterface):
         self.setup_procedure_name = setup_procedure_name
         self.setup_procedure_args = setup_procedure_args or []
 
-        self.teardown_xlsm_path = str(input_xlsm_path) if teardown_xlsm_path is None else str(teardown_xlsm_path)  # あとで取得する
+        self.teardown_xlsm_path = str(input_xlsm_path) if teardown_xlsm_path is None else str(
+            teardown_xlsm_path)  # あとで取得する
         self.teardown_procedure_name = teardown_procedure_name
         self.teardown_procedure_args = teardown_procedure_args or []
 
@@ -442,7 +443,7 @@ class ExcelInterface(FEMInterface):
             self.excel = DispatchEx('Excel.Application')
 
         # FemtetRef を追加する
-        self.open_femtet_ref_xla()  # ここでエラーが発生しているかも？
+        self.open_femtet_ref_xla()
         sleep(0.5)
 
         # 起動した excel の pid を記憶する
@@ -516,7 +517,8 @@ class ExcelInterface(FEMInterface):
                 self.sh_constraint = sh
                 break
         else:
-            raise RuntimeError(f'Sheet {self.constraint_sheet_name} does not exist in the book {self.wb_constraint.Name}.')
+            raise RuntimeError(
+                f'Sheet {self.constraint_sheet_name} does not exist in the book {self.wb_constraint.Name}.')
 
         # ===== setup =====
         # 開く (setup)
@@ -618,18 +620,19 @@ class ExcelInterface(FEMInterface):
         self.update_parameter(parameters)
 
         # マクロ実行
-        try:
-            with watch_excel_macro_error(self.excel, timeout=self.procedure_timeout):
-                self.excel.Run(
-                    f'{self.procedure_name}',
-                    *self.procedure_args
-                )
+        if self.procedure_name is not None:
+            try:
+                with watch_excel_macro_error(self.excel, timeout=self.procedure_timeout):
+                    self.excel.Run(
+                        f'{self.procedure_name}',
+                        *self.procedure_args
+                    )
 
-            # 再計算
-            self.excel.CalculateFull()
+                # 再計算
+                self.excel.CalculateFull()
 
-        except com_error as e:
-            raise SolveError(f'Failed to run macro {self.procedure_name}. The original message is: {e}')
+            except com_error as e:
+                raise SolveError(f'Failed to run macro {self.procedure_name}. The original message is: {e}')
 
     def quit(self):
         if self.terminate_excel_when_quit:
@@ -655,7 +658,8 @@ class ExcelInterface(FEMInterface):
                         self.excel.CalculateFull()
 
                     except com_error as e:
-                        raise RuntimeError(f'Failed to run macro {self.teardown_procedure_args}. The original message is: {e}')
+                        raise RuntimeError(
+                            f'Failed to run macro {self.teardown_procedure_args}. The original message is: {e}')
 
             # 不具合の原因になる場合があるので参照設定は解除しないこと
             # self.remove_femtet_ref_xla(self.wb_input)
@@ -726,11 +730,15 @@ class ExcelInterface(FEMInterface):
     def input_workbook(self) -> CDispatch:
         return self.wb_input
 
-    def load_parameter(self, opt) -> None:
+    def load_parameter(self, opt, raise_if_no_keyword=True) -> None:
         from pyfemtet.opt.optimizer import AbstractOptimizer, logger
         opt: AbstractOptimizer
 
-        df = ParseAsParameter.parse(self.input_xlsm_path, self.input_sheet_name)
+        df = ParseAsParameter.parse(
+            self.input_xlsm_path,
+            self.input_sheet_name,
+            raise_if_no_keyword,
+        )
 
         for i, row in df.iterrows():
 
@@ -777,6 +785,7 @@ class ExcelInterface(FEMInterface):
                 opt.variables.add_parameter(prm)
 
             else:
+                # noinspection PyTypeChecker
                 fixed_prm = Expression(
                     name=name,
                     fun=lambda: value,
@@ -790,12 +799,16 @@ class ExcelInterface(FEMInterface):
                 )
                 opt.variables.add_expression(fixed_prm)
 
-    def load_objective(self, opt):
-        from pyfemtet.opt.optimizer import AbstractOptimizer, logger
+    def load_objective(self, opt, raise_if_no_keyword=True):
+        from pyfemtet.opt.optimizer import AbstractOptimizer
         from pyfemtet.opt._femopt_core import Objective
         opt: AbstractOptimizer
 
-        df = ParseAsObjective.parse(self.output_xlsm_path, self.output_sheet_name)
+        df = ParseAsObjective.parse(
+            self.output_xlsm_path,
+            self.output_sheet_name,
+            raise_if_no_keyword,
+        )
 
         for i, row in df.iterrows():
 
@@ -827,22 +840,19 @@ class ExcelInterface(FEMInterface):
                     kwargs=dict(),
                 )
 
-    def load_constraint(self, opt):
-        from pyfemtet.opt.optimizer import AbstractOptimizer, logger
+    def load_constraint(self, opt, raise_if_no_keyword=False):
+        from pyfemtet.opt.optimizer import AbstractOptimizer
         from pyfemtet.opt._femopt_core import Constraint
         opt: AbstractOptimizer
 
-        # TODO:
-        #   constraint は optional である。
-        #   現在は実装していないが、シートから問題を取得するよりよいロジックができたら
-        #   （つまり、同じシートからパラメータと拘束を取得出来るようになったら）__init__ 内で
-        #   constraint に None が与えられたのか故意に input_sheet_name と同じシート名を
-        #   与えられたのか分別できる実装に変えてそのチェック処理をここに反映する。
-        # constraint_sheet_name が指定されていない場合何もしない
-        if (self.constraint_sheet_name == self.input_sheet_name) and is_same_path(self.input_xlsm_path, self.constraint_xlsm_path):
-            return
-
-        df = ParseAsConstraint.parse(self.constraint_xlsm_path, self.constraint_sheet_name)
+        # constraint は optional であるが
+        # __init__ で input_sheet_name を入れられるので
+        # ここで constraint が実際に与えられているか判断する
+        df = ParseAsConstraint.parse(
+            self.constraint_xlsm_path,
+            self.constraint_sheet_name,
+            raise_if_no_keyword=raise_if_no_keyword,
+        )
 
         for i, row in df.iterrows():
 
@@ -877,7 +887,8 @@ class ExcelInterface(FEMInterface):
             calc_before_solve = True
             if ParseAsConstraint.calc_before_solve in df.columns:
                 _calc_before_solve = row[ParseAsConstraint.calc_before_solve]
-                calc_before_solve = True if is_cell_value_empty(_calc_before_solve) else bool(_calc_before_solve)  # bool or NaN
+                calc_before_solve = True if is_cell_value_empty(_calc_before_solve) else bool(
+                    _calc_before_solve)  # bool or NaN
 
             if use:
                 # constraint を作る
@@ -892,6 +903,7 @@ class ExcelInterface(FEMInterface):
                     using_fem=not calc_before_solve,
                 )
 
+    # TODO: femopt_core.Function の仕様を変えたらここも変える
     def objective_from_excel(self, name: str):
         r = 1 + search_r(self.output_xlsm_path, self.output_sheet_name, name)
         c = 1 + search_c(self.output_xlsm_path, self.output_sheet_name, ParseAsObjective.value)

{pyfemtet-0.8.9 → pyfemtet-0.8.11}/pyfemtet/opt/interface/_femtet.py

@@ -192,7 +192,8 @@ class FemtetInterface(FEMInterface):
         # subprocess で restore するための情報保管
         # パスなどは connect_and_open_femtet での処理結果を反映し
         # メインで開いた解析モデルが確実に開かれるようにする
-        super().__init__(
+        FEMInterface.__init__(
+            self,
             femprj_path=self.femprj_path,
             model_name=self.model_name,
             open_result_with_gui=self.open_result_with_gui,
@@ -201,6 +202,10 @@ class FemtetInterface(FEMInterface):
             **kwargs
         )
 
+    @property
+    def object_passed_to_functions(self):
+        return self.Femtet
+
     def use_parametric_output_as_objective(self, number: int, direction: str | float = 'minimize') -> None:
         """Use output setting of Femtet parametric analysis as an objective function.
 
@@ -234,7 +239,6 @@ class FemtetInterface(FEMInterface):
         self.kwargs['parametric_output_indexes_use_as_objective'] = self.parametric_output_indexes_use_as_objective
 
 
-
     def __del__(self):
         self.quit()
         # CoUninitialize()  # Win32 exception occurred releasing IUnknown at 0x0000022427692748