PyFemtet 0.2.3__tar.gz → 0.3.0__tar.gz

{pyfemtet-0.2.3 → pyfemtet-0.3.0}/PKG-INFO

@@ -1,20 +1,22 @@
 Metadata-Version: 2.1
 Name: pyfemtet
-Version: 0.2.3
+Version: 0.3.0
 Summary: Design parameter optimization using Femtet.
 Home-page: https://github.com/pyfemtet/pyfemtet
 License: BSD-3-Clause
 Author: kazuma.naito
 Author-email: kazuma.naito@murata.com
-Requires-Python: >=3.9,<3.12
+Requires-Python: >=3.9,<3.13
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: botorch (>=0.9.5,<0.10.0)
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: dash (>=2.14.2,<3.0.0)
 Requires-Dist: dash-bootstrap-components (>=1.5.0,<2.0.0)
+Requires-Dist: dask (>=2023.12.1,<2024.0.0)
+Requires-Dist: distributed (>=2023.12.1,<2024.0.0)
 Requires-Dist: femtetutils (>=1.0.0,<2.0.0)
 Requires-Dist: numpy (>=1.26.2,<2.0.0)
 Requires-Dist: openpyxl (>=3.1.2,<4.0.0)
@@ -23,7 +25,6 @@ Requires-Dist: pandas (>=2.1.3,<3.0.0)
 Requires-Dist: plotly (>=5.18.0,<6.0.0)
 Requires-Dist: psutil (>=5.9.6,<6.0.0)
 Requires-Dist: pywin32 (>=306,<307)
-Requires-Dist: ray (>=2.8.1,<3.0.0)
 Requires-Dist: scipy (>=1.11.4,<2.0.0)
 Requires-Dist: tqdm (>=4.66.1,<5.0.0)
 Project-URL: Repository, https://github.com/pyfemtet/pyfemtet

{pyfemtet-0.2.3 → pyfemtet-0.3.0}/pyfemtet/FemtetPJTSample/NX_ex01/NX_ex01.py

@@ -10,7 +10,8 @@ Femtet にインポートして最適化を行います。
 """
 
 import os
-from pyfemtet.opt import FemtetWithNXInterface, OptimizerOptuna
+from pyfemtet.opt import FEMOpt, OptunaOptimizer
+from pyfemtet.opt.interface import FemtetWithNXInterface
 
 
 here, me = os.path.split(__file__)
@@ -33,7 +34,7 @@ def volume(Femtet):
     return ret
 
 
-def C_minus_B(_, femopt):
+def C_minus_B(_, opt):
     """C 寸法と B 寸法の差を計算します。
 
     拘束関数の第一引数は Femtet インスタンスである必要がありますが、
@@ -44,11 +45,11 @@ def C_minus_B(_, femopt):
         A = Femtet.GetVariableValue('A')
 
     pyfemtet.opt では目的関数・拘束関数の第二引数以降に任意の変数を設定できます。
-    この例では、第二引数に OptimizerOptuna クラスのオブジェクトを取り、
+    この例では、第二引数に FEMOpt のメンバー変数 opt を取り、
     そのメソッド get_parameter() を用いて設計変数を取得しています。
 
     """
-    A, B, C = femopt.get_parameter('values')
+    A, B, C = opt.get_parameter('values')
     return C - B
 
 
@@ -61,8 +62,14 @@ if __name__ == '__main__':
         femprj_path='NX_ex01.femprj',
     )
 
+    opt = OptunaOptimizer(
+        sampler_kwargs=dict(
+            n_startup_trials=5,
+        )
+    )
+
     # 最適化処理を行うオブジェクトに連携オブジェクトを紐づけ
-    femopt = OptimizerOptuna(fem)
+    femopt = FEMOpt(fem=fem, opt=opt)
 
     # 設計変数の設定
     femopt.add_parameter('A', 10, lower_bound=1, upper_bound=59)
@@ -70,7 +77,7 @@ if __name__ == '__main__':
     femopt.add_parameter('C', 20, lower_bound=5, upper_bound=59)
 
     # 拘束関数の設定
-    femopt.add_constraint(C_minus_B, 'C>B', lower_bound=1, args=femopt)
+    femopt.add_constraint(C_minus_B, 'C>B', lower_bound=1, args=femopt.opt)
 
     # 目的関数の設定
     femopt.add_objective(disp, name='変位', direction=0)
@@ -78,4 +85,4 @@ if __name__ == '__main__':
 
     # 最適化の実行
     femopt.set_random_seed(42)
-    femopt.main(n_trials=20, use_lhs_init=False)
+    femopt.main(n_trials=20, n_parallel=3)

{pyfemtet-0.2.3 → pyfemtet-0.3.0}/pyfemtet/FemtetPJTSample/gau_ex08_parametric.py

@@ -4,8 +4,8 @@ gau_ex08_parametric.femprj に対し磁場解析を行い、
 自己インダクタンスを特定の値にする
 有限長さソレノイドコイルの寸法を探索します。
 """
