pyfemtet 0.8.4__py3-none-any.whl → 0.8.7__py3-none-any.whl

pyfemtet/_message/locales/messages.pot

@@ -1,14 +1,14 @@
 # Translations template for PROJECT.
-# Copyright (C) 2024 ORGANIZATION
+# Copyright (C) 2025 ORGANIZATION
 # This file is distributed under the same license as the PROJECT project.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
 #
 #, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: PROJECT VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2024-12-27 09:45+0900\n"
+"POT-Creation-Date: 2025-01-29 15:47+0900\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -189,351 +189,355 @@ msgstr ""
 msgid "Restore Femtet setting of autosave."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:90
+#: pyfemtet/_message/messages.py:88
+msgid "Failed to make output from Femtet. Please check output settings of Parametric Analysis."
+msgstr ""
+
+#: pyfemtet/_message/messages.py:92
 msgid "The following features are not supported by the specified optimization method. "
 msgstr ""
 
-#: pyfemtet/_message/messages.py:91
+#: pyfemtet/_message/messages.py:93
 msgid "The parameter set does not match the one added with add_init_parameter."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:92
+#: pyfemtet/_message/messages.py:94
 msgid "An exception has occurred during FEM update. Current parameters are: "
 msgstr ""
 
-#: pyfemtet/_message/messages.py:93
+#: pyfemtet/_message/messages.py:95
 msgid "The constraints were not satisfied for the following sets of variables:"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:94
+#: pyfemtet/_message/messages.py:96
 msgid "Current parameter set cannot update FEM and this optimization method cannot skip current parameter set. The optimization process will be terminated."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:95
+#: pyfemtet/_message/messages.py:97
 msgid "Optimization has been interrupted. Note that you cannot acquire the OptimizationResult in case of `trust-constr`, `TNC`, `SLSQP` or `COBYLA`."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:96
+#: pyfemtet/_message/messages.py:98
 msgid "You can use parameter constraint only with BoTorchSampler."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:97
+#: pyfemtet/_message/messages.py:99
 msgid "Scipy is deterministic, so whether you set a seed or not will not change the results."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:98
+#: pyfemtet/_message/messages.py:100
 msgid "Start to candidate new parameter set with constraints. This process may take a long time."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:99
+#: pyfemtet/_message/messages.py:101
 msgid "Updating FEM parameter during evaluating constraints take a long time. Please consider not to use FEM variables in constraint functions and set `update_fem` to False."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:103
+#: pyfemtet/_message/messages.py:105
 msgid "Connect to Femtet"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:104
+#: pyfemtet/_message/messages.py:106
 msgid "Analysis model name described in csv does not exist in project."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:105
+#: pyfemtet/_message/messages.py:107
 msgid "History csv is not read yet. Open your project manually."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:106
+#: pyfemtet/_message/messages.py:108
 msgid "Cannot read project data from csv. Open your project manually."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:107
+#: pyfemtet/_message/messages.py:109
 msgid ".femprj file described in csv is not found. Open your project manually."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:108
+#: pyfemtet/_message/messages.py:110
 msgid "Analysis model name is not specified. Open your model in the project manually."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:110
+#: pyfemtet/_message/messages.py:112
 msgid "Constraint"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:111
+#: pyfemtet/_message/messages.py:113
 msgid "feasible"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:112
+#: pyfemtet/_message/messages.py:114
 msgid "infeasible"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:113
+#: pyfemtet/_message/messages.py:115
 msgid "Optimality"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:114
+#: pyfemtet/_message/messages.py:116
 msgid "non dominated"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:115
+#: pyfemtet/_message/messages.py:117
 msgid "dominated"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:116
+#: pyfemtet/_message/messages.py:118
 msgid "Hypervolume Plot"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:117
+#: pyfemtet/_message/messages.py:119
 msgid "Objective Plot"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:118
+#: pyfemtet/_message/messages.py:120
 msgid "Multi Objective Pair Plot"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:119
+#: pyfemtet/_message/messages.py:121
 msgid "Succeeded trial number"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:120
+#: pyfemtet/_message/messages.py:122
 msgid "All solutions"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:121
+#: pyfemtet/_message/messages.py:123
 msgid "Transition of<br>optimal solutions"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:122
+#: pyfemtet/_message/messages.py:124
 msgid "Target value"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:124
+#: pyfemtet/_message/messages.py:126
 msgid "Objectives"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:125
