pyfemtet 0.5.3__py3-none-any.whl → 0.6.0__py3-none-any.whl

pyfemtet/{message → _message}/locales/messages.pot

@@ -8,14 +8,14 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PROJECT VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2024-08-31 04:27+0900\n"
+"POT-Creation-Date: 2024-11-05 16:28+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"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.15.0\n"
+"Generated-By: Babel 2.16.0\n"
 
 #: pyfemtet/message/messages.py:30
 msgid "hello!"
@@ -201,299 +201,311 @@ msgstr ""
 msgid "You can use parameter constraint only with BoTorchSampler."
 msgstr ""
 
-#: pyfemtet/message/messages.py:96
+#: pyfemtet/message/messages.py:93
+msgid "Scipy is deterministic, so whether you set a seed or not will not change the results."
+msgstr ""
+
+#: pyfemtet/message/messages.py:94
+msgid "Start to candidate new parameter set with constraints. This process may take a long time."
+msgstr ""
+
+#: pyfemtet/message/messages.py:95
+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:99
 msgid "Connect to Femtet"
 msgstr ""
 
-#: pyfemtet/message/messages.py:97
+#: pyfemtet/message/messages.py:100
 msgid "Analysis model name described in csv does not exist in project."
 msgstr ""
 
-#: pyfemtet/message/messages.py:98
+#: pyfemtet/message/messages.py:101
 msgid "History csv is not read yet. Open your project manually."
 msgstr ""
 
-#: pyfemtet/message/messages.py:99
+#: pyfemtet/message/messages.py:102
 msgid "Cannot read project data from csv. Open your project manually."
 msgstr ""
 
-#: pyfemtet/message/messages.py:100
+#: pyfemtet/message/messages.py:103
 msgid ".femprj file described in csv is not found. Open your project manually."
 msgstr ""
 
-#: pyfemtet/message/messages.py:101
+#: pyfemtet/message/messages.py:104
 msgid "Analysis model name is not specified. Open your model in the project manually."
 msgstr ""
 
-#: pyfemtet/message/messages.py:103
+#: pyfemtet/message/messages.py:106
 msgid "Constraint"
 msgstr ""
 
-#: pyfemtet/message/messages.py:104
+#: pyfemtet/message/messages.py:107
 msgid "feasible"
 msgstr ""
 
-#: pyfemtet/message/messages.py:105
+#: pyfemtet/message/messages.py:108
 msgid "infeasible"
 msgstr ""
 
-#: pyfemtet/message/messages.py:106
+#: pyfemtet/message/messages.py:109
 msgid "Optimality"
 msgstr ""
 
-#: pyfemtet/message/messages.py:107
+#: pyfemtet/message/messages.py:110
 msgid "non dominated"
 msgstr ""
 
-#: pyfemtet/message/messages.py:108
+#: pyfemtet/message/messages.py:111
 msgid "dominated"
 msgstr ""
 
-#: pyfemtet/message/messages.py:109
+#: pyfemtet/message/messages.py:112
 msgid "Hypervolume Plot"
 msgstr ""
 
-#: pyfemtet/message/messages.py:110
+#: pyfemtet/message/messages.py:113
 msgid "Objective Plot"
 msgstr ""
 
-#: pyfemtet/message/messages.py:111
+#: pyfemtet/message/messages.py:114
 msgid "Multi Objective Pair Plot"
 msgstr ""
 
-#: pyfemtet/message/messages.py:112
+#: pyfemtet/message/messages.py:115
 msgid "trial number"
 msgstr ""
 
-#: pyfemtet/message/messages.py:114
+#: pyfemtet/message/messages.py:117
 msgid "Objectives"
 msgstr ""
 
-#: pyfemtet/message/messages.py:115
+#: pyfemtet/message/messages.py:118
 msgid "Objectives (all)"
 msgstr ""
 
-#: pyfemtet/message/messages.py:117
+#: pyfemtet/message/messages.py:120
 msgid "Prediction Model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:118
+#: pyfemtet/message/messages.py:121
 msgid " Recalculate Model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:119
+#: pyfemtet/message/messages.py:122
 msgid " Redraw graph"
 msgstr ""
 
-#: pyfemtet/message/messages.py:120
+#: pyfemtet/message/messages.py:123
 msgid "Parameter"
 msgstr ""
 
-#: pyfemtet/message/messages.py:121
+#: pyfemtet/message/messages.py:124
 msgid "Parameter2"
 msgstr ""
 
