pyfemtet 0.3.12__tar.gz → 0.4.2__tar.gz

{pyfemtet-0.3.12 → pyfemtet-0.4.2}/PKG-INFO

@@ -1,19 +1,18 @@
 Metadata-Version: 2.1
 Name: pyfemtet
-Version: 0.3.12
+Version: 0.4.2
 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.13
+Requires-Python: >=3.9.3,<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
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: botorch (>=0.9.5,<0.10.0)
+Requires-Dist: botorch (>=0.9.5,<0.10.0) ; python_version < "3.12"
 Requires-Dist: colorlog (>=6.8.0,<7.0.0)
 Requires-Dist: dash (>=2.14.2,<3.0.0)
 Requires-Dist: dash-bootstrap-components (>=1.5.0,<2.0.0)
@@ -23,6 +22,7 @@ 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)
 Requires-Dist: optuna (>=3.4.0,<4.0.0)
+Requires-Dist: optuna-integration (>=3.6.0,<4.0.0)
 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)
@@ -35,7 +35,8 @@ Description-Content-Type: text/markdown
 PyFemtet is the extension package for Femtet with Python.
 
 - Femtet Website: https://www.muratasoftware.com/
-- Documentation: https://pyfemtet.github.io/pyfemtet/
+- Documentation (English): https://pyfemtet.readthedocs.io/en/stable/
+- ドキュメント（日本語）: https://pyfemtet.readthedocs.io/jp/stable/
 - Source code: https://github.com/pyfemtet/pyfemtet
 - Bug reports: https://github.com/pyfemtet/pyfemtet/issues
 

{pyfemtet-0.3.12 → pyfemtet-0.4.2}/README.md

@@ -1,7 +1,8 @@
 PyFemtet is the extension package for Femtet with Python.
 
 - Femtet Website: https://www.muratasoftware.com/
-- Documentation: https://pyfemtet.github.io/pyfemtet/
+- Documentation (English): https://pyfemtet.readthedocs.io/en/stable/
+- ドキュメント（日本語）: https://pyfemtet.readthedocs.io/jp/stable/
 - Source code: https://github.com/pyfemtet/pyfemtet
 - Bug reports: https://github.com/pyfemtet/pyfemtet/issues
 

pyfemtet-0.4.2/pyfemtet/FemtetPJTSample/NX_ex01/NX_ex01.py