+#: pyfemtet/_message/messages.py:127
 msgid "Objectives (all)"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:127
+#: pyfemtet/_message/messages.py:129
 msgid "Prediction Model"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:128
+#: pyfemtet/_message/messages.py:130
 msgid " Recalculate Model"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:129
+#: pyfemtet/_message/messages.py:131
 msgid " Redraw graph"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:130
+#: pyfemtet/_message/messages.py:132
 msgid "Parameter"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:131
+#: pyfemtet/_message/messages.py:133
 msgid "Parameter2"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:132
+#: pyfemtet/_message/messages.py:134
 msgid "Objective"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:133
+#: pyfemtet/_message/messages.py:135
 msgid "No history selected."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:134
+#: pyfemtet/_message/messages.py:136
 msgid "No FEM result (yet)."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:135
+#: pyfemtet/_message/messages.py:137
 msgid "Prediction model is not calculated yet."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:136
+#: pyfemtet/_message/messages.py:138
 msgid "Cannot select same parameter"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:137
+#: pyfemtet/_message/messages.py:139
 msgid "3D graph (two or more parameters required)"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:139
+#: pyfemtet/_message/messages.py:141
 msgid "Prediction Model of Objective"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:140
+#: pyfemtet/_message/messages.py:142
 msgid "prediction model"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:141
+#: pyfemtet/_message/messages.py:143
 msgid "std. dev. of model"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:143
+#: pyfemtet/_message/messages.py:145
 msgid "Progress"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:144
+#: pyfemtet/_message/messages.py:146
 msgid "Prediction"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:145
+#: pyfemtet/_message/messages.py:147
 msgid "Workers"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:146
+#: pyfemtet/_message/messages.py:148
 msgid "Details"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:148
+#: pyfemtet/_message/messages.py:150
 msgid "Optimization status will be shown here."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:149
+#: pyfemtet/_message/messages.py:151
 msgid "Auto-update graph"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:150
+#: pyfemtet/_message/messages.py:152
 msgid "Interrupt Optimization"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:152
+#: pyfemtet/_message/messages.py:154
 msgid "Result"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:154
+#: pyfemtet/_message/messages.py:156
 msgid "Open Result in Femtet"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:155
+#: pyfemtet/_message/messages.py:157
 msgid "Reconstruct Model"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:156
+#: pyfemtet/_message/messages.py:158
 msgid "Drag and drop or select csv file"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:157
+#: pyfemtet/_message/messages.py:159
 msgid "Connection to Femtet is not established. Launch Femtet and Open a project."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:158
+#: pyfemtet/_message/messages.py:160
 msgid "No result plot is selected."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:159
+#: pyfemtet/_message/messages.py:161
 msgid "The femprj file path in the history csv is not found or valid."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:160
+#: pyfemtet/_message/messages.py:162
 msgid "The model name in the history csv is not found."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:161
+#: pyfemtet/_message/messages.py:163
 msgid ".pdt file is not found. Please check the .Results folder. Note that .pdt file save mode depends on the `save_pdt` argument of FemtetInterface in optimization script(default to `all`)."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:166
+#: pyfemtet/_message/messages.py:168
 msgid "Failed to open "
 msgstr ""
 
-#: pyfemtet/_message/messages.py:167
+#: pyfemtet/_message/messages.py:169
 msgid "Specified model is not in current project. Please check opened project. For example, not \"analysis model only\" but your .femprj file."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:170
+#: pyfemtet/_message/messages.py:172
 msgid ".femprj file path of the history csv is invalid. Please certify matching between csv and opening .femprj file."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:171
+#: pyfemtet/_message/messages.py:173
 msgid "Analysis model name of the history csv is invalid. Please certify matching between csv and opening analysis model."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:172
+#: pyfemtet/_message/messages.py:174
 msgid "Analysis model name of the history csv and opened in Femtet is inconsistent. Please certify matching between csv and opening analysis model."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:173
+#: pyfemtet/_message/messages.py:175
 msgid "tutorial mode"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:174
+#: pyfemtet/_message/messages.py:176
 msgid "Load Sample CSV"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:175
+#: pyfemtet/_message/messages.py:177
 msgid "Load CSV"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:176
+#: pyfemtet/_message/messages.py:178
 msgid "Open your optimization result. Then connecting to femtet will start automatically. Note that in tutorial mode, this button loads the ready-made sample csv and open sample femprj."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:178
+#: pyfemtet/_message/messages.py:180
 msgid "Main Graph"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:179