-#: pyfemtet/message/messages.py:122
+#: pyfemtet/message/messages.py:125
 msgid "Objective"
 msgstr ""
 
-#: pyfemtet/message/messages.py:123
+#: pyfemtet/message/messages.py:126
 msgid "No history selected."
 msgstr ""
 
-#: pyfemtet/message/messages.py:124
+#: pyfemtet/message/messages.py:127
 msgid "No FEM result (yet)."
 msgstr ""
 
-#: pyfemtet/message/messages.py:125
+#: pyfemtet/message/messages.py:128
 msgid "Prediction model is not calculated yet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:126
+#: pyfemtet/message/messages.py:129
 msgid "Cannot select same parameter"
 msgstr ""
 
-#: pyfemtet/message/messages.py:127
+#: pyfemtet/message/messages.py:130
 msgid "3D graph (two or more parameters required)"
 msgstr ""
 
-#: pyfemtet/message/messages.py:129
+#: pyfemtet/message/messages.py:132
 msgid "Prediction Model of Objective"
 msgstr ""
 
-#: pyfemtet/message/messages.py:130
+#: pyfemtet/message/messages.py:133
 msgid "prediction model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:131
+#: pyfemtet/message/messages.py:134
 msgid "std. dev. of model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:133
+#: pyfemtet/message/messages.py:136
 msgid "Progress"
 msgstr ""
 
-#: pyfemtet/message/messages.py:134
+#: pyfemtet/message/messages.py:137
 msgid "Prediction"
 msgstr ""
 
-#: pyfemtet/message/messages.py:135
+#: pyfemtet/message/messages.py:138
 msgid "Workers"
 msgstr ""
 
-#: pyfemtet/message/messages.py:136
+#: pyfemtet/message/messages.py:139
 msgid "Details"
 msgstr ""
 
-#: pyfemtet/message/messages.py:138
+#: pyfemtet/message/messages.py:141
 msgid "Optimization status will be shown here."
 msgstr ""
 
-#: pyfemtet/message/messages.py:139
+#: pyfemtet/message/messages.py:142
 msgid "Auto-update graph"
 msgstr ""
 
-#: pyfemtet/message/messages.py:140
+#: pyfemtet/message/messages.py:143
 msgid "Interrupt Optimization"
 msgstr ""
 
-#: pyfemtet/message/messages.py:142
+#: pyfemtet/message/messages.py:145
 msgid "Result"
 msgstr ""
 
-#: pyfemtet/message/messages.py:144
+#: pyfemtet/message/messages.py:147
 msgid "Open Result in Femtet"
 msgstr ""
 
-#: pyfemtet/message/messages.py:145
+#: pyfemtet/message/messages.py:148
 msgid "Reconstruct Model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:146
+#: pyfemtet/message/messages.py:149
 msgid "Drag and drop or select csv file"
 msgstr ""
 
-#: pyfemtet/message/messages.py:147
+#: pyfemtet/message/messages.py:150
 msgid "Connection to Femtet is not established. Launch Femtet and Open a project."
 msgstr ""
 
-#: pyfemtet/message/messages.py:148
+#: pyfemtet/message/messages.py:151
 msgid "No result plot is selected."
 msgstr ""
 
-#: pyfemtet/message/messages.py:149
+#: pyfemtet/message/messages.py:152
 msgid "The femprj file path in the history csv is not found or valid."
 msgstr ""
 
-#: pyfemtet/message/messages.py:150
+#: pyfemtet/message/messages.py:153
 msgid "The model name in the history csv is not found."
 msgstr ""
 
-#: pyfemtet/message/messages.py:151
+#: pyfemtet/message/messages.py:154
 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:156
+#: pyfemtet/message/messages.py:159
 msgid "Failed to open "
 msgstr ""
 
-#: pyfemtet/message/messages.py:157
+#: pyfemtet/message/messages.py:160
 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:160
+#: pyfemtet/message/messages.py:163
 msgid ".femprj file path of the history csv is invalid. Please certify matching between csv and opening .femprj file."
 msgstr ""
 
-#: pyfemtet/message/messages.py:161
+#: pyfemtet/message/messages.py:164
 msgid "Analysis model name of the history csv is invalid. Please certify matching between csv and opening analysis model."
 msgstr ""
 
