PyFemtet 1.0.0__tar.gz → 1.0.0a0__tar.gz

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyfemtet
-Version: 1.0.0
+Version: 1.0.0a0
 Summary: Design parameter optimization using Femtet.
 License: MIT
 Author: kazuma.naito
@@ -28,8 +28,7 @@ Requires-Dist: optuna-integration (>=3.6.0,<5.0.0)
 Requires-Dist: pandas (>=2.2.3,<3)
 Requires-Dist: plotly (>=5.22.0,<6)
 Requires-Dist: psutil (>=5.9.6,<6)
-Requires-Dist: pywin32 (<307) ; sys_platform == "win32" and python_version < "3.13"
-Requires-Dist: pywin32 (>=309) ; sys_platform == "win32" and python_version >= "3.13"
+Requires-Dist: pywin32 (>=306,<311) ; sys_platform == "win32"
 Requires-Dist: pyyaml (>=6.0.2,<7)
 Requires-Dist: scipy (>=1.11.4,<2)
 Requires-Dist: torch

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/_i18n/locales/ja/LC_MESSAGES/messages.po

@@ -491,7 +491,7 @@ msgstr "グラフを自動更新"
 
 #: pyfemtet/_i18n/messages.py:242
 msgid "Interrupt Optimization"
-msgstr "最適化を中断"
+msgstr "最適化を中断しました"
 
 #: pyfemtet/_i18n/messages.py:244
 msgid "Result"

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/_util/dask_util.py

