pyfemtet 0.9.5__py3-none-any.whl → 1.0.0b0__py3-none-any.whl

pyfemtet/opt/interface/_femtet_excel.py

@@ -1,141 +0,0 @@
-import re
-from pathlib import Path
-
-from pyfemtet.opt.interface._base import FEMInterface
-from pyfemtet.opt.interface._femtet import FemtetInterface
-from pyfemtet.opt.interface._excel_interface import (
-    ExcelInterface, is_cell_value_empty, ParseAsObjective, ScapeGoatObjective,
-    ParseAsConstraint, search_c, search_r
-)
-
-
-PARAMETRIC_PREFIX = 'パラメトリック'
-
-
-def get_number(name):
-    numbers = re.findall(r'\d+', name)
-    if len(numbers) == 0:
-        raise ValueError('パラメトリック結果出力の番号指定が検出できませんでした。')
-    else:
-        return int(numbers[0])
-
-
-
-class FemtetWithExcelSettingsInterface(FemtetInterface, ExcelInterface, FEMInterface):
-
-    def __init__(
-            self,
-
-            # FemtetInterface arguments
-            femprj_path: str = None, model_name: str = None, connect_method: str = 'auto',
-            save_pdt: str = 'all', 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,
-
-            # ExcelInterface arguments
-            input_xlsm_path: str or Path = None, input_sheet_name: str = None, output_xlsm_path: str or Path = None,
-            output_sheet_name: str = None, constraint_xlsm_path: str or Path = None,
-            constraint_sheet_name: str = None, procedure_name: str = None, procedure_args: list or tuple = None,
-            procedure_timeout: float or None = None,
-            setup_xlsm_path: str or Path = None, setup_procedure_name: str = None,
-            setup_procedure_args: list or tuple = None, teardown_xlsm_path: str or Path = None,
-            teardown_procedure_name: str = None, teardown_procedure_args: list or tuple = None,
-            related_file_paths: list[str or Path] = None, visible: bool = False, display_alerts: bool = False,
-            terminate_excel_when_quit: bool = None, interactive: bool = True, use_named_range: bool = True,
-
-    ):
-
-        excel_connect_method = 'new'
-
-        ExcelInterface.__init__(
-            self, input_xlsm_path, input_sheet_name, output_xlsm_path, output_sheet_name, constraint_xlsm_path,
-            constraint_sheet_name, procedure_name, procedure_args, excel_connect_method, procedure_timeout,
-            setup_xlsm_path, setup_procedure_name, setup_procedure_args, teardown_xlsm_path,
-            teardown_procedure_name, teardown_procedure_args, related_file_paths, visible, display_alerts,
-            terminate_excel_when_quit, interactive, use_named_range)
-
-        FemtetInterface.__init__(
-            self,
-            femprj_path, model_name, connect_method, save_pdt, strictly_pid_specify, allow_without_project,
-            open_result_with_gui, parametric_output_indexes_use_as_objective
-        )
-
-
-    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,
-            raise_if_no_keyword,
-        )
-
-        for i, row in df.iterrows():
-
-            # use(optional)
-            use = True
-            if ParseAsObjective.use in df.columns:
-                _use = row[ParseAsObjective.use]
-                use = False if is_cell_value_empty(_use) else bool(_use)  # bool or NaN
-
-            # name
-            name = str(row[ParseAsObjective.name])
-
-            # direction
-            direction = row[ParseAsObjective.direction]
-            assert not is_cell_value_empty(direction), 'direction is empty.'
-            try:
-                direction = float(direction)
-            except ValueError:
-                direction = str(direction).lower()
-                assert direction in ['minimize', 'maximize']
-
-            if use:
-
-                # name が「パラメトリック」から始まっていたら
-                # パラメトリック解析の結果を目的関数にする
-                if name.startswith(PARAMETRIC_PREFIX):
-                    number = get_number(name)
-                    self.use_parametric_output_as_objective(number, direction)
-
-                # そうでなければ通常の Excel objective を作る
-                else:
-                    opt.objectives[name] = Objective(
-                        fun=ScapeGoatObjective(),
-                        name=name,
-                        direction=direction,
-                        args=(name,),
-                        kwargs=dict(),
-                    )
-
-    def _setup_before_parallel(self, client):
-        FemtetInterface._setup_before_parallel(self, client)
-        ExcelInterface._setup_before_parallel(self, client)
-
-    def _setup_after_parallel(self, *args, **kwargs):
-        FemtetInterface._setup_after_parallel(self, *args, **kwargs)
-        ExcelInterface._setup_after_parallel(self, *args, **kwargs)
-
-    def update(self, parameters) -> None:
-        FemtetInterface.update(self, parameters)
-        ExcelInterface.update(self, parameters)
-
-    def quit(self, timeout=1, force=True):
-        FemtetInterface.quit(self, timeout, force)
-        ExcelInterface.quit(self)
-
-    # noinspection PyMethodOverriding
-    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)
-        v = self.sh_output.Cells(r, c).value
-        return float(v)
-
-    # noinspection PyMethodOverriding
-    def constraint_from_excel(self, _, name: str):
-        r = 1 + search_r(self.constraint_xlsm_path, self.constraint_sheet_name, name)
-        c = 1 + search_c(self.constraint_xlsm_path, self.constraint_sheet_name, ParseAsConstraint.value)
-        v = self.sh_constraint.Cells(r, c).value
-        return float(v)

