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

pyfemtet/opt/_test_utils/control_femtet.py

@@ -1,39 +0,0 @@
-from time import sleep
-from subprocess import run
-from multiprocessing import Process
-from tqdm import tqdm
-from win32com.client import Dispatch
-from femtetutils import util
-
-
-def _open_femprj(femprj_path):
-    Femtet = Dispatch("FemtetMacro.Femtet")
-    for _ in tqdm(range(5), "Wait to complete Dispatch before opening femprj..."):
-        sleep(1)
-    Femtet.LoadProject(femprj_path, True)
-
-
-def launch_femtet(femprj_path):
-    # launch Femtet externally
-    util.execute_femtet()
-    pid = util.get_last_executed_femtet_process_id()
-    for _ in tqdm(range(8), "Wait to complete Femtet launching."):
-        sleep(1)
-
-    # open femprj in a different process
-    # to release Femtet for sample program
-    if femprj_path:
-        p = Process(
-            target=_open_femprj,
-            args=(femprj_path,),
-        )
-        p.start()
-        p.join()
-
-
-def taskkill_femtet():
-    for _ in tqdm(range(3), "Wait before taskkill Femtet"):
-        sleep(1)
-    run(["taskkill", "/f", "/im", "Femtet.exe"])
-    for _ in tqdm(range(3), "Wait after taskkill Femtet"):
-        sleep(1)

pyfemtet/opt/_test_utils/hyper_sphere.py

@@ -1,24 +0,0 @@
-import numpy as np
-from numpy import sin, cos
-from pyfemtet.opt import AbstractOptimizer
-
-
-class HyperSphere(object):
-
-    def __init__(self, N):
-        self.N = N
-        self._x = np.zeros(self.N, dtype=float)
-
-    def calc(self, r, *angles):
-        _x = []
-        for i in range(self.N - 1):
-            __x = r * np.prod([sin(angles[j]) for j in range(i)])
-            __x = __x * cos(angles[i])
-            _x.append(__x)
-        _x.append(r * np.prod([sin(angles[j]) for j in range(self.N - 1)]))
-        self._x = np.array(_x)
-
-    def x(self, opt: AbstractOptimizer, index: int):
-        r, *angles = opt.get_parameter("values")
-        self.calc(r, *angles)
-        return self._x[index]

pyfemtet/opt/_test_utils/record_history.py