-#: pyfemtet/message/messages.py:162
+#: pyfemtet/message/messages.py:165
 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:163
+#: pyfemtet/message/messages.py:166
 msgid "tutorial mode"
 msgstr ""
 
-#: pyfemtet/message/messages.py:164
+#: pyfemtet/message/messages.py:167
 msgid "Load Sample CSV"
 msgstr ""
 
-#: pyfemtet/message/messages.py:165
+#: pyfemtet/message/messages.py:168
 msgid "Load CSV"
 msgstr ""
 
-#: pyfemtet/message/messages.py:166
+#: pyfemtet/message/messages.py:169
 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:168
+#: pyfemtet/message/messages.py:171
 msgid "Main Graph"
 msgstr ""
 
-#: pyfemtet/message/messages.py:169
+#: pyfemtet/message/messages.py:172
 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:172
+#: pyfemtet/message/messages.py:175
 msgid "Open Result"
 msgstr ""
 
-#: pyfemtet/message/messages.py:173
+#: pyfemtet/message/messages.py:176
 msgid "After pick a point in the main graph, This button shows the corresponding FEM result in Femtet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:175
+#: pyfemtet/message/messages.py:178
 msgid "Re-connect to Femtet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:176
+#: pyfemtet/message/messages.py:179
 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:177
+#: pyfemtet/message/messages.py:180
 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:178
+#: pyfemtet/message/messages.py:181
 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:180
+#: pyfemtet/message/messages.py:183
 msgid "Loading data..."
 msgstr ""
 
-#: pyfemtet/message/messages.py:181
+#: pyfemtet/message/messages.py:184
 msgid "Plots of objectives versus trials"
 msgstr ""
 
-#: pyfemtet/message/messages.py:182
+#: pyfemtet/message/messages.py:185
 msgid "The vertical axis is the objective, and the horizontal axis is the number of trials."
 msgstr ""
 
-#: pyfemtet/message/messages.py:183
+#: pyfemtet/message/messages.py:186
 msgid "Parallel coordinate plots"
 msgstr ""
 
-#: pyfemtet/message/messages.py:184
+#: pyfemtet/message/messages.py:187
 msgid "The vertical axis is an objective or parameters, and one polyline indicates one result."
 msgstr ""
 
-#: pyfemtet/message/messages.py:185
+#: pyfemtet/message/messages.py:188
 msgid "The heatmap of objectives"
 msgstr ""
 
-#: pyfemtet/message/messages.py:186
+#: pyfemtet/message/messages.py:189
 msgid "The axes are parameters, and the color shows objective value."
 msgstr ""
 
-#: pyfemtet/message/messages.py:187
+#: pyfemtet/message/messages.py:190
 msgid "The response of an objective versus one parameter"
 msgstr ""
 
-#: pyfemtet/message/messages.py:188
+#: pyfemtet/message/messages.py:191
 msgid "The vertical axis is objective, and the horizontal axis is parameter."
 msgstr ""
 

pyfemtet/{message → _message}/messages.py

@@ -132,7 +132,7 @@ class Message:
     GRAPH_TITLE_PREDICTION_MODEL = _('Prediction Model of Objective')
     LEGEND_LABEL_PREDICTION_MODEL = _('prediction model')
     LEGEND_LABEL_PREDICTION_MODEL_STDDEV = _('std. dev. of model')
-    # process_monitor application
+    # _process_monitor application
     PAGE_TITLE_PROGRESS = _('Progress')
     PAGE_TITLE_PREDICTION_MODEL = _('Prediction')
     PAGE_TITLE_WORKERS = _('Workers')

pyfemtet/_warning.py

@@ -0,0 +1,23 @@
+import warnings
+from functools import wraps
+
+
+def experimental_feature(func):
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        warnings.warn(f"The function '{func.__name__}' is experimental and may change in the future.", 
+                      category=UserWarning, 
+                      stacklevel=2)
+        return func(*args, **kwargs)
+    return wrapper
+
+
+if __name__ == '__main__':
+
+    # 使用例
+    @experimental_feature
+    def my_experimental_function():
+        print("This is an experimental function.")
+
+    # 実行すると、警告が表示されます。
+    my_experimental_function()

pyfemtet/dispatch_extensions/__init__.py