pyfemtet/opt/interface/_femtet_with_nx/__init__.py

@@ -1,3 +0,0 @@
-from ._interface import FemtetWithNXInterface
-
-__all__ = ['FemtetWithNXInterface']

pyfemtet/opt/interface/_femtet_with_nx/_interface.py

@@ -1,178 +0,0 @@
-import os
-import json
-import subprocess
-
-import pandas as pd
-from dask.distributed import get_worker
-
-from pyfemtet.core import ModelError
-from pyfemtet.opt.interface._femtet import FemtetInterface
-from pyfemtet._message import Msg
-
-
-here, me = os.path.split(__file__)
-
-
-class FemtetWithNXInterface(FemtetInterface):
-    """Control Femtet and NX.
-
-    Using this class, you can import CAD files created
-    in NX through the Parasolid format into a
-    Femtet project. It allows you to pass design
-    variables to NX, update the model, and
-    perform analysis using the updated model in Femtet.
-
-    Args:
-        prt_path (str):
-            The path to .prt file containing the
-            CAD data from which the import is made.
-
-        export_curves(bool or None, optional):
-            Defaults to None.
-        export_surfaces(bool or None, optional):
-            Defaults to None.
-        export_solids(bool or None, optional):
-            Defaults to None.
-        export_flattened_assembly(bool or None, optional):
-            Defaults to None.
-        **kwargs:
-            For other arguments, please refer to the
-            :class:`FemtetInterface` class.
-
-    Notes:
-        ```export_*``` arguments sets
-        parasolid export setting of NX.
-        If None, PyFemtet does not change
-        the current setting of NX.
-
-        It is recommended not to change these values
-        from the settings used when exporting the
-        Parasolid that was imported into Femtet.
-
-    """
-
-    _JOURNAL_PATH = os.path.abspath(os.path.join(here, 'update_model.py'))
-
-    def __init__(
-            self,
-            prt_path,
-            export_curves: bool or None = None,
-            export_surfaces: bool or None = None,
-            export_solids: bool or None = None,
-            export_flattened_assembly: bool or None = None,
-            **kwargs
-    ):
-        # check NX installation
-        self.run_journal_path = os.path.join(os.environ.get('UGII_BASE_DIR'), 'NXBIN', 'run_journal.exe')
-        if not os.path.isfile(self.run_journal_path):
-            raise FileNotFoundError(Msg.ERR_RUN_JOURNAL_NOT_FOUND)
-
-        # 引数の処理
-        # dask サブプロセスのときは prt_path を worker space から取るようにする
-        try:
-            worker = get_worker()
-            space = worker.local_directory
-            self.prt_path = os.path.join(space, os.path.basename(prt_path))
-        except ValueError:  # get_worker に失敗した場合
-            self.prt_path = os.path.abspath(prt_path)
-
-        self.export_curves = export_curves
-        self.export_surfaces = export_surfaces
-        self.export_solids = export_solids
-        self.export_flattened_assembly = export_flattened_assembly
-
-        # FemtetInterface の設定 (femprj_path, model_name の更新など)
-        # + restore 情報の上書き
-        super().__init__(
-            prt_path=self.prt_path,
-            export_curves=self.export_curves,
-            export_surfaces=self.export_surfaces,
-            export_solids=self.export_solids,
-            export_flattened_assembly=self.export_flattened_assembly,
-            **kwargs
-        )
-
-    def check_param_value(self, name):
-        """Override FemtetInterface.check_param_value().
-
-        Do nothing because the parameter can be registered
-        to not only .femprj but also .prt.
-
-        """
-        pass
-
-    def _setup_before_parallel(self, client):
-        client.upload_file(
-            self.kwargs['prt_path'],
-            False
-        )
-        super()._setup_before_parallel(client)
-
-    def update_model(self, parameters: 'pd.DataFrame', with_warning=False) -> None:
-        """Update .x_t"""
-
-        self.parameters = parameters.copy()
-
-        # Femtet が参照している x_t パスを取得する
-        x_t_path = self.Femtet.Gaudi.LastXTPath
-
-        # 前のが存在するならば消しておく
-        if os.path.isfile(x_t_path):
-            os.remove(x_t_path)
-
-        # 変数の json 文字列を作る
-        tmp_dict = {}
-        for i, row in parameters.iterrows():
-            tmp_dict[row['name']] = row['value']
-        str_json = json.dumps(tmp_dict)
-
-        # create dumped json of export settings
-        tmp_dict = dict(
-            include_curves=self.export_curves,
-            include_surfaces=self.export_surfaces,
-            include_solids=self.export_solids,
-            flatten_assembly=self.export_flattened_assembly,
-        )
-        dumped_json_export_settings = json.dumps(tmp_dict)
-
-        # NX journal を使ってモデルを編集する
-        env = os.environ.copy()
-        subprocess.run(
-            [
-                self.run_journal_path,  # run_journal.exe
-                self._JOURNAL_PATH,  # update_model.py
-                '-args',
-                self.prt_path,
-                str_json,
-                x_t_path,
-                dumped_json_export_settings,
-            ],
-            env=env,
-            shell=True,
-            cwd=os.path.dirname(self.prt_path)
-        )
-
-        # この時点で x_t ファイルがなければ NX がモデル更新に失敗しているはず
-        if not os.path.isfile(x_t_path):
-            raise ModelError
-
-        # モデルの再インポート
-        self._call_femtet_api(
-            self.Femtet.Gaudi.ReExecute,
-            False,
-            ModelError,  # 生きてるのに失敗した場合
-            error_message=Msg.ERR_MODEL_RECONSTRUCTION_FAILED,
-            is_Gaudi_method=True,
-        )
-
-        # 処理を確定
-        self._call_femtet_api(
-            self.Femtet.Redraw,
-            False,  # 戻り値は常に None なのでこの変数に意味はなく None 以外なら何でもいい
-            ModelError,  # 生きてるのに失敗した場合
-            error_message=Msg.ERR_MODEL_UPDATE_FAILED,
-            is_Gaudi_method=True,
-        )
-
-        # femprj モデルの変数も更新
-        super().update_model(parameters, with_warning=False)