@@ -0,0 +1,118 @@
+"""External CAD (NX) Integration
+
+This script performs parametric optimization
+using a project that has imported an external CAD model
+that has been parametrically modeled.
+
+Please perform the following steps in preparation.
+    - Install NX.
+    - Place NX_ex01.prt, NX_ex01.femprj and .py file in the same folder.
+    - Create C:\\temp folder on your disk.
+        Note: NX exports .x_t files during optimization.
+"""
+
+import os
+from pyfemtet.opt import FEMOpt, OptunaOptimizer
+from pyfemtet.opt.interface import FemtetWithNXInterface
+from pyfemtet.core import ModelError
+
+
+here, me = os.path.split(__file__)
+os.chdir(here)
+
+
+def disp(Femtet):
+    """Obtain the maximum displacement in the Z direction from the analysis results.
+
+    Note:
+        The objective or constraint function
+        must take a Femtet as its first argument
+        and must return a single float.
+
+    Warning:
+        CAD integration may assign boundary conditions to unintended locations.
+
+        In this example, if the boundary conditions are assigned as intended,
+        the maximum displacement is always negative.
+        If the maximum displacement is positive,
+        it is assumed that boundary condition assignment has failed
+        and a ModelError is raised.
+        
+        If a ModelError, MeshError, or SolveError is raised during an optimization,
+        the Optimizer considers the trial a failure
+        and skips it to the next trial.
+    """
+    _, _, ret = Femtet.Gogh.Galileo.GetMaxDisplacement_py()
+
+    if ret >= 0:
+        raise ModelError('The boundary condition assignment is incorrect.')
+    return ret
+
+
+def volume(Femtet):
+    """Obtain the volume."""
+    _, ret = Femtet.Gogh.CalcVolume_py([0])
+    return ret
+
+
+def C_minus_B(_, opt):
+    """Calculate the difference between C and B dimensions.
+
+    The constraint function must take a Femtet instance as its first argument,
+    but this example does not use it.
+
+    Another example uses the following snippet to access design variables:
+
+        A = Femtet.GetVariableValue('A')
+    
+    However, when performing CAD integration,
+    this method does not work because the variables are not set in the .femprj file.
+
+    In CAD integration, design variables are obtained in the following way.
+    
+    The objective function and constraint function can take any variable after the first argument.
+    The member variable opt of FEMOpt has a method called get_parameter().
+    This method can retrieve design variables added by add_parameter().
+    By taking opt as the second argument, you can execute get_parameter()
+    in the objective function or constraint function to obtain the design variables.
+    
+    """
+    A, B, C = opt.get_parameter('values')
+    return C - B
+
+
+if __name__ == '__main__':
+
+    # Define NX-Femtet integration object.
+    # At this point, Python is connected to the running Femtet.
+    fem = FemtetWithNXInterface(
+        prt_path='NX_ex01.prt',
+        femprj_path='NX_ex01.femprj',
+    )
+
+    # Define mathematical optimization object.
+    opt = OptunaOptimizer(
+        sampler_kwargs=dict(
+            n_startup_trials=5,
+        )
+    )
+
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
+    femopt = FEMOpt(fem=fem, opt=opt)
+
+    # Add design variables (Use variable names set in NX) to the optimization problem.
+    femopt.add_parameter('A', 10, lower_bound=1, upper_bound=59)
+    femopt.add_parameter('B', 10, lower_bound=1, upper_bound=40)
+    femopt.add_parameter('C', 20, lower_bound=5, upper_bound=59)
+
+    # Add constraint to the optimization problem.
+    femopt.add_constraint(C_minus_B, 'C>B', lower_bound=1, args=femopt.opt)
+
+    # Add objective to the optimization problem.
+    femopt.add_objective(disp, name='displacement', direction=0)
+    femopt.add_objective(volume, name='volume', direction='minimize')
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet-0.4.2/pyfemtet/FemtetPJTSample/Sldworks_ex01/Sldworks_ex01.py