@@ -1,130 +0,0 @@
-import os
-import csv
-from shutil import copy
-from glob import glob
-
-import numpy as np
-import pandas as pd
-
-from pyfemtet.opt import FEMOpt
-from pyfemtet._message import encoding as ENCODING
-
-
-def remove_extra_data_from_csv(csv_path, encoding=ENCODING):
-
-    with open(csv_path, mode="r", encoding=encoding, newline="\n") as f:
-        reader = csv.reader(f, delimiter=",")
-        data = [line for line in reader]
-
-    new_meta_data = data[0]
-    new_meta_data[0] = ""
-    data[0] = new_meta_data
-
-    with open(csv_path, mode="w", encoding=encoding, newline="\n") as f:
-        writer = csv.writer(f, delimiter=',')
-        writer.writerows(data)
-
-
-def find_latest_csv(dir_path=None):
-    if dir_path is None:
-        dir_path = ""
-    target = os.path.join(dir_path, "*.csv")
-    files = [(f, os.path.getmtime(f)) for f in glob(target)]
-    out = sorted(files, key=lambda files: files[1])[-1]
-    return os.path.abspath(out[0])
-
-
-def py_to_reccsv(py_path, suffix=""):
-    dst_csv_path = py_path + suffix
-    dst_csv_path = dst_csv_path.replace(f".py{suffix}", f"{suffix}.reccsv")
-    return dst_csv_path
-
-
-def record_result(src: FEMOpt or str, py_path, suffix=""):
-    """Record the result csv for `is_equal_result`."""
-
-    if isinstance(src, FEMOpt):  # get df directory
-        src_csv_path = src.history_path
-    else:
-        src_csv_path = os.path.abspath(src)
-
-    dst_csv_path = py_to_reccsv(py_path, suffix)
-    copy(src_csv_path, dst_csv_path)
-
-
-def _get_obj_from_csv(csv_path, encoding=ENCODING):
-    df = pd.read_csv(csv_path, encoding=encoding, header=2)
-    columns = df.columns
-    with open(csv_path, mode="r", encoding=encoding, newline="\n") as f:
-        reader = csv.reader(f, delimiter=",")
-        meta = reader.__next__()
-    obj_indices = np.where(np.array(meta) == "obj")[0]
-    out: pd.DataFrame = df.iloc[:, obj_indices]
-    out = out.dropna(axis=0)
-    return out, columns
-
-
-def is_equal_result(ref_path, dif_path, log_path=None, threashold=0.05):
-    """Check the equality of two result csv files."""
-    ref_df, ref_columns = _get_obj_from_csv(ref_path)
-    dif_df, dif_columns = _get_obj_from_csv(dif_path)
-
-    if log_path is not None:
-        with open(log_path, "a", newline="\n", encoding=ENCODING) as f:
-            f.write("\n\n===== 結果の分析 =====\n\n")
-            f.write(f"        \tref\tdif\n")
-            f.write(f"---------------------\n")
-            f.write(f"len(col)\t{len(ref_columns)}\t{len(dif_columns)}\n")
-            f.write(f"len(df) \t{len(ref_df)}\t{len(dif_df)}\n")
-            try:
-                difference = (
-                    np.abs(ref_df.values - dif_df.values) / np.abs(dif_df.values)
-                ).mean()
-                f.write(f"diff    \t{int(difference*100)}%\n")
-            except Exception:
-                f.write(f"diff    \tcannot calc\n")
-
-    else:
-        difference = (
-                np.abs(ref_df.values - dif_df.values) / np.abs(dif_df.values)
-        ).mean()
-
-    assert len(ref_columns) == len(dif_columns), "結果 csv の column 数が異なります。"
-    assert len(ref_df) == len(dif_df), "結果 csv の row 数が異なります。"
-    assert difference <= threashold*100, f"前回の結果との平均差異が {int(difference)}% で {int(threashold*100)}% を超えています。"
-    print(f"OK! 前回の結果との平均差異が {int(difference)}% で {int(threashold*100)}% 以下です。")
-
-
-def _get_simplified_df_values(csv_path, exclude_columns=None):
-    exclude_columns = exclude_columns if exclude_columns is not None else []
-
-    with open(csv_path, 'r', encoding='cp932') as f:
-        meta_header = f.readline()
-    meta_header = 'removed' + meta_header.split('}"')[-1]
-    meta_header = meta_header.split(',')
-
-    df = pd.read_csv(csv_path, encoding='cp932', header=2)
-
-    prm_names = []
-    for meta_data, col in zip(meta_header, df.columns):
-        if meta_data == 'prm':
-            if col not in exclude_columns:
-                prm_names.append(col)
-
-    obj_names = []
-    for meta_data, col in zip(meta_header, df.columns):
-        if meta_data == 'obj':
-            if col not in exclude_columns:
-                obj_names.append(col)
-
-    pdf = pd.DataFrame()
-
-    for col in prm_names:
-        pdf[col] = df[col]
-
-    for col in obj_names:
-        pdf[col] = df[col]
-
-    return pdf.values.astype(float)
-
-

pyfemtet/opt/advanced_samples/excel_ui/pyfemtet-core.py