pyfemtet/opt/interface/_femtet_with_sldworks.py

@@ -1,298 +0,0 @@
-import os
-import re
-from time import sleep, time
-
-import pandas as pd
-from dask.distributed import get_worker, Lock
-
-from win32com.client import DispatchEx
-# noinspection PyUnresolvedReferences
-from pythoncom import CoInitialize, CoUninitialize, com_error
-
-from pyfemtet.core import ModelError
-from pyfemtet.opt.interface._femtet import FemtetInterface
-from pyfemtet._message import Msg
-
-
-class FemtetWithSolidworksInterface(FemtetInterface):
-    """Control Femtet and Solidworks.
-
-    Using this class, you can import CAD files created
-    in Solidworks through the Parasolid format into a
-    Femtet project. It allows you to pass design
-    variables to Solidworks, update the model, and
-    perform analysis using the updated model in Femtet.
-
-
-    Args:
-        sldprt_path (str):
-            The path to .sldprt file containing the
-            CAD data from which the import is made.
-        **kwargs:
-            For other arguments, please refer to the
-            :class:`FemtetInterface` class.
-
-    """
-
-
-    # 定数の宣言
-    swThisConfiguration = 1  # https://help.solidworks.com/2023/english/api/swconst/SOLIDWORKS.Interop.swconst~SOLIDWORKS.Interop.swconst.swInConfigurationOpts_e.html
-    swAllConfiguration = 2
-    swSpecifyConfiguration = 3  # use with ConfigName argument
-    swSaveAsCurrentVersion = 0
-    swSaveAsOptions_Copy = 2  #
-    swSaveAsOptions_Silent = 1  # https://help.solidworks.com/2021/english/api/swconst/solidworks.interop.swconst~solidworks.interop.swconst.swsaveasoptions_e.html
-    swSaveWithReferencesOptions_None = 0  # https://help-solidworks-com.translate.goog/2023/english/api/swconst/SolidWorks.Interop.swconst~SolidWorks.Interop.swconst.swSaveWithReferencesOptions_e.html?_x_tr_sl=auto&_x_tr_tl=ja&_x_tr_hl=ja&_x_tr_pto=wapp
-    swDocPART = 1  # https://help.solidworks.com/2023/english/api/swconst/SOLIDWORKS.Interop.swconst~SOLIDWORKS.Interop.swconst.swDocumentTypes_e.html
-
-    def __init__(
-            self,
-            sldprt_path,
-            quit_sldworks_on_terminate=False,
-            **kwargs
-    ):
-        # 引数の処理
-        self._orig_sldprt_basename = os.path.basename(sldprt_path)
-
-        # # dask サブプロセスのときは space 直下の sldprt_path を参照する
-        # try:
-        #     worker = get_worker()
-        #     space = worker.local_directory
-        #     name_ext = os.path.basename(sldprt_path)
-        #     name, ext = os.path.splitext(name_ext)
-        #     self.sldprt_path = os.path.join(space, name_ext)
-        #
-        #     # ただし solidworks は 1 プロセスで同名のファイルを開けないので
-        #     # 名前を更新する
-        #     new_sldprt_path = os.path.join(
-        #         space,
-        #         f'{name}'
-        #         f'_{os.path.basename(space)}'  # worker に対し一意
-        #         f'{ext}'  # ext は . を含む
-        #     )
-        #     os.rename(
-        #         self.sldprt_path,
-        #         new_sldprt_path
-        #     )
-        #     self.sldprt_path = new_sldprt_path
-        #
-        # except ValueError:  # get_worker に失敗した場合
-        #     self.sldprt_path = os.path.abspath(sldprt_path)
-        self.sldprt_path = os.path.abspath(sldprt_path)
-        self.quit_sldworks_on_terminate = quit_sldworks_on_terminate
-
-        # FemtetInterface の設定 (femprj_path, model_name の更新など)
-        # + restore 情報の上書き
-        super().__init__(
-            sldprt_path=self.sldprt_path,
-            quit_sldworks_on_terminate=self.quit_sldworks_on_terminate,
-            **kwargs
-        )
-
-    def initialize_sldworks_connection(self):
-        # SolidWorks を捕まえ、ファイルを開く
-
-        self.swApp = DispatchEx('SLDWORKS.Application')
-        self.swApp.Visible = True
-
-        # solidworks は単一プロセスなので開くファイルはひとつだけ
-        try:
-            get_worker()
-        except ValueError:
-            self.swApp.OpenDoc(self.sldprt_path, self.swDocPART)
-
-    def check_param_value(self, param_name):
-        """Override FemtetInterface.check_param_value().
-
-        Do nothing because the parameter can be registered
-        to not only .femprj but also .SLDPRT.
-
-        """
-        pass
-
-    def _setup_before_parallel(self, client):
-        client.upload_file(
-            self.kwargs['sldprt_path'],
-            False
-        )
-        super()._setup_before_parallel(client)
-
-    def _setup_after_parallel(self, *args, **kwargs):
-        CoInitialize()
-        self.initialize_sldworks_connection()
-
-    def update_model(self, parameters: pd.DataFrame, with_warning=False):
-        """Update .x_t"""
-
-        self.parameters = parameters.copy()
-
-        # Femtet が参照している x_t パスを取得する
-        x_t_path = self.Femtet.Gaudi.LastXTPath
-
-        # dask サブプロセスならば競合しないよう保存先を scratch 直下にしておく
-        try:
-            get_worker()
-            x_t_path = os.path.splitext(self.sldprt_path)[0] + '.x_t'
-
-        except ValueError:  # No worker found
-            pass
-
-        # 前のが存在するならば消しておく
-        if os.path.isfile(x_t_path):
-            os.remove(x_t_path)
-
-        # solidworks のモデルの更新
-        try:
-            with Lock('update-model-sldworks'):
-                sleep(0.5)  # 並列処理でクラッシュすることが多かったため試験的に導入
-                self.update_sw_model(parameters, x_t_path)
-
-        # femopt を使わない場合
-        except RuntimeError:  # <class 'distributed.lock.Lock'> object not properly initialized. ...
-            self.update_sw_model(parameters, x_t_path)
-
-        # dask サブプロセスならば LastXTPath を更新する
-        try:
-            get_worker()
-            try:
-                self.Femtet.Gaudi.LastXTPath = x_t_path
-            except (KeyError, AttributeError, com_error):
-                raise RuntimeError('This feature is available from Femtet version 2023.2. Please update Femtet.')
-
-        # dask を使わない場合
-        except ValueError:  # No worker found
-            pass
-
-        # モデルの再インポート
-        self._call_femtet_api(
-            self.Femtet.Gaudi.ReExecute,
-            False,
-            ModelError,  # 生きてるのに失敗した場合
-            error_message=Msg.ERR_RE_EXECUTE_MODEL_FAILED,
-            is_Gaudi_method=True,
-        )
-
-        # 処理を確定
-        self._call_femtet_api(
-            self.Femtet.Redraw,
-            False,  # 戻り値は常に None なのでこの変数に意味はなく None 以外なら何でもいい
-            ModelError,  # 生きてるのに失敗した場合
-            error_message=Msg.ERR_MODEL_REDRAW_FAILED,
-            is_Gaudi_method=True,
-        )
-
-        # femprj モデルの変数も更新
-        super().update_model(parameters)
-
-    def update_sw_model(self, parameters: pd.DataFrame, x_t_path):
-        """Update .sldprt"""
-
-        # df を dict に変換
-        user_param_dict = {}
-        for i, row in parameters.iterrows():
-            user_param_dict[row['name']] = row['value']
-
-        while True:
-
-            try:
-
-                # ===== model を取得 =====
-                swModel = get_model_by_basename(self.swApp, os.path.basename(self.sldprt_path))
-
-                # ===== equation manager を取得 =====
-                swEqnMgr = swModel.GetEquationMgr
-                nEquation = swEqnMgr.GetCount
-
-                # プロパティを退避
-                buffer_aso = swEqnMgr.AutomaticSolveOrder
-                buffer_ar = swEqnMgr.AutomaticRebuild
-                swEqnMgr.AutomaticSolveOrder = False
-                swEqnMgr.AutomaticRebuild = False
-
-                for i in range(nEquation):
-                    # name, equation の取得
-                    current_equation = swEqnMgr.Equation(i)
-                    current_name = self._get_name_from_equation(current_equation)
-                    # 対象なら処理
-                    if current_name in list(user_param_dict.keys()):
-                        new_equation = f'"{current_name}" = {user_param_dict[current_name]}'
-                        swEqnMgr.Equation(i, new_equation)
-
-                # 式の計算
-                # noinspection PyStatementEffect
-                swEqnMgr.EvaluateAll  # always returns -1
-
-                # プロパティをもとに戻す
-                swEqnMgr.AutomaticSolveOrder = buffer_aso
-                swEqnMgr.AutomaticRebuild = buffer_ar
-
-                # 更新する（ここで失敗はしうる）
-                result = swModel.EditRebuild3  # モデル再構築
-                if not result:
-                    raise ModelError(Msg.ERR_UPDATE_SOLIDWORKS_MODEL_FAILED)
-
-                # export as x_t
-                swModel.SaveAs(x_t_path)
-
-                # 30 秒待っても x_t ができてなければエラー(COM なのでありうる)
-                timeout = 30
-                start = time()
-                while True:
-                    if os.path.isfile(x_t_path):
-                        break
-                    if time() - start > timeout:
-                        raise ModelError(Msg.ERR_MODEL_UPDATE_FAILED)
-                    sleep(1)
-
-            except AttributeError as e:
-                if 'SLDWORKS.Application.' in str(e):
-                    # re-launch solidworks
-                    self.swApp = DispatchEx('SLDWORKS.Application')
-                    self.swApp.Visible = True
-                    self.swApp.OpenDoc(self.sldprt_path, self.swDocPART)
-                    continue
-
-                else:
-                    raise e
-
-            break
-
-    def _get_name_from_equation(self, equation: str):
-        pattern = r'^\s*"(.+?)"\s*$'
-        matched = re.match(pattern, equation.split('=')[0])
-        if matched:
-            return matched.group(1)
-        else:
-            return None
-
-    def quit(self, timeout=1, force=True):
-        if self.quit_sldworks_on_terminate:
-            try:
-                get_worker()
-            except ValueError:
-                try:
-                    self.swApp.ExitApp()
-                except AttributeError:
-                    pass
-
-        super().quit(timeout, force)
-
-
-def get_model_by_basename(swApp, basename):
-    swModel = swApp.GetFirstDocument
-    while swModel is not None:
-        pathname = swModel.GetPathName
-        if os.path.basename(pathname) == basename:
-            from win32com.client import Dispatch
-            # swModel_ = swApp.ActivateDoc3(
-            #     basename,
-            #     False,
-            #     1,  # swRebuildOnActivation_e.swDontRebuildActiveDoc,
-            #     Dispatch("Scripting.List"),
-            # )
-            swApp.OpenDoc(pathname, 1)
-            swModel_ = swApp.ActiveDoc
-            return swModel_
-        else:
-            swModel = swModel.GetNext
-    raise ModuleNotFoundError(f'No model named {basename}')

pyfemtet/opt/interface/_surrogate/__init__.py

@@ -1,5 +0,0 @@
-from pyfemtet.opt.interface._surrogate._singletaskgp import PoFBoTorchInterface
-
-__all__ = [
-    PoFBoTorchInterface,
-]