@@ -0,0 +1,121 @@
+"""External CAD (Solidworks) Integration
+
+This script performs parametric optimization
+using a project that has imported an external CAD model
+that has been parametrically modeled.
+
+Please perform the following steps in preparation.
+    - Install Solidworks.
+    - Place Sldworks_ex01.SLDPRT, Sldworks_ex01.femprj and this .py file in the same folder.
+    - Create C:\\temp folder on your disk.
+        Note: NX exports .x_t files during optimization.
+"""
+
+import os
+from pyfemtet.opt import FEMOpt, OptunaOptimizer
+from pyfemtet.opt.interface import FemtetWithSolidworksInterface
+from pyfemtet.core import ModelError
+
+
+here, me = os.path.split(__file__)
+os.chdir(here)
+
+
+def disp(Femtet):
+    """Obtain the maximum displacement in the Z direction from the analysis results.
+
+    Note:
+        The objective or constraint function
+        must take a Femtet as its first argument
+        and must return a single float.
+
+    Warning:
+        CAD integration may assign boundary conditions to unintended locations.
+
+        In this example, if the boundary conditions are assigned as intended,
+        the maximum displacement is always negative.
+        If the maximum displacement is positive,
+        it is assumed that boundary condition assignment has failed
+        and a ModelError is raised.
+
+        If a ModelError, MeshError, or SolveError is raised during an optimization,
+        the Optimizer considers the trial a failure
+        and skips it to the next trial.
+    """
+    _, _, ret = Femtet.Gogh.Galileo.GetMaxDisplacement_py()
+
+    if ret >= 0:
+        raise ModelError('The boundary condition assignment is incorrect.')
+    return ret
+
+
+def volume(Femtet):
+    """Obtain the volume."""
+    _, ret = Femtet.Gogh.CalcVolume_py([0])
+    return ret
+
+
+def C_minus_B(_, opt):
+    """Calculate the difference between C and B dimensions.
+
+    The constraint function must take a Femtet instance as its first argument,
+    but this example does not use it.
+
+    Another example uses the following snippet to access design variables:
+
+        A = Femtet.GetVariableValue('A')
+    
+    However, when performing CAD integration,
+    this method does not work because the variables are not set in the .femprj file.
+
+    In CAD integration, design variables are obtained in the following way.
+    
+    The objective function and constraint function can take any variable after the first argument.
+    The member variable opt of FEMOpt has a method called get_parameter().
+    This method can retrieve design variables added by add_parameter().
+    By taking opt as the second argument, you can execute get_parameter()
+    in the objective function or constraint function to obtain the design variables.
+    
+    """
+    A, B, C = opt.get_parameter('values')
+    return C - B
+
+
+if __name__ == '__main__':
+
+    # Define Solidworks-Femtet integration object.
+    # At this point, Python is connected to the running Femtet.
+    fem = FemtetWithSolidworksInterface(
+        sldprt_path='Sldworks_ex01.SLDPRT',
+        femprj_path='Sldworks_ex01.femprj',
+    )
+
+    # Define mathematical optimization object.
+    opt = OptunaOptimizer(
+        sampler_kwargs=dict(
+            n_startup_trials=5,
+        )
+    )
+
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
+    femopt = FEMOpt(fem=fem, opt=opt)
+
+    # Add design variables (Use variable names set in NX) to the optimization problem.
+    femopt.add_parameter('A', 10, lower_bound=1, upper_bound=59)
+    femopt.add_parameter('B', 10, lower_bound=1, upper_bound=40)
+    femopt.add_parameter('C', 20, lower_bound=5, upper_bound=59)
+
+    # Add constraint to the optimization problem.
+    # Note that we use the ``args`` keyword
+    # to pass femopt.opt as an argument
+    # to the constraint function ``C_minus_B``.
+    femopt.add_constraint(C_minus_B, 'C>B', lower_bound=1, args=femopt.opt)
+
+    # Add objective to the optimization problem.
+    femopt.add_objective(disp, name='displacement', direction=0)
+    femopt.add_objective(volume, name='volume', direction='minimize')
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet-0.4.2/pyfemtet/FemtetPJTSample/gau_ex08_parametric.py

@@ -0,0 +1,58 @@
+"""Single-objective optimization: self-inductance of a finite length solenoid coil
+
+Perform magnetic field analysis on gau_ex08_parametric.femprj
+to find the dimensions of a finite length solenoid coil
+that makes the self-inductance a specific value.
+"""
+from optuna.integration.botorch import BoTorchSampler
+from pyfemtet.opt import FEMOpt, OptunaOptimizer
+
+
+def inductance(Femtet):
+    """Get the self-inductance.
+
+    Note:
+        The objective or constraint function
+        must take a Femtet as its first argument
+        and must return a single float.
+
+    Params:
+        Femtet: An instance for using Femtet macros. For more information, see "Femtet Macro Help / CFemtet Class".
+
+    Returns:
+        float: Self-inductance.
+    """
+    Gogh = Femtet.Gogh
+
+    # Get inductance.
+    cName = Gogh.Gauss.GetCoilList()[0]
+    l = Gogh.Gauss.GetL(cName, cName)
+    return l  # F
+
+
+if __name__ == '__main__':
+
+    # Define mathematical optimization object.
+    opt = OptunaOptimizer(
+        sampler_class=BoTorchSampler,
+        sampler_kwargs=dict(
+            n_startup_trials=5,
+        )
+    )
+
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
+    femopt = FEMOpt(opt=opt)
+
+    # Add design variables (Use variable names set in Femtet) to the optimization problem.
+    femopt.add_parameter("h", 3, lower_bound=1.5, upper_bound=6)
+    femopt.add_parameter("r", 5, lower_bound=1, upper_bound=10)
+    femopt.add_parameter("n", 3, lower_bound=1, upper_bound=5)
+
+    # Add objective to the optimization problem.
+    # The target inductance value is 0.1 uF.
+    femopt.add_objective(inductance, name='self-inductance', direction=0.1e-06)
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet-0.4.2/pyfemtet/FemtetPJTSample/her_ex40_parametric.py