@@ -0,0 +1,12 @@
+from pyfemtet.dispatch_extensions._impl import (
+    dispatch_femtet,
+    dispatch_specific_femtet,
+    launch_and_dispatch_femtet,
+    DispatchExtensionException,
+    FemtetNotFoundException,
+    FemtetConnectionTimeoutError,
+    IFemtet,
+    _get_pid,
+    _get_pids,
+)
+

pyfemtet/{dispatch_extensions.py → dispatch_extensions/_impl.py}

@@ -19,9 +19,9 @@ from multiprocessing.process import _children, _cleanup
 from multiprocessing.managers import SyncManager
 
 import logging
-from .logger import get_logger
+from pyfemtet.logger import get_logger
 
-from pyfemtet.message import Msg
+from pyfemtet._message import Msg
 
 
 logger = get_logger('dispatch')
@@ -151,16 +151,19 @@ def _get_subprocess_log_prefix():
 def launch_and_dispatch_femtet(timeout=DISPATCH_TIMEOUT, strictly_pid_specify=True) -> Tuple[IFemtet, int]:
     """Launch Femtet by new process and connect to it.
 
+    The wrapper for Dispatch() but returns PID with IFemtet.
+
     Args:
-        timeout (int or float, optional): Seconds to wait for connection. Defaults to DISPATCH_TIMEOUT.
-        strictly_pid_specify (bool): If True, try to connect the launched femtet process strictly. If False, launch new process but try to connect any connectable femtet.
+        timeout (int, optional): Raises an error if the connection is not established within the specified timeout.
+        strictly_pid_specify (bool, optional): Attempts to establish a connection to the launched Femtet strictly.
+            This may result in slower processing due to process exclusivity handling.
 
     Raises:
-        FemtetNotFoundException: Launched Femtet is not found for some reason (i.e. failed to launch Femtet).
-        FemtetConnectionTimeoutError: Connection trial takes over `timeout` seconds by some reason.
+        FemtetConnectionTimeoutError: Couldn't connect Femtet process for some reason (i.e. Femtet.exe is not launched).
 
     Returns:
-        Tuple[IFemtet, int]:
+        tuple[IFemtet, int]: An object for controlling Femtet and the PID of the Femtet being controlled.
+
     """
     # launch femtet
     util.execute_femtet()