@@ -1,291 +0,0 @@
-"""同梱する femtet-macro.xlsm から pyfemtet を呼び出す際の pyfemtet スクリプト。"""
-
-
-import os
-
-from fire import Fire
-
-
-def get_sampler_class(sampling_method):
-    if sampling_method is None:
-        # default
-        from pyfemtet.opt.optimizer import PoFBoTorchSampler
-        return PoFBoTorchSampler
-    elif sampling_method == 'QMC':
-        from optuna.samplers import QMCSampler
-        return QMCSampler
-    elif sampling_method == 'PoFBoTorch':
-        from pyfemtet.opt.optimizer import PoFBoTorchSampler
-        return PoFBoTorchSampler
-    elif sampling_method == 'Random':
-        from optuna.samplers import RandomSampler
-        return RandomSampler
-    elif sampling_method == 'NSGA2':
-        from optuna.samplers import NSGAIISampler
-        return NSGAIISampler
-    elif sampling_method == 'TPE':
-        from optuna.samplers import TPESampler
-        return TPESampler
-    elif sampling_method == 'BoTorch':
-        from optuna_integration import BoTorchSampler
-        return BoTorchSampler
-    else:
-        raise NotImplementedError(f'The method {sampling_method} is not implemented.')
-
-
-def core(
-        xlsm_path: str,
-        csv_path: str or None,
-        femprj_path: str or None,  # xlsm と同じフォルダに配置する前提。
-        model_name: str or None,
-        input_sheet_name: str,
-
-        output_sheet_name: str or None,
-        constraint_sheet_name: str or None,
-        procedure_name: str or None,  # 引数に拡張子を除く femprj ファイル名を取るように実装すること
-        setup_procedure_name: str or None,
-        teardown_procedure_name: str or None,
-
-        sampler_class: type('BaseSampler') or None,
-        sampler_kwargs: dict or None,
-
-        n_parallel: int,
-        n_trials: int or None,
-        timeout: float or None,
-        seed: int or None,
-):
-    from pathlib import Path
-    from pyfemtet.opt import FEMOpt, OptunaOptimizer
-    from pyfemtet.opt.interface._excel_interface import ExcelInterface
-
-    procedure_args = []
-    related_file_paths = []
-    if femprj_path is not None:
-        prj_name = os.path.basename(femprj_path).removesuffix('.femprj')
-        procedure_args.append(prj_name)
-        related_file_paths = [Path(femprj_path)]
-    if model_name is not None:
-        procedure_args.append(model_name)
-    if femprj_path is None and model_name is not None:
-        raise NotImplementedError
-
-    fem = ExcelInterface(
-        input_xlsm_path=xlsm_path,
-        input_sheet_name=input_sheet_name,
-        output_xlsm_path=None,
-        output_sheet_name=output_sheet_name,
-        constraint_xlsm_path=None,
-        constraint_sheet_name=constraint_sheet_name,
-        procedure_name=procedure_name,
-        procedure_args=procedure_args,
-        connect_method='new',
-        setup_procedure_name=setup_procedure_name,
-        teardown_procedure_name=teardown_procedure_name,
-        related_file_paths=related_file_paths,
-        visible=False,
-        interactive=True,
-    )
-
-    opt = OptunaOptimizer(
-        sampler_class=sampler_class,
-        sampler_kwargs=sampler_kwargs,
-    )
-
-    femopt = FEMOpt(
-        fem=fem,
-        opt=opt,
-        history_path=csv_path,
-    )
-
-    if seed is not None:
-        femopt.set_random_seed(42)
-
-    femopt.optimize(
-        n_trials=n_trials,
-        n_parallel=n_parallel,
-        timeout=timeout,
-        confirm_before_exit=True,
-    )
-
-
-def main(
-        # これらは Fire キーワード引数指定できるように None を与えているが必須
-        xlsm_path: str = None,
-        input_sheet_name: str = None,
-        n_parallel: int = 1,
-        output_sheet_name: str or None = None,
-
-        femprj_path: str or None = None,  # 指定する場合は xlsm と同じフォルダに配置する前提にすること
-        model_name: str = None,
-        csv_path: str or None = None,
-        constraint_sheet_name: str or None = None,
-        procedure_name: str or None = None,  # 引数に拡張子を除く femprj ファイル名を取るように実装すること
-        setup_procedure_name: str or None = None,
-        teardown_procedure_name: str or None = None,
-
-        algorithm: str or None = None,
-
-        n_trials: int or None = None,
-        timeout: float or None = None,
-        seed: int or None = None,
-
-        **algorithm_settings: dict,
-
-):
-    import sys
-    import inspect
-    from pyfemtet.logger import get_module_logger
-
-    # ----- Fire memo -----
-    # print(csv_path)  # 与えなければ None
-    # print(algorithm_settings)  # 与えなければ {}, 与えれば {'n_startup_trials': 10} など
-    # print(n_parallel, type(n_parallel))  # int か float に自動変換される
-    # print(timeout, type(timeout))  # int か float に自動変換される
-
-
-    # ----- check 必須 args -----
-    logger = get_module_logger('opt.script', __name__)
-
-    os.chdir(os.path.dirname(__file__))
-
-    if xlsm_path is None:
-        logger.error(f'xlsm_path を指定してください。')
-        input('終了するには Enter を押してください。')
-        sys.exit(1)
-
-    if input_sheet_name is None:
-        logger.error(f'input_sheet_name を指定してください。')
-        input('終了するには Enter を押してください。')
-        sys.exit(1)
-
-    if output_sheet_name is None:
-        logger.error(f'output_sheet_name を指定してください。')
-        input('終了するには Enter を押してください。')
-        sys.exit(1)
-
-
-    # ----- check args -----
-    logger.info(f'{os.path.basename(__file__)} は {os.path.basename(xlsm_path)} に呼び出されました.')
-
-    # xlsm_path
-    xlsm_path = os.path.abspath(xlsm_path)
-    if not os.path.exists(xlsm_path):
-        logger.error(f'{xlsm_path} が見つかりませんでした。')
-        input('終了するには Enter を押してください。')
-        sys.exit(1)
-
-    # femprj_path
-    if femprj_path is not None:
-        femprj_path = os.path.abspath(femprj_path)
-        if not os.path.exists(femprj_path):
-            logger.error(f'{femprj_path} が見つかりませんでした。')
-            input('終了するには Enter を押してください。')
-            sys.exit(1)
-
-    # model_name
-    if model_name is not None and femprj_path is None:
-        logger.error(f'model_name ({model_name}) を指定する場合は femprj_path も指定してください。')
-        input('終了するには Enter を押してください。')
-        sys.exit(1)
-
-    # n_parallel
-    try:
-        n_parallel = int(n_parallel)
-    except ValueError:
-        logger.error(f'n_parallel ({n_parallel}) は自然数にできません。')
-        input('終了するには Enter を押してください。')
-        sys.exit(1)
-
-    # csv_path
-    csv_path = os.path.abspath(csv_path) if csv_path is not None else csv_path
-
-    # n_trials
-    if n_trials is not None:
-        try:
-            n_trials = int(n_trials)
-        except ValueError:
-            logger.error(f'n_trials ({n_trials}) は自然数にできません。')
-            input('終了するには Enter を押してください。')
-            sys.exit(1)
-
-    # timeout
-    if timeout is not None:
-        try:
-            timeout = float(timeout)
-        except ValueError:
-            logger.error(f'timeout ({timeout}) は数値にできません。')
-            input('終了するには Enter を押してください。')
-            sys.exit(1)
-
-    # seed
-    if seed is not None:
-        try:
-            seed = int(seed)
-        except ValueError:
-            logger.error(f'seed ({seed}) は自然数にできません。')
-            input('終了するには Enter を押してください。')
-            sys.exit(1)
-
-    # sampler
-    try:
-        sampler_class = get_sampler_class(algorithm)
-    except NotImplementedError:
-        logger.error(f'algorithm ({algorithm}) は非対応です。')
-        input('終了するには Enter を押してください。')
-        sys.exit(1)
-
-    # sampler_kwargs
-    sampler_kwargs = algorithm_settings
-    # noinspection PyUnboundLocalVariable
-    available_sampler_kwarg_keys = inspect.signature(sampler_class).parameters.keys()
-    for given_key in sampler_kwargs.keys():
-        if given_key not in available_sampler_kwarg_keys:
-            print()
-            print(sampler_class.__doc__)
-            print()
-            logger.error(f'algorithm_setting の項目 ({given_key}) は {sampler_class.__name__} に設定できません。詳しくは上記のドキュメントをご覧ください。')
-            input('終了するには Enter を押してください。')
-            sys.exit(1)
-
-    logger.info('引数の整合性チェックが終了しました。最適化を実行します。しばらくお待ちください...')
-
-    core(
-        xlsm_path,
-        csv_path,
-        femprj_path,  # xlsm と同じフォルダに配置する前提。
-        model_name,
-        input_sheet_name,
-
-        output_sheet_name,
-        constraint_sheet_name,
-        procedure_name,  # 引数に拡張子を除く femprj ファイル名を取るように実装すること
-        setup_procedure_name,
-        teardown_procedure_name,
-
-        sampler_class,
-        sampler_kwargs,
-
-        n_parallel,
-        n_trials,
-        timeout,
-        seed,
-    )
-
-
-if __name__ == '__main__':
-    Fire(main)
-
-    # ===== Debug Code =====
-    # import os
-    # os.chdir(os.path.dirname(__file__))
-    # main(
-    #     xlsm_path='インターフェース.xlsm',
-    #     input_sheet_name='設計変数',
-    #     n_parallel=1,
-    #     output_sheet_name='目的関数',
-    #     constraint_sheet_name='拘束関数',
-    #     procedure_name='FemtetMacro.FemtetMain',
-    #     setup_procedure_name='setup',
-    #     teardown_procedure_name='teardown',
-    #     n_trials=3,
-    # )