@@ -0,0 +1,148 @@
+"""Single-objective optimization: Resonant frequency of a circular patch antenna
+
+Using Femtet’s electromagnetic wave analysis solver,
+we explain an example of setting the resonant frequency
+of a circular patch antenna to a specific value.
+"""
+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 OptunaOptimizer, FEMOpt
+
+
+class SParameterCalculator:
+    """This class is for calculating S-parameters and resonance frequencies."""
+    
+    def __init__(self):
+        self.freq = []
+        self.S = []
+        self.interpolated_function = None
+        self.resonance_frequency = None
+        self.minimum_S = None
+
+    def get_result_from_Femtet(self, Femtet):
+        """Obtain the relationship between frequency and S-parameter from the Femtet analysis results."""
+
+        # Preparation
+        Femtet.OpenCurrentResult(True)
+        Gogh = Femtet.Gogh
+        
+        # Obtain the frequency and S(1,1) for each mode
+        mode = 0
+        freq_list = []
+        dB_S_list = []
+        for mode in tqdm(range(Gogh.Hertz.nMode), 'Obtaining frequency and S-parameter'):
+            # Femtet result screen mode settings
+            Gogh.Hertz.Mode = mode
+            sleep(0.01)
+            # Get frequency
+            freq = Gogh.Hertz.GetFreq().Real
+            # Get S-parameters
+            comp_S = Gogh.Hertz.GetSMatrix(0, 0)
+            norm = np.linalg.norm((comp_S.Real, comp_S.Imag))
+            dB_S = 20 * np.log10(norm)
+            # Get results
+            freq_list.append(freq)
+            dB_S_list.append(dB_S)
+        self.freq = freq_list
+        self.S = dB_S_list
+
+    def calc_resonance_frequency(self):
+        """Compute the frequency that gives the first peak for S-parameter."""
+        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.core import SolveError
+        if len(peaks) == 0:
+            raise SolveError('No peaks detected.')
+        self.resonance_frequency = self.freq[peaks[0]]
+        self.minimum_S = self.S[peaks[0]]
+
+    def get_resonance_frequency(self, Femtet):
+        """Calculate the resonant frequency.
+
+        Note:
+            The objective or constraint function
+            must take a Femtet as its first argument
+            and must return a single float.
+
+        Params:
+            Femtet: An instance for using Femtet macros. For more information, see "Femtet Macro Help / CFemtet Class".
+        
+        Returns:
+            float: A resonance frequency.
+        """
+        self.get_result_from_Femtet(Femtet)
+        self.calc_resonance_frequency()
+        f = self.resonance_frequency * 1e-9
+        return f  # GHz
+        
+
+def antenna_is_smaller_than_substrate(Femtet):
+    """Calculate the relationship between antenna size and board size.
+
+    This function is used to constrain the model
+    from breaking down while changing parameters.
+
+    Params:
+        Femtet: An instance for using Femtet macros.
+    
+    Returns:
+        float: Difference between the board size and antenna size. Must be equal to or grater than 1 mm.
+    """
+    ant_r = Femtet.GetVariableValue('ant_r')
+    Sx = Femtet.GetVariableValue('sx')
+    return Sx/2 - ant_r
+
+
+def port_is_inside_antenna(Femtet):
+    """Calculate the relationship between the feed port location and antenna size.
+
+    This function is used to constrain the model
+    from breaking down while changing parameters.
+
+    Params:
+        Femtet: An instance for using Femtet macros.
+    
+    Returns:
+        float: Difference between the antenna edge and the position of the feed port. Must be equal to or grater than 1 mm.
+    """
+    ant_r = Femtet.GetVariableValue('ant_r')
+    xf = Femtet.GetVariableValue('xf')
+    return ant_r - xf
+
+
+if __name__ == '__main__':
+    # Define the object for calculating S-parameters and resonance frequencies.
+    s = SParameterCalculator()
+
+    # Define mathematical optimization object.
+    opt = OptunaOptimizer(
+        sampler_class=BoTorchSampler,
+        sampler_kwargs=dict(
+            n_startup_trials=10,
+        )
+    )
+    
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
+    femopt = FEMOpt(opt=opt)
+    
+    # Add design variables (Use variable names set in Femtet) to the optimization problem.
+    femopt.add_parameter('ant_r', 10, 5, 20)
+    femopt.add_parameter('sx', 50, 40, 60)
+    femopt.add_parameter('xf', 5, 1, 20)
+
+    # Add constraint to the optimization problem.
+    femopt.add_constraint(antenna_is_smaller_than_substrate, 'board_antenna_clearance', lower_bound=1)
+    femopt.add_constraint(port_is_inside_antenna, 'antenna_port_clearance', lower_bound=1)
+
+    # Add objective to the optimization problem.
+    # The target frequency is 3 GHz.
+    femopt.add_objective(s.get_resonance_frequency, 'First_resonant_frequency(GHz)', direction=3.0)
+
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet-0.4.2/pyfemtet/FemtetPJTSample/wat_ex14_parallel_parametric.py

