pyfemtet 1.0.0a0__tar.gz → 1.0.0b0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyfemtet
-Version: 1.0.0a0
+Version: 1.0.0b0
 Summary: Design parameter optimization using Femtet.
 License: MIT
 Author: kazuma.naito
@@ -28,7 +28,8 @@ 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 (>=306,<311) ; sys_platform == "win32"
+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: pyyaml (>=6.0.2,<7)
 Requires-Dist: scipy (>=1.11.4,<2)
 Requires-Dist: torch

{pyfemtet-1.0.0a0 → pyfemtet-1.0.0b0}/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.0a0 → pyfemtet-1.0.0b0}/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-1.0.0a0 → pyfemtet-1.0.0b0}/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-1.0.0a0 → pyfemtet-1.0.0b0}/pyfemtet/opt/femopt.py

@@ -71,16 +71,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 +93,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-1.0.0a0 → pyfemtet-1.0.0b0}/pyfemtet/opt/history/_history.py

@@ -46,7 +46,7 @@ __all__ = [
 MAIN_FILTER: dict = {'sub_fidelity_name': MAIN_FIDELITY_NAME}
 
 
-logger = get_module_logger('opt.history', True)
+logger = get_module_logger('opt.history', False)
 
 
 def create_err_msg_from_exception(e: Exception):

{pyfemtet-1.0.0a0 → pyfemtet-1.0.0b0}/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
@@ -119,6 +118,7 @@ class FemtetInterface(COMInterface):
     """
 
     com_members = {'Femtet': 'FemtetMacro.Femtet'}
+    _show_parametric_index_warning = True  # for GUI
 
     def __init__(
             self,
@@ -129,14 +129,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 +260,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"):
@@ -504,6 +516,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 +539,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.0a0 → pyfemtet-1.0.0b0}/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-1.0.0a0 → pyfemtet-1.0.0b0}/pyfemtet/opt/interface/_femtet_with_solidworks/femtet_with_solidworks_interface.py

@@ -31,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 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-1.0.0b0/pyfemtet/opt/interface/_surrogate_model_interface/base_surrogate_interface.py

@@ -0,0 +1,150 @@
+from __future__ import annotations
+
+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
+
+
+__all__ = [
+    'AbstractSurrogateModelInterfaceBase',
+]
+
+
+class AbstractSurrogateModelInterfaceBase(AbstractFEMInterface):
+    _load_problem_from_fem = True
+    current_obj_values: dict[str, float]
+    train_history: 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
+    ):
+
+        self._output_directions = _output_directions
+
+        # 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):
+
+        # 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 の変数が充分であるかのチェックのみ
+        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.0a0 → pyfemtet-1.0.0b0}/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()

{pyfemtet-1.0.0a0 → pyfemtet-1.0.0b0}/pyfemtet/opt/optimizer/_base_optimizer.py

@@ -32,7 +32,7 @@ DIRECTION: TypeAlias = (
         ]
 )
 
-logger = get_module_logger('opt.optimizer', True)
+logger = get_module_logger('opt.optimizer', False)
 
 
 def _log_hidden_constraint(e: Exception):
@@ -177,11 +177,14 @@ class AbstractOptimizer:
             name: str,
             expression_string: str,
             properties: dict[str, ...] | None = None,
+            *,
+            pass_to_fem: bool = True,
     ) -> None:
         var = ExpressionFromString()
         var.name = name
         var._expr = ExpressionFromString.InternalClass(expression_string=expression_string)
         var.properties = properties or dict()
+        var.pass_to_fem = pass_to_fem
         _duplicated_name_check(name, self.variable_manager.variables.keys())
         self.variable_manager.variables.update({name: var})
 
@@ -190,11 +193,14 @@ class AbstractOptimizer:
             name: str,
             sympy_expr: sympy.Expr,
             properties: dict[str, ...] | None = None,
+            *,
+            pass_to_fem: bool = True,
     ) -> None:
         var = ExpressionFromString()
         var.name = name
         var._expr = ExpressionFromString.InternalClass(sympy_expr=sympy_expr)
         var.properties = properties or dict()
+        var.pass_to_fem = pass_to_fem
         _duplicated_name_check(name, self.variable_manager.variables.keys())
         self.variable_manager.variables.update({name: var})
 
@@ -205,6 +211,8 @@ class AbstractOptimizer:
             properties: dict[str, ...] | None = None,
             args: tuple | None = None,
             kwargs: dict | None = None,
+            *,
+            pass_to_fem: bool = True,
     ) -> None:
         var = ExpressionFromFunction()
         var.name = name
@@ -212,6 +220,7 @@ class AbstractOptimizer:
         var.args = args or tuple()
         var.kwargs = kwargs or dict()
         var.properties = properties or dict()
+        var.pass_to_fem = pass_to_fem
         _duplicated_name_check(name, self.variable_manager.variables.keys())
         self.variable_manager.variables.update({name: var})
 

{pyfemtet-1.0.0a0 → pyfemtet-1.0.0b0}/pyfemtet/opt/optimizer/optuna_optimizer/_pof_botorch/pof_botorch_sampler.py

@@ -138,7 +138,7 @@ if TYPE_CHECKING:
 # noinspection PyTypeChecker
 _logger = get_logger(False)
 
-DEBUG = True
+DEBUG = False
 logger = get_module_logger('opt.PoFBoTorchSampler', DEBUG)
 
 warnings.filterwarnings('ignore', category=InputDataWarning)

{pyfemtet-1.0.0a0 → pyfemtet-1.0.0b0}/pyproject.toml

@@ -11,7 +11,8 @@ dependencies = [
     "tqdm>=4.66.1,<5",
     "colorlog>=6.8.0,<7",
     "psutil>=5.9.6,<6",
-    "pywin32>=306, <311 ; sys_platform=='win32'",  # python pinning
+    "pywin32<307 ; sys_platform == 'win32' and python_version < '3.13'",
+    "pywin32>=309 ; sys_platform == 'win32' and python_version >= '3.13'",
     "femtetutils>=1.0.0,<2 ; sys_platform=='win32'",
     "dask~=2024.12.1",
     "distributed~=2024.12.1",
@@ -32,7 +33,7 @@ dependencies = [
 
 #[project.optional-dependencies]
 #brep = ["brepmatching>=0.1.8,<0.2"]
-version = "1.0.0a0"
+version = "1.0.0b0"
 
 [project.urls]
 Repository = "https://github.com/pyfemtet/pyfemtet"

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

@@ -1,59 +0,0 @@
-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}.')