pyfemtet/opt/advanced_samples/excel_ui/test-pyfemtet-core.cmd

@@ -1,22 +0,0 @@
-cd %~dp0
-rem poetry run python pyfemtet-core.py --help
-rem poetry run python pyfemtet-core.py "xlsm" "femprj" "input_sheet" 3
-rem poetry run python pyfemtet-core.py "xlsm" "femprj" "input_sheet" 3 --n_startup_trials=10 --timeout=3.14
-rem poetry run python pyfemtet-core.py "xlsm" "femprj" "input_sheet" 3 --n_startup_trials=10 --timeout=5
-rem poetry run python pyfemtet-core.py "xlsm" "femprj" "input_sheet" 3.14 --n_startup_trials=10 --timeout=5
-poetry run python pyfemtet-core.py ^
-    �C���^�[�t�F�[�X.xlsm ^
-    --input_sheet_name="�݌v�ϐ�" ^
-    --output_sheet_name="�ړI�֐�" ^
-    --constraint_sheet_name="�S���֐�" ^
-
-    --n_parallel=1 ^
-    --csv_path="test.csv" ^
-    --procedure_name=FemtetMacro.FemtetMain ^
-    --setup_procedure_name=PrePostProcessing.setup ^
-    --teardown_procedure_name=PrePostProcessing.teardown ^
-
-    --algorithm=Random ^
-    --n_startup_trials=10 ^
-
-pause

pyfemtet/opt/advanced_samples/restart/gal_ex13_parametric_restart.py

@@ -1,99 +0,0 @@
-import os
-from time import sleep
-
-from optuna.samplers import RandomSampler, NSGAIISampler, GPSampler, BaseSampler
-
-from pyfemtet.opt import FEMOpt, FemtetInterface, OptunaOptimizer
-
-os.chdir(os.path.dirname(__file__))
-
-
-def get_res_freq(Femtet):
-    Galileo = Femtet.Gogh.Galileo
-    Galileo.Mode = 0
-    sleep(0.01)
-    return Galileo.GetFreq().Real
-
-
-def main(n_trials, sampler_class: type[BaseSampler], sampler_kwargs: dict):
-    """Main function
-
-    length
-    using different algorithms for each restarting.
-
-    So this main function requires n_trials and sampler_class.
-
-    Args:
-
-        n_trials (int):
-            How many additional succeeded trials
-            to terminate optimization.
-
-        sampler_class (type[optuna.samplers.BaseSampler]):
-            The algorithm we use.
-
-        sampler_kwargs (dict):
-            The arguments of sampler.
-
-    """
-
-
-    # Connect to Femtet.
-    fem = FemtetInterface(
-        femprj_path='gal_ex13_parametric.femprj',
-    )
-
-    # Initialize the optimization object.
-    opt = OptunaOptimizer(
-        sampler_class=sampler_class,
-        sampler_kwargs=sampler_kwargs,
-    )
-
-    # To restart, it is necessary to inform the new optimization program
-    # about the history of the previous optimization.
-    # By specifying a csv for the `history_path` argument of FEMOpt,
-    # if it does not exist, a new csv file will be created,
-    # and if it exists, optimization will continue from that csv file.
-    #
-    # Note:
-    #   When restarting, the number and names of variables,
-    #   as well as the number and names of objective functions
-    #   and constraints must be consistent.
-    #   However, you can change the bounds of variables,
-    #   direction of objective functions, and content of constraints.
-    #
-    # Note:
-    #   When using OptunaOptimizer, the .db file with the same name
-    #   (in this case restarting-sample.db) that is saved along with
-    #   csv is required to be  in the same folder as the csv file.
-    femopt = FEMOpt(
-        fem=fem,
-        opt=opt,
-        history_path='restarting-sample.csv'
-    )
-
-    # Set the design variables.
-    femopt.add_parameter('length', 0.1, 0.02, 0.2)
-    femopt.add_parameter('width', 0.01, 0.001, 0.02)
-    femopt.add_parameter('base_radius', 0.008, 0.006, 0.01)
-
-    # Set the objective function.
-    femopt.add_objective(fun=get_res_freq, name='First Resonant Frequency (Hz)', direction=800)
-
-    # Run optimization.
-    femopt.set_random_seed(42)
-    femopt.optimize(n_trials=n_trials, confirm_before_exit=False)
-
-
-if __name__ == '__main__':
-    # First, we will perform 3 optimizations using the RandomSampler.
-    main(3, RandomSampler, {})
-
-    # Next, we will perform 3 optimizations using the NSGAIISampler.
-    main(3, NSGAIISampler, {})
-
-    # Finally, we will perform 3 optimizations using the GPSampler.
-    main(3, GPSampler, {'n_startup_trials': 0, 'deterministic_objective': True})
-
-    # After this program ends, you can continue further with
-    # restarting-sample.csv and the .db file.