@@ -0,0 +1,65 @@
+"""Parallel computing / Multi-objective optimization: heating element on board
+
+Perform thermal conduction analysis on wat_ex14_parametric.femprj
+and search for board dimensions and chip placement dimensions that
+minimize the board dimensions while minimizing the temperature rise
+due to chip heat generation.
+"""
+from pyfemtet.opt import FEMOpt
+
+
+def max_temperature(Femtet, body_name):
+    """Get the maximum temperature of the chip.
+
+    Note:
+        The objective or constraint function
+        must take a Femtet as its first argument
+        and must return a single float.
+
+    Params:
+        Femtet: An instance for using Femtet macros. For more information, see "Femtet Macro Help / CFemtet Class".
+
+    Returns:
+        float: Max-temperature.
+    """
+    Gogh = Femtet.Gogh
+
+    temp, _, _ = Gogh.Watt.GetTemp_py(body_name)
+
+    return temp  # degree
+
+
+def substrate_size(Femtet):
+    """Calculate the substrate size.
+
+    Params:
+        Femtet: An instance for using Femtet macros. For more information, see "Femtet Macro Help / CFemtet Class".
+    
+    Returns:
+        float: The area occupied by the board in the XY plane.
+    """
+    subs_w = Femtet.GetVariableValue('substrate_w')
+    subs_d = Femtet.GetVariableValue('substrate_d')
+
+    return subs_w * subs_d  # mm2
+
+
+if __name__ == '__main__':
+
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
+    femopt = FEMOpt()
+
+    # Add design variables (Use variable names set in Femtet) to the optimization problem.
+    femopt.add_parameter("substrate_w", 40, lower_bound=22, upper_bound=40)
+    femopt.add_parameter("substrate_d", 60, lower_bound=33, upper_bound=60)
+
+    # Add objective to the optimization problem.
+    femopt.add_objective(max_temperature, name='main chip temp.', args=('MAINCHIP',))
+    femopt.add_objective(max_temperature, name='sub chip temp.', args=('SUBCHIP',))
+    femopt.add_objective(substrate_size, name='substrate size')
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    # femopt.optimize(n_trials=20)
+    femopt.optimize(n_trials=20, n_parallel=3)  # Change only this line.
+    femopt.terminate_all()

pyfemtet-0.4.2/pyfemtet/FemtetPJTSample/wat_ex14_parametric.py