+#: pyfemtet/_message/messages.py:181
 msgid "Here the optimization history is shown. Each plot represents single FEM result. You can pick a result to open the corresponding result in Femtet. "
 msgstr ""
 
-#: pyfemtet/_message/messages.py:182
+#: pyfemtet/_message/messages.py:184
 msgid "Open Result"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:183
+#: pyfemtet/_message/messages.py:185
 msgid "After pick a point in the main graph, This button shows the corresponding FEM result in Femtet."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:185
+#: pyfemtet/_message/messages.py:187
 msgid "Re-connect to Femtet."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:186
+#: pyfemtet/_message/messages.py:188
 msgid "Sample csv is not found. Please consider to re-install pyfemtet by `py -m pip install pyfemtet -U --force-reinstall`"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:187
+#: pyfemtet/_message/messages.py:189
 msgid "Sample femprj file is not found. Please consider to re-install pyfemtet by `py -m pip install pyfemtet -U --force-reinstall`"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:188
+#: pyfemtet/_message/messages.py:190
 msgid "Sample femprj result folder is not found. Please consider to re-install pyfemtet by `py -m pip install pyfemtet -U --force-reinstall`"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:190
+#: pyfemtet/_message/messages.py:192
 msgid "Loading data..."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:191
+#: pyfemtet/_message/messages.py:193
 msgid "Plots of objectives versus trials"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:192
+#: pyfemtet/_message/messages.py:194
 msgid "The vertical axis is the objective, and the horizontal axis is the number of trials."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:193
+#: pyfemtet/_message/messages.py:195
 msgid "Parallel coordinate plots"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:194
+#: pyfemtet/_message/messages.py:196
 msgid "The vertical axis is an objective or parameters, and one polyline indicates one result."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:195
+#: pyfemtet/_message/messages.py:197
 msgid "The heatmap of objectives"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:196
+#: pyfemtet/_message/messages.py:198
 msgid "The axes are parameters, and the color shows objective value."
 msgstr ""
 
-#: pyfemtet/_message/messages.py:197
+#: pyfemtet/_message/messages.py:199
 msgid "The response of an objective versus one parameter"
 msgstr ""
 
-#: pyfemtet/_message/messages.py:198
+#: pyfemtet/_message/messages.py:200
 msgid "The vertical axis is objective, and the horizontal axis is parameter."
 msgstr ""
 

pyfemtet/_message/messages.py

@@ -85,6 +85,8 @@ class Message:
     INFO_TERMINATING_EXCEL = _('Terminating Excel process...')
     INFO_TERMINATED_EXCEL = _('Excel process is terminated.')
     INFO_RESTORING_FEMTET_AUTOSAVE = _('Restore Femtet setting of autosave.')
+    ERR_PARAMETRIC_CSV_CONTAINS_ERROR = _('Failed to make output from Femtet. '
+                                          'Please check output settings of Parametric Analysis.')
 
     # ===== pyfemtet.opt.optimizer =====
     ERR_NOT_IMPLEMENTED = _('The following features are not supported by the specified optimization method. ')

pyfemtet/opt/_femopt.py

@@ -27,6 +27,7 @@ from pyfemtet.opt._femopt_core import (
     History,
     OptimizationStatus,
     logger,
+    MonitorHostRecord,
 )
 from pyfemtet._message import Msg, encoding
 from pyfemtet.opt.optimizer.parameter import Parameter, Expression
@@ -135,6 +136,7 @@ class FEMOpt:
         self.monitor_process_future = None
         self.monitor_server_kwargs = dict()
         self.monitor_process_worker_name = None
+        self.monitor_host_record = None
         self._hv_reference = None
         self._extra_space_dir = None
 
@@ -403,7 +405,7 @@ class FEMOpt:
 
         if names is not None:
             if isinstance(names, str):
-                names = [f'name_{i}' for i in range(n_return)]
+                names = [f'{names}_{i}' for i in range(n_return)]
             else:
                 # names = names
                 pass
@@ -679,11 +681,11 @@ class FEMOpt:
         # ===== fem の設定 ==--=
 
         # Femtet 特有の処理
-        metadata = None
+        extra_data = dict()
         if isinstance(self.fem, FemtetInterface):
 
             # 結果 csv に記載する femprj に関する情報の作成