-
-from pyfemtet.opt import OptimizerOptuna
+from optuna.integration.botorch import BoTorchSampler
+from pyfemtet.opt import FEMOpt, OptunaOptimizer
 
 
 def inductance(Femtet):
@@ -28,8 +28,19 @@ def inductance(Femtet):
 
 if __name__ == '__main__':
 
+    # 最適化手法を定義するオブジェクトを用意
+    # BoTorch ライブラリを使わない場合、このブロックをコメントアウトし、
+    # opt = None としてください。
+    opt = OptunaOptimizer(
+        sampler_class=BoTorchSampler,
+        sampler_kwargs=dict(
+            consider_running_trials=True,
+            n_startup_trials=5,
+        )
+    )
+
     # 最適化処理を行うオブジェクトを用意
-    femopt = OptimizerOptuna()  # ここで起動している Femtet が紐づけされます
+    femopt = FEMOpt(opt=opt)  # ここで起動している Femtet が紐づけされます
 
     # 設計変数の登録
     femopt.add_parameter("h", 3, lower_bound=1.5, upper_bound=6, memo='1巻きピッチ')
@@ -43,4 +54,4 @@ if __name__ == '__main__':
 
     # 最適化の実行
     femopt.set_random_seed(42)
-    femopt.main(n_trials=20, method='botorch', use_lhs_init=False)
+    femopt.main(n_trials=20)

{pyfemtet-0.2.3 → pyfemtet-0.3.0}/pyfemtet/FemtetPJTSample/her_ex40_parametric.py

@@ -3,8 +3,9 @@ from time import sleep
 import numpy as np
 from scipy.signal import find_peaks
 from tqdm import tqdm
+from optuna.integration.botorch import BoTorchSampler
 
-from pyfemtet.opt import OptimizerOptuna
+from pyfemtet.opt import OptunaOptimizer, FEMOpt
 
 
 
@@ -49,8 +50,8 @@ class SParameterCalculator:
         """S に対して最初のピークを与える freq を計算します。"""
         x = -np.array(self.S)
         peaks, _ = find_peaks(x, height=None, threshold=None, distance=None, prominence=0.5, width=None, wlen=None, rel_height=0.5, plateau_size=None)
-        from pyfemtet.opt.core import SolveError
-        if len(peaks)==0:
+        from pyfemtet.core import SolveError
+        if len(peaks) == 0:
             raise SolveError('ピークが検出されませんでした。')
         self.resonance_frequency = self.freq[peaks[0]]
         self.minimum_S = self.S[peaks[0]]
@@ -71,7 +72,7 @@ class SParameterCalculator:
         return f  # GHz
         
 
-def anntena_is_smaller_than_substrate(Femtet):
+def antenna_is_smaller_than_substrate(Femtet):
     """アンテナのサイズと基板のサイズの関係を計算します。
 
     Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
@@ -86,7 +87,7 @@ def anntena_is_smaller_than_substrate(Femtet):
     return Sx/2 - ant_r
 
 
-def port_is_inside_anntena(Femtet):
+def port_is_inside_antenna(Femtet):
     """給電ポートの位置とアンテナのサイズの関係を計算します。
 
     Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
@@ -101,12 +102,25 @@ def port_is_inside_anntena(Femtet):
     return ant_r - xf
 
 
-if __name__=='__main__':
+if __name__ == '__main__':
     # S パラメータ計算用クラス
     s = SParameterCalculator()
+
+    # 最適化手法を定義するオブジェクトを用意
+    # BoTorch ライブラリを使わない場合、このブロックをコメントアウトし、
+    # opt = None としてください。
+    opt = OptunaOptimizer(
+        sampler_class=BoTorchSampler,
+        sampler_kwargs=dict(
+            consider_running_trials=True,
+            n_startup_trials=5,
+        )
+    )
     
     # 最適化処理を行うオブジェクトを用意
-    femopt = OptimizerOptuna()  # ここで起動している Femtet が紐づけされます
+    femopt = FEMOpt(
+        opt=opt,
+    )  # ここで起動している Femtet が紐づけされます
     
     # 設計変数の設定
     femopt.add_parameter('ant_r', 10, 5, 20, memo='円形アンテナの半径')
@@ -114,11 +128,11 @@ if __name__=='__main__':
     femopt.add_parameter('xf', 5, 1, 20, memo='給電ポートの偏心量')
 
     # 拘束の設定
-    femopt.add_constraint(anntena_is_smaller_than_substrate, 'アンテナサイズ', lower_bound=1)
-    femopt.add_constraint(port_is_inside_anntena, 'ポート位置', lower_bound=1)
+    femopt.add_constraint(antenna_is_smaller_than_substrate, 'アンテナサイズ', lower_bound=1)
+    femopt.add_constraint(port_is_inside_antenna, 'ポート位置', lower_bound=1)
 
     # 目的の設定
     femopt.add_objective(s.get_resonance_frequency, '第一共振周波数（GHz）', direction=3.0)
 
     femopt.set_random_seed(42)
-    femopt.main(method='botorch', n_trials=20)
+    femopt.main(n_trials=20)

