pyfemtet 1.0.0a0__py3-none-any.whl → 1.0.1__py3-none-any.whl

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/_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', True)
+logger = get_module_logger('opt.dask', False)
 
 
 __all__ = [

pyfemtet/_util/df_util.py

@@ -1,3 +1,4 @@
+from math import isnan
 import pandas as pd
 
 
@@ -9,8 +10,24 @@ __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
-    return (df[list(equality_filters.keys())] == pd.Series(equality_filters)).all(axis=1)
+    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
 
 
 def get_partial_df(df: pd.DataFrame, equality_filters: dict):

pyfemtet/_util/helper.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
 from typing import Callable
+
+import string
+import secrets
 import warnings
 from time import time, sleep
 from threading import Thread
@@ -10,6 +13,7 @@ from pyfemtet._i18n import _
 __all__ = [
     'float_',
     'time_counting',
+    'generate_random_id',
 ]
 
 
@@ -92,3 +96,8 @@ 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/opt/__init__.py

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

pyfemtet/opt/femopt.py

@@ -29,6 +29,19 @@ 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__(
@@ -71,16 +84,20 @@ 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)
+        self.opt.add_expression_string(name, expression_string, properties, pass_to_fem=pass_to_fem)
 
     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)
+        self.opt.add_expression_sympy(name, sympy_expr, properties, pass_to_fem=pass_to_fem)
 
     def add_expression(
             self,
@@ -89,8 +106,10 @@ 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)
+        self.opt.add_expression(name, fun, properties, args, kwargs, pass_to_fem=pass_to_fem)
 
     def add_categorical_parameter(
             self,

pyfemtet/opt/history/_history.py

@@ -18,6 +18,7 @@ import pandas as pd
 import pyfemtet
 
 from pyfemtet._i18n import *
+from pyfemtet._util.helper import generate_random_id
 from pyfemtet._util.df_util import *
 from pyfemtet._util.dask_util import *
 from pyfemtet._util.str_enum import StrEnum
@@ -43,10 +44,13 @@ __all__ = [
     'MAIN_FILTER',
 ]
 
-MAIN_FILTER: dict = {'sub_fidelity_name': MAIN_FIDELITY_NAME}
+MAIN_FILTER: dict = {
+    'sub_fidelity_name': MAIN_FIDELITY_NAME,
+    'sub_sampling': float('nan')
+}
 
 
-logger = get_module_logger('opt.history', True)
+logger = get_module_logger('opt.history', False)
 
 
 def create_err_msg_from_exception(e: Exception):
@@ -126,9 +130,10 @@ class DataFrameWrapper:
 
     __df: pd.DataFrame
     _lock_name = 'edit-df'
-    _dataset_name = 'df'
+    _dataset_name: str
 
     def __init__(self, df: pd.DataFrame):
+        self._dataset_name = 'df-' + generate_random_id()
         self.set_df(df)
 
     def __len__(self):
@@ -1053,6 +1058,14 @@ 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(
@@ -1062,13 +1075,13 @@ class Records:
             )
             mgr.update_optimality()
             mgr.update_hypervolume()
-            mgr.update_trial_number()
+            if not trial_processed:
+                mgr.update_trial_number()  # per_fidelity
             pdf = mgr.partial_df
             apply_partial_df(df=processing_df, partial_df=pdf, equality_filters=equality_filters)
 
             # update sub fidelity
-            entire_df = self.df_wrapper.get_df()
-            sub_fidelity_names: list = np.unique(entire_df['sub_fidelity_name']).tolist()
+            sub_fidelity_names: list = np.unique(processing_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:
@@ -1078,7 +1091,8 @@ class Records:
                     equality_filters,
                     processing_df
                 )
-                mgr.update_trial_number()
+                if not trial_processed:
+                    mgr.update_trial_number()  # per_fidelity
             pdf = mgr.partial_df
             apply_partial_df(df=processing_df, partial_df=pdf, equality_filters=equality_filters)
 

pyfemtet/opt/interface/_excel_interface/excel_interface.py

@@ -258,8 +258,6 @@ 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/opt/interface/_femtet_interface/femtet_interface.py

@@ -4,7 +4,6 @@ from typing import TYPE_CHECKING
 
 import os
 import sys
-import warnings
 import subprocess
 from time import sleep
 from contextlib import nullcontext
@@ -103,8 +102,6 @@ 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**
@@ -119,6 +116,8 @@ class FemtetInterface(COMInterface):
     """
 
     com_members = {'Femtet': 'FemtetMacro.Femtet'}
+    _show_parametric_index_warning = True  # for GUI
+    _femtet_connection_timeout = 10
 
     def __init__(
             self,
@@ -129,14 +128,19 @@ 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:
-            warnings.warn(
-                "解析モデルに設定された既存のスイープテーブルは削除されます。"
-            )
+            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()` '
+                               'を使ってください。',
+                ))
 
         # 引数の処理
         if femprj_path is None:
@@ -255,6 +259,13 @@ 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"):
@@ -304,9 +315,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=5)
+            self.Femtet, self.femtet_pid = dispatch_femtet(timeout=self._femtet_connection_timeout)
         else:
-            self.Femtet, self.femtet_pid = dispatch_specific_femtet(pid, timeout=5)
+            self.Femtet, self.femtet_pid = dispatch_specific_femtet(pid, timeout=self._femtet_connection_timeout)
         self.connected_method = "existing"
 
     def connect_femtet(self, connect_method: str = "auto", pid: int or None = None):
@@ -504,6 +515,8 @@ 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):
 
@@ -525,7 +538,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/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 or float] = None,  # TODO: Remove this
+            parametric_output_indexes_use_as_objective: dict[int, str | float] = None,
             always_open_copy=False,
             export_curves: bool or None = None,
             export_surfaces: bool or None = None,

pyfemtet/opt/interface/_femtet_with_solidworks/femtet_with_solidworks_interface.py

@@ -20,6 +20,26 @@ 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,
@@ -31,7 +51,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 or float] = None,
+            parametric_output_indexes_use_as_objective: dict[int, str | float] = None,
             always_open_copy=False,
             close_solidworks_on_terminate=False,
             solidworks_visible=True,

pyfemtet/opt/interface/_solidworks_interface/solidworks_interface.py

@@ -41,6 +41,27 @@ 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/opt/interface/_surrogate_model_interface/base_surrogate_interface.py

@@ -1,10 +1,11 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Sequence
 
 from pyfemtet.opt.history import *
 
 from pyfemtet.opt.interface import AbstractFEMInterface
+from pyfemtet._i18n import _
 
 if TYPE_CHECKING:
     from pyfemtet.opt.optimizer import AbstractOptimizer
@@ -16,6 +17,7 @@ __all__ = [
 
 
 class AbstractSurrogateModelInterfaceBase(AbstractFEMInterface):
+    _load_problem_from_fem = True
     current_obj_values: dict[str, float]
     train_history: History
 
@@ -23,8 +25,15 @@ class AbstractSurrogateModelInterfaceBase(AbstractFEMInterface):
             self,
             history_path: str = None,
             train_history: History = None,
+            _output_directions: (
+                Sequence[str | float]
+                | dict[str, str | float]
+                | dict[int, str | float]
+            ) = None
     ):
 
+        self._output_directions = _output_directions
+
         # history_path が与えられた場合、train_history をコンストラクトする
         if history_path is not None:
             train_history = History()
@@ -37,13 +46,95 @@ class AbstractSurrogateModelInterfaceBase(AbstractFEMInterface):
         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_]
+
+        # output directions が与えられない場合、
+        # opt.add_objective との整合をチェックする
+        if self._output_directions is None:
+
+            # add_objective された目的のうち、
+            # training data に含まれる名前ならば
+            # fun を「その時点の current_obj_values を返す関数」で
+            # 上書き
+            obj_name: str
+            for obj_name, obj in opt.objectives.items():
+                # あれば上書き、なければ surrogate 最適化の際に
+                # 新しく追加した model を使わない目的関数と見做して何もしない
+                if obj_name in self.train_history.obj_names:
+                    obj.fun = lambda _, obj_name_=obj_name: self.current_obj_values[obj_name_]
+
+        # dict で与えられた場合
+        elif isinstance(self._output_directions, dict):
+
+            # index 入力か str 入力かで統一されているか確認
+            keys = tuple(self._output_directions.keys())
+            assert all([isinstance(key, type(keys[0])) for key in keys]), _(
+                en_message='The keys of _output_directions must be '
+                           'all-int or all-str.',
+                jp_message='_output_directions のキーは int または str で'
+                           '統一されていなければなりません。',
+            )
+
+            # index がキーである場合
+            if isinstance(keys[0], int):
+
+                for index, direction in self._output_directions.items():
+                    obj_name = self.train_history.obj_names[index]
+
+                    opt.add_objective(
+                        name=obj_name,
+                        fun=lambda _, obj_name_=obj_name: self.current_obj_values[obj_name_],
+                        direction=direction,
+                        args=(),
+                        kwargs={},
+                    )
+
+            # obj_name がキーである場合
+            if isinstance(keys[0], str):
+
+                for obj_name, direction in self._output_directions.items():
+                    assert obj_name in self.train_history.obj_names, _(
+                        en_message='The objective name passed as a key of '
+                                   '_output_direction must be one of the history\'s '
+                                   'objective names. Passed name: {obj_name} / '
+                                   'History\'s names: {obj_names}',
+                        jp_message='_output_directions に目的関数名を与える場合は'
+                                   'history に含まれる名前を指定しなければなりません。'
+                                   '与えられた目的名: {obj_name} / history に含まれる'
+                                   '目的名: {obj_names}',
+                        obj_name=obj_name,
+                        obj_names=', '.join(self.train_history.obj_names)
+                    )
+
+                    opt.add_objective(
+                        name=obj_name,
+                        fun=lambda obj_name_=obj_name: self.current_obj_values[obj_name_],
+                        direction=direction,
+                        args=(),
+                        kwargs={},
+                    )
+
+        # tuple で与えられた場合
+        elif isinstance(self._output_directions, list) \
+                or isinstance(self._output_directions, tuple):
+
+            obj_names = self.train_history.obj_names
+            assert len(self._output_directions) == len(obj_names), _(
+                en_message='The length of _output_directions passed as a list '
+                           'must be same with that of the history\'s objective '
+                           'names.',
+                jp_message='_output_directions をリストで渡す場合は'
+                           'その長さが history の目的関数数と一致して'
+                           'いなければなりません。'
+            )
+
+            for obj_name, direction in zip(obj_names, self._output_directions):
+                opt.add_objective(
+                    name=obj_name,
+                    fun=lambda _, obj_name_=obj_name: self.current_obj_values[obj_name_],
+                    direction=direction,
+                    args=(),
+                    kwargs={},
+                )
 
     def load_variables(self, opt: AbstractOptimizer):
         # opt の変数が充分であるかのチェックのみ

pyfemtet/opt/interface/_surrogate_model_interface/botorch_interface.py

@@ -1,3 +1,5 @@
+from typing import Sequence
+
 import numpy as np
 from scipy.stats.distributions import norm
 
@@ -24,8 +26,22 @@ __all__ = [
 
 class BoTorchInterface(AbstractSurrogateModelInterfaceBase):
 
-    def __init__(self, history_path: str = None, train_history: History = None):
-        AbstractSurrogateModelInterfaceBase.__init__(self, history_path, train_history)
+    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
+        )
 
         self.model = SingleTaskGPModel()
         self.pyfemtet_model = PyFemtetModel()
@@ -62,11 +78,22 @@ 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, None)
+        AbstractSurrogateModelInterfaceBase.__init__(
+            self,
+            history_path,
+            train_history,
+            _output_directions
+        )
 
         self.model = SingleTaskGPModel()
         self.pyfemtet_model = PyFemtetModel()