@@ -188,6 +191,22 @@ def launch_and_dispatch_femtet(timeout=DISPATCH_TIMEOUT, strictly_pid_specify=Tr
 def dispatch_femtet(timeout=DISPATCH_TIMEOUT, subprocess_log_prefix='') -> Tuple[IFemtet, int]:
     """Connect to existing Femtet process.
 
+    The wrapper for Dispatch() but returns PID with IFemtet.
+
+    Args:
+        timeout (int, optional): Raises an error if the connection is not established within the specified timeout.
+        subprocess_log_prefix (str, optional): A prefix to output in logs. Typically used only for internal processing.
+
+    Raises:
+        FemtetConnectionTimeoutError: Couldn't connect Femtet process for some reason (i.e. Femtet.exe is not launched).
+
+    Returns:
+        tuple[IFemtet, int]: An object for controlling Femtet and the PID of the Femtet being controlled.
+
+    """
+
+    """
+
     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.
@@ -234,7 +253,6 @@ def dispatch_femtet(timeout=DISPATCH_TIMEOUT, subprocess_log_prefix='') -> Tuple
     return Femtet, pid
 
 
-
 def _block_other_femtets(
         target_pid,
         subprocess_idx,
@@ -314,36 +332,7 @@ def _block_other_femtets(
 
 
 def dispatch_specific_femtet(pid, timeout=DISPATCH_TIMEOUT) -> Tuple[IFemtet, int]:
-    """Connect Femtet whose process id is specified.
-
-    This is a wrapper function of `dispatch_specific_femtet_core`.
-    When this function is called by dask worker,
-    the connection is processed exclusively.
-
-    Args:
-        pid (int): Process id of Femtet that you want to connect.
-        timeout (int or float, optional): Seconds to wait for connection. Defaults to DISPATCH_TIMEOUT.
-
-    Raises:
-        FemtetNotFoundException: Femtet whose process id is `pid` doesn't exist. 
-        FemtetConnectionTimeoutError: Connection trial takes over `timeout` seconds by some reason.
-
-    Returns:
-        Tuple[IFemtet, int]:
-    """
-    try:
-        with Lock('dispatch-specific-femtet'):
-            return dispatch_specific_femtet_core(pid, timeout)
-    except RuntimeError as e:
-        if 'object not properly initialized' in str(e):
-            pass
-        else:
-            raise e
-    return dispatch_specific_femtet_core(pid, timeout)  # for logger, out of except.
-
-
-def dispatch_specific_femtet_core(pid, timeout=DISPATCH_TIMEOUT) -> Tuple[IFemtet, int]:
-    """Connect Femtet whose process id is specified.
+    """Connect Existing Femtet whose process id is specified.
 
     Warnings:
         Once Femtet is connected a python process,
@@ -368,16 +357,29 @@ def dispatch_specific_femtet_core(pid, timeout=DISPATCH_TIMEOUT) -> Tuple[IFemte
         please consider parallel processing.
 
     Args:
-        pid (int): Process id of Femtet that you want to connect.
-        timeout (int or float, optional): Seconds to wait for connection. Defaults to 10.
+        timeout (int, optional): Raises an error if the connection is not established within the specified timeout.
 
     Raises:
-        FemtetNotFoundException: Femtet whose process id is `pid` doesn't exist. 
-        FemtetConnectionTimeoutError: Connection trial takes over `timeout` seconds by some reason.
+        FemtetConnectionTimeoutError: Couldn't connect Femtet process for some reason (i.e. Femtet.exe is not launched).
 
     Returns:
-        Tuple[IFemtet, int]:
+        tuple[IFemtet, int]: An object for controlling Femtet and the PID of the Femtet being controlled.
+
+
     """
+    try:
+        with Lock('dispatch-specific-femtet'):
+            return _dispatch_specific_femtet_core(pid, timeout)
+    except RuntimeError as e:
+        if 'object not properly initialized' in str(e):
+            pass
+        else:
+            raise e
+    return _dispatch_specific_femtet_core(pid, timeout)  # for logger, out of except.
+
+
+def _dispatch_specific_femtet_core(pid, timeout=DISPATCH_TIMEOUT) -> Tuple[IFemtet, int]:
+
     # TODO: 安定性を見て lock_main を復活させるか決める
 
     if timeout < 5:

pyfemtet/logger/__init__.py

@@ -0,0 +1,3 @@
+from pyfemtet.logger._impl import get_logger
+
+__all__ = ['get_logger']

pyfemtet/{logger.py → logger/_impl.py}

@@ -5,9 +5,6 @@ from colorlog import ColoredFormatter
 from dask.distributed import get_worker
 
 
-__all__ = ['get_logger']
-
-
 def _get_worker_name_as_prefix():
     name = '(Main) '
     try:
@@ -21,7 +18,7 @@ def _get_worker_name_as_prefix():
     return name
 
 
-class DaskLogRecord(logging.LogRecord):
+class _DaskLogRecord(logging.LogRecord):
     """Generate a log message with dask worker name."""
 
     # def __init__(self, *args, **kwargs):
@@ -43,7 +40,7 @@ class DaskLogRecord(logging.LogRecord):
         return msg
 
 
-logging.setLogRecordFactory(DaskLogRecord)  # すべての logging %(message)s の前に prefix を入れる
+logging.setLogRecordFactory(_DaskLogRecord)  # すべての logging %(message)s の前に prefix を入れる
 
 
 def _color_supported() -> bool:
@@ -88,7 +85,16 @@ def _create_formatter() -> logging.Formatter:
 
 
 def get_logger(logger_name):
-    """Return a logger with a default ColoredFormatter."""
+    """Returns a logger.
+
+    Examples:
+        >>> # Retrieves a specific logger used in pyfemtet.opt.
+        >>> import logging  # doctest: +SKIP
+        >>> from pyfemtet.logger import get_logger  # doctest: +SKIP
+        >>> logger = get_logger('opt')  # logger of optimizer  # doctest: +SKIP
+        >>> logger.setLevel(logging.ERROR)  # disable all log from optimizer  # doctest: +SKIP
+
+    """
 
     formatter = _create_formatter()
 

pyfemtet/opt/__init__.py

@@ -9,6 +9,8 @@ from pyfemtet.opt.optimizer import AbstractOptimizer
 
 from pyfemtet.opt._femopt import FEMOpt
 
+from pyfemtet.opt._femopt_core import History
+
 
 __all__ = [
     'FEMOpt',
@@ -21,4 +23,5 @@ __all__ = [
     'OptunaOptimizer',
     'ScipyScalarOptimizer',
     'ScipyOptimizer',
+    'History',
 ]