pyfemtet 1.0.0b0__tar.gz → 1.5.1__tar.gz

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

@@ -1,17 +1,19 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pyfemtet
-Version: 1.0.0b0
+Version: 1.5.1
 Summary: Design parameter optimization using Femtet.
-License: MIT
-Author: kazuma.naito
+License-Expression: MIT
+License-File: LICENSE
+License-File: LICENSE_THIRD_PARTY.txt
+Author: pyfemtet
 Author-email: 148934231+pyfemtet@users.noreply.github.com
-Requires-Python: >= 3.10, < 3.14
-Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >= 3.10, < 3.15
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: babel (>=2.15.0,<3)
 Requires-Dist: botorch (>=0.12.0,<0.15.0)
 Requires-Dist: colorlog (>=6.8.0,<7)
@@ -21,15 +23,15 @@ Requires-Dist: dask (>=2024.12.1,<2024.13.0)
 Requires-Dist: distributed (>=2024.12.1,<2024.13.0)
 Requires-Dist: femtetutils (>=1.0.0,<2) ; sys_platform == "win32"
 Requires-Dist: fire (>=0.7)
+Requires-Dist: frozendict (>=2.4.6)
 Requires-Dist: numpy (>=2.0.0,<3)
 Requires-Dist: openpyxl (>=3.1.2,<4)
-Requires-Dist: optuna (>=3.4.0,<5.0.0)
+Requires-Dist: optuna (>=4.5.0,<4.6.0)
 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 (>=310) ; sys_platform == "win32"
 Requires-Dist: pyyaml (>=6.0.2,<7)
 Requires-Dist: scipy (>=1.11.4,<2)
 Requires-Dist: torch

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

@@ -976,11 +976,11 @@ msgstr "解析モデル互換性チェックで不明なエラーが発生しま
 
 #: pyfemtet/opt/visualization/plotter/pm_graph_creator.py:146
 msgid "Upper of pred. std-dev"
-msgstr "予測標準偏差の上限"
+msgstr "予測の標準偏差(+)"
 
 #: pyfemtet/opt/visualization/plotter/pm_graph_creator.py:150
 msgid "Lower of pred. std-dev"
-msgstr "予測標準偏差の小さい方"
+msgstr "予測の標準偏差(-)"
 
 #: pyfemtet/opt/visualization/plotter/pm_graph_creator.py:183
 msgid "Std-dev of pred."

{pyfemtet-1.0.0b0 → pyfemtet-1.5.1}/pyfemtet/_i18n/messages.py

@@ -59,7 +59,6 @@ class Message:
     ERR_RUN_JOURNAL_NOT_FOUND = _(r'"%UGII_BASE_DIR%\NXBIN\run_journal.exe" is not found. Make sure you have NX installed and the environment variable UGII_BASE_DIR is set.')
     ERR_MODEL_RECONSTRUCTION_FAILED = _('Model reconstruction failed.')
     ERR_MODEL_UPDATE_FAILED = _('Model update failed.')
-    ERR_NO_MAKEPY = _('It was detected that the configuration of Femtet python macro constants has not been completed. The configuration was done automatically (python -m win32com.client.makepy FemtetMacro). Please restart the program. If the error persists, please run "py -m win32com.client.makepy FemtetMacro" or "python -m win32com.client.makepy FemtetMacro" on the command prompt.')
     ERR_FEMTET_CONNECTION_FAILED = _('Failed to connect to Femtet.')
 
     @staticmethod

{pyfemtet-1.0.0b0 → pyfemtet-1.5.1}/pyfemtet/_util/dask_util.py

@@ -23,6 +23,7 @@ remove_all_output(get_dask_logger())
 warnings.filterwarnings('ignore', category=RuntimeWarning, message="Couldn't detect a suitable IP address")
 
 cfg.set({'distributed.scheduler.worker-ttl': None})
+cfg.set({"distributed.scheduler.locks.lease-timeout": "inf"})
 
 logger = get_module_logger('opt.dask', False)
 