@@ -0,0 +1,64 @@
+"""Multi-objective optimization: heating element on board
+
+Perform thermal conduction analysis on wat_ex14_parametric.femprj
+and search for board dimensions and chip placement dimensions that
+minimize the board dimensions while minimizing the temperature rise
+due to chip heat generation.
+"""
+from pyfemtet.opt import FEMOpt
+
+
+def max_temperature(Femtet, body_name):
+    """Get the maximum temperature of the chip.
+
+    Note:
+        The objective or constraint function
+        must take a Femtet as its first argument
+        and must return a single float.
+
+    Params:
+        Femtet: An instance for using Femtet macros. For more information, see "Femtet Macro Help / CFemtet Class".
+
+    Returns:
+        float: Max-temperature.
+    """
+    Gogh = Femtet.Gogh
+
+    temp, _, _ = Gogh.Watt.GetTemp_py(body_name)
+
+    return temp  # degree
+
+
+def substrate_size(Femtet):
+    """Calculate the substrate size.
+
+    Params:
+        Femtet: An instance for using Femtet macros. For more information, see "Femtet Macro Help / CFemtet Class".
+    
+    Returns:
+        float: The area occupied by the board in the XY plane.
+    """
+    subs_w = Femtet.GetVariableValue('substrate_w')
+    subs_d = Femtet.GetVariableValue('substrate_d')
+
+    return subs_w * subs_d  # mm2
+
+
+if __name__ == '__main__':
+
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
+    femopt = FEMOpt()
+
+    # Add design variables (Use variable names set in Femtet) to the optimization problem.
+    femopt.add_parameter("substrate_w", 40, lower_bound=22, upper_bound=40)
+    femopt.add_parameter("substrate_d", 60, lower_bound=33, upper_bound=60)
+
+    # Add objective to the optimization problem.
+    femopt.add_objective(max_temperature, name='main chip temp.', args=('MAINCHIP',))
+    femopt.add_objective(max_temperature, name='sub chip temp.', args=('SUBCHIP',))
+    femopt.add_objective(substrate_size, name='substrate size')
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet-0.4.2/pyfemtet/__init__.py

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

{pyfemtet-0.3.12 → pyfemtet-0.4.2}/pyfemtet/core.py

@@ -36,3 +36,17 @@ class SolveError(Exception):
 class FemtetAutomationError(Exception):
     """Exception raised for errors in automating Femtet."""
     pass
+
+
+def _version(
+        main=None,
+        major=None,
+        minor=None,
+        Femtet=None,
+):
+    if Femtet is not None:
+        assert (main is None) and (major is None) and (minor is None), 'バージョンを指定しないでください'
+        main, major, minor = [int(v) for v in Femtet.Version.split('.')[:3]]
+    else:
+        assert (main is not None) and (major is not None) and (minor is not None), 'バージョンを指定してください'
+    return main*10000 + major*100 + minor

{pyfemtet-0.3.12 → pyfemtet-0.4.2}/pyfemtet/dispatch_extensions.py

@@ -186,6 +186,7 @@ def dispatch_femtet(timeout=DISPATCH_TIMEOUT, subprocess_log_prefix='') -> Tuple
 
     Args:
         timeout (int or float, optional): Seconds to wait for connection. Defaults to DISPATCH_TIMEOUT.
+        subprocess_log_prefix (str, optional): The prefix of log message.
 
     Raises:
         FemtetConnectionTimeoutError: Couldn't connect Femtet process for some reason (i.e. Femtet.exe is not launched).
@@ -461,6 +462,10 @@ def dispatch_specific_femtet_core(pid, timeout=DISPATCH_TIMEOUT) -> Tuple[IFemte
     return Femtet, my_pid
 
 
+def _debug():
+    launch_and_dispatch_femtet(5)
+
+
 if __name__ == '__main__':
     _Femtet, _my_pid = launch_and_dispatch_femtet(5)
     # _Femtet, _my_pid = dispatch_specific_femtet(pid=26124)