{pyfemtet-0.2.3 → pyfemtet-0.3.0}/pyfemtet/FemtetPJTSample/wat_ex14_parallel_parametric.py

@@ -6,10 +6,10 @@ wat_ex14_parametric.femprj に対し熱伝導解析を行い、
 基板寸法・チップ配置寸法を探索します。
 """
 
-from pyfemtet.opt import OptimizerOptuna
+from pyfemtet.opt import FEMOpt
 
 
-def maxtemp(Femtet, body_name):
+def max_temperature(Femtet, body_name):
     """Femtet の解析結果からチップの最高温度を取得します。
 
     Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
@@ -21,9 +21,9 @@ def maxtemp(Femtet, body_name):
     """
     Gogh = Femtet.Gogh
 
-    maxtemp, _, _ = Gogh.Watt.GetTemp_py(body_name)
+    temp, _, _ = Gogh.Watt.GetTemp_py(body_name)
 
-    return maxtemp  # degree
+    return temp  # degree
 
 
 def substrate_size(Femtet):
@@ -45,15 +45,15 @@ def substrate_size(Femtet):
 if __name__ == '__main__':
 
     # 最適化処理を行うオブジェクトを用意
-    femopt = OptimizerOptuna()
+    femopt = FEMOpt()
 
     # 設計変数の設定
     femopt.add_parameter("substrate_w", 40, lower_bound=22, upper_bound=40, memo='基板サイズ X')
     femopt.add_parameter("substrate_d", 60, lower_bound=33, upper_bound=60, memo='基板サイズ Y')
 
     # 目的関数の設定
-    femopt.add_objective(maxtemp, name='メインチップ温度', args=('MAINCHIP',))
-    femopt.add_objective(maxtemp, name='サブチップ温度', args=('SUBCHIP',))
+    femopt.add_objective(max_temperature, name='メインチップ温度', args=('MAINCHIP',))
+    femopt.add_objective(max_temperature, name='サブチップ温度', args=('SUBCHIP',))
     femopt.add_objective(substrate_size, name='基板サイズ')
 
     # 最適化の実行

{pyfemtet-0.2.3 → pyfemtet-0.3.0}/pyfemtet/FemtetPJTSample/wat_ex14_parametric.py

@@ -6,10 +6,10 @@ wat_ex14_parametric.femprj に対し熱伝導解析を行い、
 基板寸法・チップ配置寸法を探索します。
 """
 
-from pyfemtet.opt import OptimizerOptuna
+from pyfemtet.opt import FEMOpt
 
 
-def maxtemp(Femtet, body_name):
+def max_temperature(Femtet, body_name):
     """Femtet の解析結果からチップの最高温度を取得します。
 
     Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
@@ -21,9 +21,9 @@ def maxtemp(Femtet, body_name):
     """
     Gogh = Femtet.Gogh
 
-    maxtemp, _, _ = Gogh.Watt.GetTemp_py(body_name)
+    temp, _, _ = Gogh.Watt.GetTemp_py(body_name)
 
-    return maxtemp  # degree
+    return temp  # degree
 
 
 def substrate_size(Femtet):
@@ -45,15 +45,15 @@ def substrate_size(Femtet):
 if __name__ == '__main__':
 
     # 最適化処理を行うオブジェクトを用意
-    femopt = OptimizerOptuna()
+    femopt = FEMOpt()
 
     # 設計変数の設定
     femopt.add_parameter("substrate_w", 40, lower_bound=22, upper_bound=40, memo='基板サイズ X')
     femopt.add_parameter("substrate_d", 60, lower_bound=33, upper_bound=60, memo='基板サイズ Y')
 
     # 目的関数の設定
-    femopt.add_objective(maxtemp, name='メインチップ温度', args=('MAINCHIP',))
-    femopt.add_objective(maxtemp, name='サブチップ温度', args=('SUBCHIP',))
+    femopt.add_objective(max_temperature, name='メインチップ温度', args=('MAINCHIP',))
+    femopt.add_objective(max_temperature, name='サブチップ温度', args=('SUBCHIP',))
     femopt.add_objective(substrate_size, name='基板サイズ')
 
     # 最適化の実行

pyfemtet-0.3.0/pyfemtet/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.0"

pyfemtet-0.3.0/pyfemtet/core.py

@@ -0,0 +1,38 @@
+class ModelError(Exception):
+    """Exception raised for errors in the model update.
+    
+    If this exception is thrown during an optimization calculation, the process attempts to skip that attempt if possible.
+
+    """
+    pass
+
+
+class MeshError(Exception):
+    """Exception raised for errors in the meshing.
+    
+    If this exception is thrown during an optimization calculation, the process attempts to skip that attempt if possible.
+
+    """
+    pass
+
+
+class SolveError(Exception):
+    """Exception raised for errors in the solver.
+    
+    If this exception is thrown during an optimization calculation, the process attempts to skip that attempt if possible.
+
+    """
+    pass
+
+
+# class PostError(Exception):
+#     pass
+
+
+# class FEMCrash(Exception):
+#     pass
+
+
+class FemtetAutomationError(Exception):
+    """Exception raised for errors in automating Femtet."""
+    pass