@@ -40,9 +41,9 @@ __all__ = [
 _lock_pool = {}
 
 
-def get_client():
+def get_client(scheduler_address=None):
     try:
-        return _get_client()
+        return _get_client(scheduler_address)
     except ValueError:
         return None
 
@@ -62,9 +63,7 @@ def Lock(name, client=None):
 
     if client is not None:
         # import inspect
-        # logger.debug(f'{name}, {[stack.function for stack in inspect.stack()[1:]]}')
-        with cfg.set({"distributed.scheduler.locks.lease-timeout": "inf"}):
-            _lock = _DaskLock(name)
+        _lock = _DaskLock(name)
 
     else:
         if name in _lock_pool:

pyfemtet-1.5.1/pyfemtet/_util/df_util.py

@@ -0,0 +1,61 @@
+from typing import TypeAlias, Literal
+from math import isnan
+import pandas as pd
+
+
+__all__ = [
+    'apply_partial_df',
+    'get_partial_df',
+]
+
+
+_Method: TypeAlias = Literal['all', 'any', 'all-exclude']
+
+
+def get_index(df, equality_filters, method: _Method = 'all'):
+    # 値渡しに変換
+    equality_filters = equality_filters.copy()
+
+    # フィルタ条件に一致する行のインデックスを取得
+
+    # 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
+    if 'all' in method.lower():
+        out: pd.Series = (df[list(equality_filters.keys())] == pd.Series(equality_filters)).all(axis=1)
+    elif 'any' in method.lower():
+        out: pd.Series = (df[list(equality_filters.keys())] == pd.Series(equality_filters)).any(axis=1)
+    else:
+        raise NotImplementedError(f'Unknown method: {method}')
+
+    # na との比較
+    for key in want_na_keys:
+        out = out & df[key].isna()
+
+    if 'exclude' in method:
+        out = ~out
+
+    return out
+
+
+def get_partial_df(df: pd.DataFrame, equality_filters: dict, method: _Method = 'all'):
+    return df[get_index(df, equality_filters, method=method)]
+
+
+def apply_partial_df(df: pd.DataFrame, partial_df: pd.DataFrame, equality_filters: dict):
+
+    idx = get_index(df, equality_filters)
+
+    # インデクスに対応する部分を上書き
+    assert len(df[idx]) == len(partial_df), ('equality_filters の実行結果と'
+                                             '与えられた partial_df の長さが一致しません。')
+    df[idx] = partial_df
+
+    return df

{pyfemtet-1.0.0b0 → pyfemtet-1.5.1}/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-1.5.1/pyfemtet/_util/solidworks_variable.py

@@ -0,0 +1,169 @@
+from typing import TypeAlias
+
+SWVariables: TypeAlias = dict[str, str]
+"""<prm_name>: <expression>. Note that the <prm_name> does not contain `"`."""
+
+
+class EquationContext:
+    def __init__(self, swModel) -> None:
+        self.swModel = swModel
+        self.swEqnMgr = None
+
+    def __enter__(self):
+        # プロパティを退避
+        self.swEqnMgr = self.swModel.GetEquationMgr
+        self.buffer_aso = self.swEqnMgr.AutomaticSolveOrder
+        self.buffer_ar = self.swEqnMgr.AutomaticRebuild
+        self.swEqnMgr.AutomaticSolveOrder = False
+        self.swEqnMgr.AutomaticRebuild = False
+        return self.swEqnMgr
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        # プロパティをもとに戻す
+        assert self.swEqnMgr is not None
+        self.swEqnMgr.AutomaticSolveOrder = self.buffer_aso
+        self.swEqnMgr.AutomaticRebuild = self.buffer_ar
+
+
+class EditPartContext:
+    def __init__(self, swModel, component) -> None:
+        self.swModel = swModel
+        self.component = component
+
+    def __enter__(self):
+        swSelMgr = self.swModel.SelectionManager
+        swSelData = swSelMgr.CreateSelectData
+        swSelMgr.AddSelectionListObject(self.component, swSelData)
+        # self.swModel.EditPart()  # 対象がアセンブリの場合動作しない
+        self.swModel.AssemblyPartToggle()  # Obsolete だが代わりにこれを使う
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.swModel.EditAssembly()
+
+
+def is_assembly(swModel_or_name):
+    if isinstance(swModel_or_name, str):
+        return swModel_or_name.lower().endswith('.sldasm')
+    else:
+        return swModel_or_name.GetPathName.lower().endswith('.sldasm')
+
+
+def _iter_parts(swModel):
+    components = swModel.GetComponents(
+        False  # TopOnly
+    )
+    return components
+
+
+# Used by pyfemtet-opt-gui
+class SolidworksVariableManager:
+
+    def __init__(self, logger=None):
+        # Used by pyfemtet-opt-gui
+        self.updated_objects = set()
+        """Updated variable names, sldprt file paths and linked .txt equation file paths."""
+        if logger is None:
+            from logging import getLogger
+            logger = getLogger('solidworks_variable_manager')
+        self.logger = logger
+
+    # Used by pyfemtet-opt-gui
+    def update_global_variables_recourse(self, swModel, x: SWVariables):
+        # まず自身のパラメータを更新
+        self.logger.debug(f'Processing `{swModel.GetPathName}`')
+        self._update_global_variables_core(swModel, x)
+
+        # アセンブリならば、構成部品のパラメータを更新
+        if is_assembly(swModel):
+            components = _iter_parts(swModel)
+            for component in components:
+                swPartModel = component.GetModelDoc2
+                self.logger.debug(f'Checking `{swPartModel.GetPathName}`')
+                if swPartModel.GetPathName.lower() not in self.updated_objects:
+                    self.logger.debug(f'Processing `{swPartModel.GetPathName}`')
+                    with EditPartContext(swModel, component):
+                        self._update_global_variables_core(swPartModel, x)
+                    self.updated_objects.add(swPartModel.GetPathName.lower())
+
+    def _update_global_variables_core(self, swModel, x: SWVariables):
+        with EquationContext(swModel) as swEqnMgr:
+            # txt にリンクされている場合は txt を更新
+            if swEqnMgr.LinkToFile:
+                self._update_global_variables_linked_txt(swEqnMgr, x)
+            self._update_global_variables_simple(swEqnMgr, x)
+            # noinspection PyStatementEffect
+            swEqnMgr.EvaluateAll
+
+    def _update_global_variables_linked_txt(self, swEqnMgr, x: SWVariables):
+        txt_path = swEqnMgr.FilePath
+        if txt_path in self.updated_objects:
+            return
+        with open(txt_path, 'r', encoding='utf_8_sig') as f:
+            equations = [line.strip() for line in f.readlines() if line.strip() != '']
+        for i, eq in enumerate(equations):
+            equations[i] = self._update_equation(eq, x)
+        with open(txt_path, 'w', encoding='utf_8_sig') as f:
+            f.writelines([eq + '\n' for eq in equations])
+        self.logger.debug(f'`{txt_path}` is updated.')
+        self.updated_objects.add(txt_path)
+
+    def _update_global_variables_simple(self, swEqnMgr, x: SWVariables):
+        nEquation = swEqnMgr.GetCount
+
+        # equation を列挙
+        self.logger.debug(f'{nEquation} equations detected.')
+        for i in range(nEquation):
+            # name, equation の取得
+            eq = swEqnMgr.Equation(i)
+            prm_name = self._get_left(eq)
+            # COM 経由なので必要な時以外は触らない
+            self.logger.debug(f'Checking `{prm_name}`')
+            if (prm_name in x) and (prm_name not in self.updated_objects):
+                self.logger.debug(f'Processing `{prm_name}`')
+                # 特定の Equation がテキストリンク有効か
+                # どうかを判定する術がないので、一旦更新する
+                new_eq = self._update_equation(eq, x)
+                swEqnMgr.Equation(i, new_eq)
+                # テキストリンクの場合、COM インスタンスに
+                # 更新された値が残ってしまうのでテキストを再読み込み
+                if swEqnMgr.LinkToFile:
+                    # noinspection PyStatementEffect
+                    swEqnMgr.UpdateValuesFromExternalEquationFile
+                self.updated_objects.add(prm_name)
+
+    def _update_equation(self, equation: str, x: SWVariables):
+        prm_name = self._get_left(equation)
+        if prm_name not in x:
+            return equation
+        new_eq = f'"{prm_name}" = {x[prm_name]}'
+        self.logger.debug(f'New eq.: `{new_eq}`')
+        return new_eq
+
+    @staticmethod
+    def _get_left(equation: str):
+        tmp = equation.split('=')
+        if len(tmp) == 0:
+            raise RuntimeError(f'Invalid solidworks equation: {equation} (no `=` contained)')
+        return tmp[0].strip('" ')
+
+    # Used by pyfemtet-opt-gui
+    @staticmethod
+    def get_equations_recourse(swModel, global_variables_only=False) -> list[str]:
+        out = list()
+        swEqnMgr = swModel.GetEquationMgr
+        for i in range(swEqnMgr.GetCount):
+            if global_variables_only and not swEqnMgr.GlobalVariable(i):
+                continue
+            eq = swEqnMgr.Equation(i)
+            out.append(eq)
+        if is_assembly(swModel):
+            components = _iter_parts(swModel)
+            for component in components:
+                swPartModel = component.GetModelDoc2
+                swEqnMgr = swPartModel.GetEquationMgr
+                for i in range(swEqnMgr.GetCount):
+                    if global_variables_only and not swEqnMgr.GlobalVariable(i):
+                        continue
+                    eq = swEqnMgr.Equation(i)
+                    out.append(eq)
+        return out

pyfemtet-1.5.1/pyfemtet/_util/symbol_support_for_param_name.py

@@ -0,0 +1,15 @@
+at = '@'
+AT = '_at_'
+hyphen = '-'
+HYPHEN = '_hyphen_'
+dot = '.'
+DOT = '_dot_'
+
+
+def convert_symbols(name):
+    return (
+        name
+        .replace(dot, DOT)
+        .replace(at, AT)
+        .replace(hyphen, HYPHEN)
+    )

{pyfemtet-1.0.0b0 → pyfemtet-1.5.1}/pyfemtet/logger/_impl.py

@@ -81,6 +81,7 @@ def __create_formatter(colored=True):
 # ===== handler config =====
 
 STDOUT_HANDLER_NAME = 'stdout-handler'
+STDERR_HANDLER_NAME = 'stderr-handler'
 
 
 def __get_stdout_handler():
@@ -94,6 +95,17 @@ def __has_stdout_handler(logger):
     return any([handler.get_name() != STDOUT_HANDLER_NAME for handler in logger.handlers])
 
 
+def __get_stderr_handler():
+    stderr_handler = logging.StreamHandler(sys.stderr)
+    stderr_handler.set_name(STDERR_HANDLER_NAME)
+    stderr_handler.setFormatter(__create_formatter(colored=True))
+    return stderr_handler
+
+
+def __has_stderr_handler(logger):
+    return any([handler.get_name() != STDERR_HANDLER_NAME for handler in logger.handlers])
+
+
 def set_stdout_output(logger, level=logging.INFO):
 
     if not __has_stdout_handler(logger):
@@ -107,6 +119,19 @@ def remove_stdout_output(logger):
         logger.removeHandler(__get_stdout_handler())
 
 
+def set_stderr_output(logger, level=logging.INFO):
+
+    if not __has_stderr_handler(logger):
+        logger.addHandler(__get_stderr_handler())
+
+    logger.setLevel(level)
+
+
+def remove_stderr_output(logger):
+    if __has_stderr_handler(logger):
+        logger.removeHandler(__get_stderr_handler())
+
+
 def add_file_output(logger, filepath=None, level=logging.INFO) -> str:
     """Add FileHandler to the logger.
 
@@ -165,7 +190,7 @@ def setup_package_root_logger(package_name):
         with __lock:
             logger = logging.getLogger(package_name)
             logger.propagate = True
-            set_stdout_output(logger)
+            set_stderr_output(logger)
             logger.setLevel(logging.INFO)
             __initialized_root_packages.append(package_name)
     else:

{pyfemtet-1.0.0b0 → pyfemtet-1.5.1}/pyfemtet/opt/exceptions.py

@@ -39,7 +39,17 @@ class InterruptOptimization(ExceptionDuringOptimization): ...
 class SkipSolve(ExceptionDuringOptimization): ...
 
 
-def show_experimental_warning(feature_name):
-    warnings.warn(f'{feature_name} は実験的機能です。将来 API 等が'
-                  f'大きく変更されるか、機能自体が削除される'
-                  f'可能性があります。')
+_shown = set()
+
+
+def show_experimental_warning(feature_name, logger=None):
+    global _shown
+    if feature_name not in _shown:
+        _shown.add(feature_name)
+        msg = (f'{feature_name} は実験的機能です。将来 API 等が'
+               '大きく変更されるか、機能自体が削除される'
+               '可能性があります。')
+        if logger is not None:
+            logger.warning(msg)
+        else:
+            warnings.warn(msg)

{pyfemtet-1.0.0b0 → pyfemtet-1.5.1}/pyfemtet/opt/femopt.py

@@ -1,4 +1,6 @@
 from __future__ import annotations
+
+import platform
 from typing import Callable, Sequence
 
 import os
@@ -18,6 +20,7 @@ from pyfemtet.opt.problem.variable_manager import *
 from pyfemtet.opt.interface import *
 from pyfemtet.opt.optimizer import *
 from pyfemtet.opt.optimizer._base_optimizer import DIRECTION
+from pyfemtet.opt.history import History
 from pyfemtet.logger import get_module_logger
 from pyfemtet.opt.visualization.history_viewer._process_monitor._application import (
     process_monitor_main,
@@ -29,6 +32,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__(
@@ -101,8 +117,8 @@ class FEMOpt:
     def add_categorical_parameter(
             self,
             name: str,
-            initial_value: str | None = None,
-            choices: list[str] | None = None,
+            initial_value: SupportedVariableTypes | None = None,
+            choices: list[SupportedVariableTypes] | None = None,
             properties: dict[str, ...] | None = None,
             *,
             pass_to_fem: bool = True,
@@ -144,6 +160,21 @@ class FEMOpt:
     ):
         self.opt.add_constraint(name, fun, lower_bound, upper_bound, args, kwargs, strict, using_fem)
 
+    def add_other_output(
+            self,
+            name: str,
+            fun: Callable[..., float],
+            args: tuple | None = None,
+            kwargs: dict | None = None,
+    ):
+        self.opt.add_other_output(name, fun, args, kwargs)
+
+    def add_trial(
+            self,
+            parameters: dict[str, SupportedVariableTypes],
+    ):
+        self.opt.add_trial(parameters)
+
     def add_sub_fidelity_model(
             self,
             name: str,
@@ -152,6 +183,12 @@ class FEMOpt:
     ):
         self.opt.add_sub_fidelity_model(name, sub_fidelity_model, fidelity)
 
+    def set_termination_condition(
+            self,
+            func: Callable[[History], bool] | None,
+    ):
+        self.opt.set_termination_condition(func)
+
     def set_monitor_host(self, host: str = None, port: int = None):
         """Sets the host IP address and the port of the process monitor.
 
@@ -345,19 +382,20 @@ class FEMOpt:
             def save_history():
                 while True:
                     sleep(2)
-                    try:
-                        self.opt.history.save()
-                        logger.debug('History saved!')
-                    except PermissionError:
-                        logger.error(
-                            _('Cannot save history. '
-                              'The most common reason is '
-                              'that the csv is opened by '
-                              'another program (such as Excel). '
-                              'Please free {path} or lost the '
-                              'optimization history.',
-                              path=self.opt.history.path)
-                        )
+                    if len(self.opt.history.get_df()) > 0:
+                        try:
+                            self.opt.history.save()
+                            logger.debug('History saved!')
+                        except PermissionError:
+                            logger.error(
+                                _('Cannot save history. '
+                                  'The most common reason is '
+                                  'that the csv is opened by '
+                                  'another program (such as Excel). '
+                                  'Please free {path} or lost the '
+                                  'optimization history.',
+                                  path=self.opt.history.path)
+                            )
                     if entire_status.value >= WorkerStatus.finished:
                         break
                 logger.debug('History save thread finished!')
@@ -442,21 +480,22 @@ class FEMOpt:
                                'using the result viewer.\n'
                                'The result viewer can be launched by '
                                'performing one of the following actions:\n'
-                               '- (Windows only) Launch the `pyfemtet-opt-result-viewer` '
+                               '- {windows_only}Launch the `pyfemtet-opt-result-viewer` '
                                'shortcut on your desktop if exists.\n'
-                               '- (Windows only) Launch {path}.\n'
+                               '- {windows_only}Launch {path}.\n'
                                '- Execute "py -m pyfemtet.opt.visualization.history_viewer" '
                                'in the command line',
                     jp_message='プログラム終了後も、結果ビューワを使って最適化結果を'
                                '確認することができます。'
                                '結果ビューワは以下のいずれかを実施すると起動できます。\n'
-                               '- （Windows のみ）デスクトップの pyfemtet-opt-result-viewer '
+                               '- {windows_only}デスクトップの pyfemtet-opt-result-viewer '
                                'ショートカットを起動する\n'
-                               '- （Windows のみ）{dir} にある {filename} を起動する\n'
+                               '- {windows_only}{dir} にある {filename} を起動する\n'
                                '- コマンドラインで「py -m pyfemtet.opt.visualization.history_viewer」'
                                'を実行する',
                     dir=os.path.abspath(os.path.dirname(sys.executable)),
                     filename='pyfemtet-opt-result-viewer.exe (or .cmd)',
+                    windows_only='(Windows only) ' if platform.system() != 'Windows' else '',
                 )
                 print("====================")
                 print(confirm_msg)

{pyfemtet-1.0.0b0 → pyfemtet-1.5.1}/pyfemtet/opt/history/__init__.py

@@ -8,4 +8,5 @@ __all__ = [
     'create_err_msg_from_exception',
     'CorrespondingColumnNameRuler',
     'MAIN_FILTER',
+    'get_trial_name',
 ]