-            metadata = json.dumps(
+            extra_data.update(
                 dict(
                     femprj_path=self.fem.original_femprj_path,
                     model_name=self.fem.model_name
@@ -774,23 +776,25 @@ class FEMOpt:
 
         with self.client.cluster as _cluster, self.client as _client:
 
-            # actor の設定
+            # ===== status actor の設定 =====
             self.status = OptimizationStatus(_client, worker_address=self.monitor_process_worker_name)
             self.worker_status_list = [OptimizationStatus(_client, worker_address=self.monitor_process_worker_name, name=name) for name in worker_addresses]  # tqdm 検討
             self.status.set(OptimizationStatus.SETTING_UP)
+            self.monitor_host_record = MonitorHostRecord(_client, self.monitor_process_worker_name)
+            logger.info('Status Actor initialized successfully.')
+
+            # ===== initialize history =====
             self.history = History(
                 self.history_path,
                 self.opt.variables.get_parameter_names(),
                 list(self.opt.objectives.keys()),
                 list(self.opt.constraints.keys()),
                 _client,
-                metadata,
                 self._hv_reference
             )
-            logger.info('Status Actor initialized successfully.')
 
+            # ===== launch monitor =====
             # launch monitor
-            # noinspection PyTypeChecker
             self.monitor_process_future = _client.submit(
                 # func
                 _start_monitor_server,
@@ -799,6 +803,7 @@ class FEMOpt:
                 self.status,
                 worker_addresses,
                 self.worker_status_list,
+                self.monitor_host_record,
                 # kwargs
                 **self.monitor_server_kwargs,
                 # kwargs of submit
@@ -807,6 +812,16 @@ class FEMOpt:
             )
             logger.info('Process monitor initialized successfully.')
 
+            # update extra_data of history to notify
+            # how to emit interruption signal by
+            # external processes
+            start = time()
+            while len(self.monitor_host_record.get()) == 0:
+                sleep(0.1)
+            extra_data.update(self.monitor_host_record.get())
+            self.history.extra_data.update(extra_data)
+
+            # ===== setup fem and opt before parallelization =====
             # fem
             self.fem._setup_before_parallel(_client)
 
@@ -817,6 +832,11 @@ class FEMOpt:
             self.opt.history = self.history
             self.opt._setup_before_parallel()
 
+            # ===== 最適化ループ開始 =====
+            # opt から non-serializable な com を
+            # 有している可能性のある fem を削除
+            # ただし main process の sub thread では
+            # これをそのまま使うので buff に退避
             buff = self.opt.fem
             del self.opt.fem
 
@@ -832,8 +852,12 @@ class FEMOpt:
                 allow_other_workers=False,
             )
 
+            # 退避した fem を戻す
             self.opt.fem = buff
 
+            # リモートクラスタではない場合
+            # main process の sub thread で
+            # 計算開始
             t_main = None
             if not self.opt.is_cluster:
                 # ローカルプロセスでの計算(opt._run 相当の処理)
@@ -857,7 +881,7 @@ class FEMOpt:
                 )
                 t_main.start()
 
-            # save history
+            # ===== save history during optimization =====
             def save_history():
                 while True:
                     sleep(2)
@@ -872,7 +896,6 @@ class FEMOpt:
             t_save_history.start()
 
             # ===== 終了 =====
-
             # クラスターの Unexpected Exception のリストを取得
             opt_exceptions: list[Exception or None] = _client.gather(calc_futures)  # gather() で終了待ちも兼ねる
 
@@ -884,7 +907,7 @@ class FEMOpt:
                     local_opt_exception = self.opt._exception  # Exception を取得
             opt_exceptions.append(local_opt_exception)
 
-            # 終了
+            # 終了シグナルを送る
             self.status.set(OptimizationStatus.TERMINATED)
             end = time()
 
@@ -910,6 +933,8 @@ class FEMOpt:
                     print()
 
             # monitor worker を残してユーザーが結果を確認できるようにする
+            # with 文を抜けると monitor worker が終了して
+            # daemon thread である run_forever が終了する
             if confirm_before_exit:
                 print()
                 print('='*len(Msg.CONFIRM_BEFORE_EXIT))
@@ -945,6 +970,7 @@ def _start_monitor_server(
         status,
         worker_addresses,
         worker_status_list,
+        host_record,
         host=None,
         port=None,
 ):
@@ -955,5 +981,6 @@ def _start_monitor_server(
         worker_status_list,
         host,
         port,
+        host_record,
     )
     return 'Exit monitor server process gracefully'