@@ -24,7 +24,7 @@ warnings.filterwarnings('ignore', category=RuntimeWarning, message="Couldn't det
 
 cfg.set({'distributed.scheduler.worker-ttl': None})
 
-logger = get_module_logger('opt.dask', False)
+logger = get_module_logger('opt.dask', True)
 
 
 __all__ = [

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/_util/df_util.py

@@ -1,4 +1,3 @@
-from math import isnan
 import pandas as pd
 
 
@@ -10,24 +9,8 @@ __all__ = [
 
 def get_index(df, equality_filters):
     # フィルタ条件に一致する行のインデックスを取得
-
-    # na との == での比較は常に False なので別処理するために別リストを作る
-    want_na_keys = []
-    for key, value in equality_filters.items():
-        if isinstance(value, float):
-            if isnan(value):
-                want_na_keys.append(key)
-    [equality_filters.pop(key) for key in want_na_keys]
-
-    # na 以外の比較
     # noinspection PyUnresolvedReferences
-    out: pd.Series = (df[list(equality_filters.keys())] == pd.Series(equality_filters)).all(axis=1)
-
-    # na との比較
-    for key in want_na_keys:
-        out = out & df[key].isna()
-
-    return out
+    return (df[list(equality_filters.keys())] == pd.Series(equality_filters)).all(axis=1)
 
 
 def get_partial_df(df: pd.DataFrame, equality_filters: dict):

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/_util/helper.py

@@ -1,9 +1,6 @@
 from __future__ import annotations
 
 from typing import Callable
-
-import string
-import secrets
 import warnings
 from time import time, sleep
 from threading import Thread
@@ -13,7 +10,6 @@ from pyfemtet._i18n import _
 __all__ = [
     'float_',
     'time_counting',
-    'generate_random_id',
 ]
 
 
@@ -96,8 +92,3 @@ def time_counting(
         warning_message,
         warning_fun,
     )
-
-
-def generate_random_id(length: int = 16) -> str:
-    alphabet = string.ascii_letters + string.digits
-    return ''.join(secrets.choice(alphabet) for _ in range(length))

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/opt/__init__.py

@@ -1,13 +1,11 @@
 from .femopt import FEMOpt
-from .interface import FemtetInterface, FemtetWithNXInterface, FemtetWithSolidworksInterface
+from .interface import FemtetInterface
 from .optimizer import OptunaOptimizer, ScipyOptimizer
 
 
 __all__ = [
     'FEMOpt',
     'FemtetInterface',
-    'FemtetWithNXInterface',
-    'FemtetWithSolidworksInterface',
     'OptunaOptimizer',
     'ScipyOptimizer',
 ]

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/opt/femopt.py

@@ -29,19 +29,6 @@ logger = get_module_logger('opt.femopt', False)
 
 
 class FEMOpt:
-    """
-    A class to manage finite element method (FEM) optimization using a specified optimizer and FEM interface.
-
-    Attributes:
-        opt (AbstractOptimizer): The optimizer instance to be used for optimization.
-        monitor_info (dict[str, str | int | None]): Dictionary to store monitoring information such as host and port.
-
-    Args:
-        fem (AbstractFEMInterface, optional): An instance of a FEM interface. Defaults to None, in which case a FemtetInterface is used.
-        opt (AbstractOptimizer, optional): An optimizer instance. Defaults to None, in which case OptunaOptimizer is used.
-
-    """
-
     opt: AbstractOptimizer
 
     def __init__(
@@ -84,20 +71,16 @@ class FEMOpt:
             name: str,
             expression_string: str,
             properties: dict[str, ...] | None = None,
-            *,
-            pass_to_fem: bool = True,
     ) -> None:
-        self.opt.add_expression_string(name, expression_string, properties, pass_to_fem=pass_to_fem)
+        self.opt.add_expression_string(name, expression_string, properties)
 
     def add_expression_sympy(
             self,
             name: str,
             sympy_expr: sympy.Expr,
             properties: dict[str, ...] | None = None,
-            *,
-            pass_to_fem: bool = True,
     ) -> None:
-        self.opt.add_expression_sympy(name, sympy_expr, properties, pass_to_fem=pass_to_fem)
+        self.opt.add_expression_sympy(name, sympy_expr, properties)
 
     def add_expression(
             self,
@@ -106,10 +89,8 @@ class FEMOpt:
             properties: dict[str, ...] | None = None,
             args: tuple | None = None,
             kwargs: dict | None = None,
-            *,
-            pass_to_fem: bool = True,
     ) -> None:
-        self.opt.add_expression(name, fun, properties, args, kwargs, pass_to_fem=pass_to_fem)
+        self.opt.add_expression(name, fun, properties, args, kwargs)
 
     def add_categorical_parameter(
             self,

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/opt/history/_history.py

@@ -43,13 +43,10 @@ __all__ = [
     'MAIN_FILTER',
 ]
 
-MAIN_FILTER: dict = {
-    'sub_fidelity_name': MAIN_FIDELITY_NAME,
-    'sub_sampling': float('nan')
-}
+MAIN_FILTER: dict = {'sub_fidelity_name': MAIN_FIDELITY_NAME}
 
 
-logger = get_module_logger('opt.history', False)
+logger = get_module_logger('opt.history', True)
 
 
 def create_err_msg_from_exception(e: Exception):
@@ -1056,14 +1053,6 @@ class Records:
 
         with self.df_wrapper.lock_if_not_locked:
 
-            # check trial_id is filled
-            trial_processed = False
-            if processing_df['trial_id'].notna().all():
-                id_to_n: dict = {tid: i + 1 for i, tid
-                                 in enumerate(processing_df['trial_id'].unique())}
-                processing_df['trial'] = processing_df['trial_id'].map(id_to_n)
-                trial_processed = True
-
             # update main fidelity
             equality_filters = MAIN_FILTER
             mgr = EntireDependentValuesCalculator(
@@ -1073,13 +1062,13 @@ class Records:
             )
             mgr.update_optimality()
             mgr.update_hypervolume()
-            if not trial_processed:
-                mgr.update_trial_number()  # per_fidelity
+            mgr.update_trial_number()
             pdf = mgr.partial_df
             apply_partial_df(df=processing_df, partial_df=pdf, equality_filters=equality_filters)
 
             # update sub fidelity
-            sub_fidelity_names: list = np.unique(processing_df['sub_fidelity_name']).tolist()
+            entire_df = self.df_wrapper.get_df()
+            sub_fidelity_names: list = np.unique(entire_df['sub_fidelity_name']).tolist()
             if MAIN_FIDELITY_NAME in sub_fidelity_names:
                 sub_fidelity_names.remove(MAIN_FIDELITY_NAME)
             for sub_fidelity_name in sub_fidelity_names:
@@ -1089,8 +1078,7 @@ class Records:
                     equality_filters,
                     processing_df
                 )
-                if not trial_processed:
-                    mgr.update_trial_number()  # per_fidelity
+                mgr.update_trial_number()
             pdf = mgr.partial_df
             apply_partial_df(df=processing_df, partial_df=pdf, equality_filters=equality_filters)
 

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/opt/interface/_excel_interface/excel_interface.py

@@ -258,6 +258,8 @@ class ExcelInterface(COMInterface):
             force_override_when_load: bool = False,
     ):
 
+        show_experimental_warning("ExcelInterface")
+
         def proc_path(path_):
             if path_ is None:
                 return self._original_input_xlsm_path

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/opt/interface/_femtet_interface/femtet_interface.py

@@ -4,6 +4,7 @@ from typing import TYPE_CHECKING
 
 import os
 import sys
+import warnings
 import subprocess
 from time import sleep
 from contextlib import nullcontext
@@ -102,6 +103,8 @@ class FemtetInterface(COMInterface):
                 If you do not want to delete the swept table,
                 make a copy of the original file.
 
+        **kwargs: Additional arguments from inherited classes.
+
     Warning:
         Even if you specify ``strictly_pid_specify=True`` on the constructor,
         **the connection behavior is like** ``strictly_pid_specify=False`` **in parallel processing**
@@ -116,8 +119,6 @@ class FemtetInterface(COMInterface):
     """
 
     com_members = {'Femtet': 'FemtetMacro.Femtet'}
-    _show_parametric_index_warning = True  # for GUI
-    _femtet_connection_timeout = 10
 
     def __init__(
             self,
@@ -128,19 +129,14 @@ class FemtetInterface(COMInterface):
             strictly_pid_specify: bool = True,  # dask worker では True にしたいので super() の引数にしない。
             allow_without_project: bool = False,  # main でのみ True を許容したいので super() の引数にしない。
             open_result_with_gui: bool = True,
+            parametric_output_indexes_use_as_objective: dict[int, str or float] = None,  # TODO: Remove this
             always_open_copy=False,
-            # ユーザーはメソッドを使うことを推奨。GUI などで使用。
-            parametric_output_indexes_use_as_objective: dict[int, str | float] = None,
     ):
+        # warning
         if parametric_output_indexes_use_as_objective is not None:
-            if FemtetInterface._show_parametric_index_warning:
-                logger.warning(_(
-                    en_message='The argument `parametric_output_indexes_use_as_objective` is deprecated. '
-                               'Please use `FemtetInterface.use_parametric_output_as_objective()` instead.',
-                    jp_message='`parametric_output_indexes_use_as_objective` は非推奨の引数です。'
-                               '代わりに `FemtetInterface.use_parametric_output_as_objective()` '
-                               'を使ってください。',
-                ))
+            warnings.warn(
+                "解析モデルに設定された既存のスイープテーブルは削除されます。"
+            )
 
         # 引数の処理
         if femprj_path is None:
@@ -259,13 +255,6 @@ class FemtetInterface(COMInterface):
             None
 
         """
-
-        # warning
-        logger.warning(_(
-            en_message='The existing sweep table in the project will be removed.',
-            jp_message='解析モデルに設定された既存のスイープテーブルは削除されます。'
-        ))
-
         # check
         if isinstance(direction, str):
             if direction not in ("minimize", "maximize"):
@@ -315,9 +304,9 @@ class FemtetInterface(COMInterface):
         logger.info("└ Try to connect existing Femtet process.")
         # 既存の Femtet を探して Dispatch する。
         if pid is None:
-            self.Femtet, self.femtet_pid = dispatch_femtet(timeout=self._femtet_connection_timeout)
+            self.Femtet, self.femtet_pid = dispatch_femtet(timeout=5)
         else:
-            self.Femtet, self.femtet_pid = dispatch_specific_femtet(pid, timeout=self._femtet_connection_timeout)
+            self.Femtet, self.femtet_pid = dispatch_specific_femtet(pid, timeout=5)
         self.connected_method = "existing"
 
     def connect_femtet(self, connect_method: str = "auto", pid: int or None = None):
@@ -515,8 +504,6 @@ class FemtetInterface(COMInterface):
             name = fun.__name__
             if fun.__name__ == 'Solve':
                 context = nullcontext()
-            elif fun.__name__ == 'solve_via_parametric_dll':
-                context = nullcontext()
 
         elif isinstance(fun, str):
 
@@ -538,7 +525,7 @@ class FemtetInterface(COMInterface):
                         'If the optimization is hanging, the most reason is '
                         'a dialog is opening in Femtet and it waits for your '
                         'input. Please confirm there is no dialog in Femtet.',
-                        '{name} の実行に {warning_time_sec} 秒以上かかっています。'
+                        '{name} の実行に {warning_time_sec} 以上かかっています。'
                         'もし最適化がハングしているならば、考えられる理由として、'
                         'Femtet で予期せずダイアログが開いてユーザーの入力待ちをしている場合があります。'
                         'もし Femtet でダイアログが開いていれば、閉じてください。',

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/opt/interface/_femtet_with_nx_interface/femtet_with_nx_interface.py

@@ -156,7 +156,7 @@ class FemtetWithNXInterface(FemtetInterface, _NXInterface):
             strictly_pid_specify: bool = True,  # dask worker では True にしたいので super() の引数にしない。
             allow_without_project: bool = False,  # main でのみ True を許容したいので super() の引数にしない。
             open_result_with_gui: bool = True,
-            parametric_output_indexes_use_as_objective: dict[int, str | float] = None,
+            parametric_output_indexes_use_as_objective: dict[int, str or float] = None,  # TODO: Remove this
             always_open_copy=False,
             export_curves: bool or None = None,
             export_surfaces: bool or None = None,

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/opt/interface/_femtet_with_solidworks/femtet_with_solidworks_interface.py

@@ -20,26 +20,6 @@ if TYPE_CHECKING:
 
 
 class FemtetWithSolidworksInterface(FemtetInterface, SolidworksInterface, AbstractFEMInterface):
-    """
-    Interface class integrating Femtet and SolidWorks operations.
-
-    This class combines the capabilities of both Femtet and SolidWorks interfaces, allowing
-    coordinated operation between simulation (Femtet) and CAD manipulation (SolidWorks).
-
-    Args:
-        sldprt_path (str): Path to the SolidWorks part file (.sldprt).
-        femprj_path (str, optional): Path to the Femtet project file (.femprj). Defaults to None.
-        model_name (str, optional): Name of the model in the project. Defaults to None.
-        connect_method (str, optional): Connection method for Femtet. Defaults to "auto".
-        save_pdt (str, optional): Specifies which data to save. Defaults to "all".
-        strictly_pid_specify (bool, optional): Whether to strictly specify parameter IDs. Defaults to True.
-        allow_without_project (bool, optional): If True, allows operation without a project file. Defaults to False.
-        open_result_with_gui (bool, optional): If True, open results with GUI. Defaults to True.
-        parametric_output_indexes_use_as_objective (dict[int, str | float], optional): Indexes for parametric output used as objectives. Defaults to None.
-        always_open_copy (bool, optional): If True, always open a copy of the project. Defaults to False.
-        close_solidworks_on_terminate (bool, optional): If True, SolidWorks will close when this object is destroyed. Defaults to False.
-        solidworks_visible (bool, optional): If True, SolidWorks will be started in visible mode. Defaults to True.
-    """
 
     def __init__(
             self,
@@ -51,7 +31,7 @@ class FemtetWithSolidworksInterface(FemtetInterface, SolidworksInterface, Abstra
             strictly_pid_specify: bool = True,
             allow_without_project: bool = False,
             open_result_with_gui: bool = True,
-            parametric_output_indexes_use_as_objective: dict[int, str | float] = None,
+            parametric_output_indexes_use_as_objective: dict[int, str or float] = None,
             always_open_copy=False,
             close_solidworks_on_terminate=False,
             solidworks_visible=True,

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/opt/interface/_solidworks_interface/solidworks_interface.py

@@ -41,27 +41,6 @@ class FileNotOpenedError(Exception):
 
 # noinspection PyPep8Naming
 class SolidworksInterface(COMInterface):
-    """
-    Interface class for interacting with SolidWorks through COM automation.
-
-    This class manages the connection and interaction with SolidWorks using its COM interface.
-    It handles initialization, visibility, and clean termination of the SolidWorks application.
-
-    Attributes:
-        swApp (CDispatch): The COM dispatch object for SolidWorks application.
-        com_members (dict): Mapping of COM member names to their interface strings.
-        sldprt_path (str): Absolute path to the SolidWorks part file (.sldprt).
-        quit_solidworks_on_terminate (bool): Whether to close SolidWorks upon object destruction.
-        solidworks_visible (bool): Whether the SolidWorks application window is visible.
-
-    Args:
-        sldprt_path (str): Path to the SolidWorks part file (.sldprt).
-        close_solidworks_on_terminate (bool, optional): If True, SolidWorks will close when this object is destroyed. Defaults to False.
-        visible (bool, optional): If True, SolidWorks will be started in visible mode. Defaults to True.
-
-    Raises:
-        AssertionError: If the specified part file does not exist.
-    """
 
     swApp: CDispatch
     com_members = {'swApp': 'SLDWORKS.Application'}

pyfemtet-1.0.0a0/pyfemtet/opt/interface/_surrogate_model_interface/base_surrogate_interface.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pyfemtet.opt.history import *
+
+from pyfemtet.opt.interface import AbstractFEMInterface
+
+if TYPE_CHECKING:
+    from pyfemtet.opt.optimizer import AbstractOptimizer
+
+
+__all__ = [
+    'AbstractSurrogateModelInterfaceBase',
+]
+
+
+class AbstractSurrogateModelInterfaceBase(AbstractFEMInterface):
+    current_obj_values: dict[str, float]
+    train_history: History
+
+    def __init__(
+            self,
+            history_path: str = None,
+            train_history: History = None,
+    ):
+
+        # history_path が与えられた場合、train_history をコンストラクトする
+        if history_path is not None:
+            train_history = History()
+            train_history.load_csv(history_path, with_finalize=True)
+
+        assert train_history is not None
+
+        self.train_history = train_history
+
+        self.current_obj_values = {}
+
+    def load_objectives(self, opt: AbstractOptimizer):
+        # add_objective された目的のうち、
+        # training data に含まれる名前ならば
+        # fun を「その時点の current_obj_values を返す関数」で
+        # 上書き
+        for obj_name, obj in opt.objectives.items():
+            if obj_name in self.train_history.obj_names:
+                obj.fun = lambda obj_name_=obj_name: self.current_obj_values[obj_name_]
+
+    def load_variables(self, opt: AbstractOptimizer):
+        # opt の変数が充分であるかのチェックのみ
+        parameters = opt.variable_manager.get_variables()
+        assert len(set(self.train_history.prm_names) - set(parameters.keys())) == 0
+
+    def _check_using_fem(self, fun: callable) -> bool:
+        return False
+
+    def _check_param_and_raise(self, prm_name) -> None:
+        if prm_name not in self.train_history.prm_names:
+            raise KeyError(f'Parameter name {prm_name} is not in '
+                           f'training input {self.train_history.prm_names}.')

{pyfemtet-1.0.0 → pyfemtet-1.0.0a0}/pyfemtet/opt/interface/_surrogate_model_interface/botorch_interface.py

@@ -1,5 +1,3 @@
-from typing import Sequence
-
 import numpy as np
 from scipy.stats.distributions import norm
 
@@ -26,22 +24,8 @@ __all__ = [
 
 class BoTorchInterface(AbstractSurrogateModelInterfaceBase):
 
-    def __init__(
-            self,
-            history_path: str = None,
-            train_history: History = None,
-            _output_directions: (
-                    Sequence[str | float]
-                    | dict[str, str | float]
-                    | dict[int, str | float]
-            ) = None
-    ):
-        AbstractSurrogateModelInterfaceBase.__init__(
-            self,
-            history_path,
-            train_history,
-            _output_directions
-        )
+    def __init__(self, history_path: str = None, train_history: History = None):
+        AbstractSurrogateModelInterfaceBase.__init__(self, history_path, train_history)
 
         self.model = SingleTaskGPModel()
         self.pyfemtet_model = PyFemtetModel()
@@ -78,22 +62,11 @@ class PoFBoTorchInterface(BoTorchInterface, AbstractSurrogateModelInterfaceBase)
     def __init__(
             self,
             history_path: str,
-            train_history: History = None,
             observation_noise: float | str | None = None,
             feasibility_noise: float | str | None = None,
             feasibility_cdf_threshold: float | str = 0.5,  # or 'sample_mean'
-            _output_directions: (
-                    Sequence[str | float]
-                    | dict[str, str | float]
-                    | dict[int, str | float]
-            ) = None
     ):
-        AbstractSurrogateModelInterfaceBase.__init__(
-            self,
-            history_path,
-            train_history,
-            _output_directions
-        )
+        AbstractSurrogateModelInterfaceBase.__init__(self, history_path, None)
 
         self.model = SingleTaskGPModel()
         self.pyfemtet_model = PyFemtetModel()