pyfemtet 0.4.10__py3-none-any.whl → 0.4.12__py3-none-any.whl

pyfemtet/opt/opt/_scipy_scalar.py

@@ -0,0 +1,104 @@
+# typing
+import logging
+from typing import Iterable
+
+# built-in
+import os
+
+# 3rd-party
+import numpy as np
+import pandas as pd
+import scipy.optimize
+from scipy.optimize import minimize_scalar, OptimizeResult
+
+# pyfemtet relative
+from pyfemtet.opt._femopt_core import OptimizationStatus, generate_lhs
+from pyfemtet.opt.opt import AbstractOptimizer, logger, OptimizationMethodChecker
+from pyfemtet.core import MeshError, ModelError, SolveError
+
+
+class ScipyScalarMethodChecker(OptimizationMethodChecker):
+    def check_incomplete_bounds(self, raise_error=True): return True
+
+
+class ScipyOptimizer(AbstractOptimizer):
+
+    def __init__(
+            self,
+            **minimize_kwargs,
+    ):
+        """
+        Args:
+            **minimize_kwargs: Kwargs of `scipy.optimize.minimize_scalar` __except ``fun``.__.
+        """
+        super().__init__()
+
+        # define members
+        self.minimize_kwargs: dict = dict()
+        self.minimize_kwargs.update(minimize_kwargs)
+        self.res: OptimizeResult = None
+        self.method_checker: OptimizationMethodChecker = ScipyScalarMethodChecker(self)
+
+    def _objective(self, x: float):  # x: candidate parameter
+        # update parameter
+        self.parameters['value'] = x
+        self.fem.update_parameter(self.parameters)
+
+        # strict constraints
+        ...
+
+        # fem
+        try:
+            _, obj_values, cns_values = self.f(x)
+        except (ModelError, MeshError, SolveError) as e:
+            logger.info(e)
+            logger.info('以下の変数で FEM 解析に失敗しました。')
+            print(self.get_parameter('dict'))
+
+            # 現状、エラーが起きたらスキップできない
+            raise StopIteration
+
+        # constraints
+        ...
+
+        # check interruption command
+        if self.entire_status.get() == OptimizationStatus.INTERRUPTING:
+            self.worker_status.set(OptimizationStatus.INTERRUPTING)
+            raise StopIteration
+
+        # objectives to objective
+
+        return obj_values[0]
+
+    def _setup_before_parallel(self):
+        pass
+
+    def run(self):
+
+        # create init
+        assert len(self.parameters) == 1
+
+        # create bounds
+        if 'bounds' not in self.minimize_kwargs.keys():
+            bounds = []
+            for i, row in self.parameters.iterrows():
+                lb, ub = row['lb'], row['ub']
+                if lb is None: lb = -np.inf
+                if ub is None: ub = np.inf
+                bounds.append([lb, ub])
+            self.minimize_kwargs.update(
+                {'bounds': bounds}
+            )
+
+        # run optimize
+        try:
+            res = minimize_scalar(
+                fun=self._objective,
+                **self.minimize_kwargs,
+            )
+        except StopIteration:
+            res = None
+            logger.warn('Optimization has been interrupted. '
+                        'Note that you cannot acquire the OptimizationResult.')
+
+        self.res = res

pyfemtet/opt/visualization/__init__.py

@@ -1,7 +0,0 @@
-from pyfemtet.opt.visualization._monitor import ResultViewerApp
-from pyfemtet.opt.visualization._monitor import ProcessMonitorApp
-
-__all__ = [
-    'ResultViewerApp',
-    'ProcessMonitorApp',
-]

pyfemtet/opt/visualization/_create_wrapped_components.py

@@ -0,0 +1,93 @@
+"""Create autocompletable components"""
+import os
+import inspect
+
+from dash.development.base_component import Component
+
+
+# noinspection PyUnresolvedReferences
+from dash import html, dcc, dash_table
+# noinspection PyUnresolvedReferences
+import dash_bootstrap_components as dbc
+
+
+here, me = os.path.split(__file__)
+COMPONENT_FILE_DIR = os.path.join(here, 'wrapped_components')
+indent = '    '
+
+
+def create(module_name: str) -> str:
+    header = '''# auto created module
+from pyfemtet.opt.visualization.wrapped_components.str_enum import StrEnum
+# from enum import StrEnum
+import dash
+import dash_bootstrap_components
+
+
+'''
+    path = os.path.join(COMPONENT_FILE_DIR, module_name.replace('.py', '') + '.py')
+    with open(path, 'w', newline='\n') as f:
+        f.write(header)
+    return path
+
+
+def append(html_class, module_path: str):
+    print('==========')
+    print(html_class)
+
+    # get property names
+    init_signature = inspect.signature(html_class.__init__)
+    props = [param.name for param in init_signature.parameters.values() if (param.name != 'self') and (param.name != 'args') and (param.name != 'kwargs')]
+
+    # create class definition
+    class_definition = f'class {html_class.__name__}({html_class.__module__}):\n'  # library specific
+
+    # create id property
+    class_definition += indent + 'def _dummy(self):\n'
+    class_definition += indent*2 + '# noinspection PyAttributeOutsideInit\n'
+    class_definition += indent*2 + 'self.id = None\n\n'
+
+    # create Prop attribute
+    class_definition += indent + 'class Prop(StrEnum):\n'
+    for available_property in props:
+        property_definition = f'{available_property} = "{available_property}"'
+        try:
+            exec(property_definition)
+        except (SyntaxError, TypeError):
+            continue
+        class_definition += indent*2 + f'{property_definition}\n'
+
+    if class_definition.endswith(':\n'):
+        return
+
+    class_definition += '\n\n'
+
+    with open(module_path, 'a', newline='\n') as f:
+        f.write(class_definition)
+
+
+def sub(module_name):
+    # glob component classes
+    module_path = create(module_name)
+    class_names = dir(eval(module_name))
+    for class_name in class_names:
+        cls = eval(f'{module_name}.{class_name}')
+        if not inspect.isclass(cls):
+            continue
+        if issubclass(cls, Component):
+            append(cls, module_path)
+
+
+def main():
+    # html
+    sub('html')
+
+    # dcc
+    sub('dcc')
+
+    # dbc
+    sub('dbc')
+
+
+if __name__ == '__main__':
+    main()

pyfemtet/opt/visualization/base.py

@@ -0,0 +1,254 @@
+# type hint
+from dash.development.base_component import Component
+
+# application
+from dash import Dash
+import webbrowser
+
+# callback
+from dash import Output, Input  # , State, no_update, callback_context
+# from dash.exceptions import PreventUpdate
+
+# components
+# from dash import html, dcc
+import dash_bootstrap_components
+
+from pyfemtet.opt._femopt_core import History
+from pyfemtet.opt.visualization.wrapped_components import html, dcc, dbc
+
+# the others
+from abc import ABC, abstractmethod
+import logging
+import psutil
+from pyfemtet.logger import get_logger
+
+
+dash_logger = logging.getLogger('werkzeug')
+dash_logger.setLevel(logging.ERROR)
+
+logger = get_logger('viewer')
+logger.setLevel(logging.ERROR)
+
+
+class AbstractPage(ABC):
+    """Define content."""
+    """
+
+        =================
+        |~:8080/rel_url | <---- page.rel_url
+        =================
+page.   |    | -------- |
+title -->home| |      | |
+        |    | |    <-------- sub_page.layout
+        |    | -------- |
+        | ^  |          |<--- page.layout
+        ==|==============
+          |
+         sidebar
+
+    """
+    def __init__(self, title='base-page', rel_url='/', application=None):
+        self.layout: Component = None
+        self.rel_url = rel_url
+        self.title = title
+        self.application: PyFemtetApplicationBase = application
+        self.subpages = []
+        self.setup_component()
+        self.setup_layout()
+
+    def add_subpage(self, subpage: 'AbstractPage'):
+        subpage.setup_component()
+        subpage.setup_layout()
+        self.subpages.append(subpage)
+
+    def set_application(self, app):
+        self.application = app
+
+    @abstractmethod
+    def setup_component(self):
+        # noinspection PyAttributeOutsideInit
+        self._component = html.Div('This is a abstract page.')
+
+    @abstractmethod
+    def setup_layout(self):
+        self.layout = self._component
+
+    def setup_callback(self):
+        # app = self.application.app
+
+        for subpage in self.subpages:
+            subpage.set_application(self.application)
+            subpage.setup_callback()
+
+        # @app.callback(...)
+        # def do_something():
+        #     return ...
+
+
+def _unused_port_number(start=49152):
+    # "LISTEN" 状態のポート番号をリスト化
+    used_ports = [conn.laddr.port for conn in psutil.net_connections() if conn.status == 'LISTEN']
+    port = start
+    for port in range(start, 65535 + 1):
+        # 未使用のポート番号ならreturn
+        if port not in set(used_ports):
+            break
+    if port != start:
+        logger.warning(f'Specified port "{start}" seems to be used. Port "{port}" is used instead.')
+    return port
+
+
+class SidebarApplicationBase:
+    """"""
+    """ Define entire layout and callback.
+    +------+--------+
+    | side | con-   |
+    | bar  | tent   |
+    +------+--------+
+       │      └─ pages (dict(href: str = layout: Component))
+       └──────── nav_links (dict(order: float) = NavLink)
+    """
+
+    # port
+    DEFAULT_PORT = 49152
+
+    # members for sidebar application
+    SIDEBAR_STYLE = {
+        "position": "fixed",
+        "top": 0,
+        "left": 0,
+        "bottom": 0,
+        "width": "16rem",
+        "padding": "2rem 1rem",
+        "background-color": "#f8f9fa",
+    }
+    CONTENT_STYLE = {
+        "margin-left": "18rem",
+        "margin-right": "2rem",
+        "padding": "2rem 1rem",
+    }
+
+    def __init__(self, title=None, subtitle=None):
+        # define app
+        self.title = title if title is not None else 'App'
+        self.subtitle = subtitle if title is not None else ''
+        self.app = Dash(
+            __name__,
+            external_stylesheets=[dash_bootstrap_components.themes.BOOTSTRAP],
+            title=title,
+            update_title=None,
+        )
+        self.pages = dict()
+        self.nav_links = dict()
+        self.page_objects = []
+
+    def add_page(self, page: AbstractPage, order: int = None):
+        page.set_application(self)
+        self.page_objects.append(page)
+        self.pages[page.rel_url] = page.layout
+        if order is None:
+            order = len(self.pages)
+        self.nav_links[order] = dbc.NavLink(page.title, href=page.rel_url, active="exact")
+
+    def setup_callback(self):
+        for page in self.page_objects:
+            page.setup_callback()
+
+    def _setup_layout(self):
+        # setup sidebar
+        # https://dash-bootstrap-components.opensource.faculty.ai/examples/simple-sidebar/
+
+        # sidebar に表示される順に並び替え
+        ordered_items = sorted(self.nav_links.items(), key=lambda x: x[0])
+        ordered_links = [value for key, value in ordered_items]
+
+        # sidebar と contents から app 全体の layout を作成
+        sidebar = html.Div(
+            [
+                html.H2(self.title, className='display-4'),
+                html.Hr(),
+                html.P(self.subtitle, className='lead'),
+                dbc.Nav(ordered_links, vertical=True, pills=True),
+            ],
+            style=self.SIDEBAR_STYLE,
+        )
+        content = html.Div(id="page-content", style=self.CONTENT_STYLE)
+        self.app.layout = html.Div([dcc.Location(id="url"), sidebar, content])
+
+        # sidebar によるページ遷移のための callback
+        @self.app.callback(Output(content.id, "children"), [Input("url", "pathname")])
+        def switch_page_content(pathname):
+            if pathname in list(self.pages.keys()):
+                return self.pages[pathname]
+
+            else:
+                return html.Div(
+                    [
+                        html.H1("404: Not found", className="text-danger"),
+                        html.Hr(),
+                        html.P(f"The pathname {pathname} was not recognised..."),
+                    ],
+                    className="p-3 bg-light rounded-3",
+                )
+
+    def run(self, host='localhost', port=None, debug=False):
+        self._setup_layout()
+        port = port or self.DEFAULT_PORT
+        # port を検証
+        port = _unused_port_number(port)
+        # ブラウザを起動
+        if host == '0.0.0.0':
+            webbrowser.open(f'http://localhost:{str(port)}')
+        else:
+            webbrowser.open(f'http://{host}:{str(port)}')
+        self.app.run(debug=debug, host=host, port=port)
+
+
+class PyFemtetApplicationBase(SidebarApplicationBase):
+    """"""
+    """
+        +------+--------+
+        | side | con-   |
+        | bar  | tent   |
+        +--^---+--^-----+
+           │      └─ pages (dict(href: str = layout: Component))
+           └──────── nav_links (dict(order: float) = NavLink)
+
+        Accessible members:
+        - history: History
+           └ local_df: pd.DataFrame
+        - app: Dash
+
+    """
+
+    def __init__(
+            self,
+            title=None,
+            subtitle=None,
+            history: History = None,
+    ):
+        # register arguments
+        self.history = history  # include actor
+        super().__init__(title, subtitle)
+
+
+def check_page_layout(page_cls: type):
+    home_page = page_cls()  # required
+    application = PyFemtetApplicationBase(title='test-app')
+    application.add_page(home_page, 0)
+    application.run(debug=True)
+
+
+if __name__ == '__main__':
+
+    # template
+    g_home_page = AbstractPage('home-page')  # required
+    g_page1 = AbstractPage('page-1', '/page-1')
+
+    g_application = SidebarApplicationBase(title='test-app')
+    g_application.add_page(g_home_page, 0)
+    g_application.add_page(g_page1, 1)
+
+    # g_application.setup_callback()
+
+    g_application.run(debug=True)

pyfemtet/opt/visualization/complex_components/alert_region.py

@@ -0,0 +1,71 @@
+# type hint
+from typing import List
+from dash.development.base_component import Component
+
+# callback
+from dash import Output, Input, State, no_update, callback_context
+from dash.exceptions import PreventUpdate
+
+# components
+from pyfemtet.opt.visualization.wrapped_components import html, dcc, dbc
+
+from pyfemtet.opt.visualization.base import AbstractPage, logger
+
+
+class AlertRegion(AbstractPage):
+
+    def setup_component(self):
+        # alert
+        # noinspection PyAttributeOutsideInit
+        self.alert_region = dbc.CardBody(children=[], id='alerts-card-body')
+
+        # clear alert
+        # noinspection PyAttributeOutsideInit
+        self.clear_alert_button = dbc.Button(
+            children='Clear messages',
+            id='clear-messages-button',
+            color='secondary',
+            outline=True,
+            className="position-relative",
+        )
+
+    def setup_layout(self):
+        self.layout = dbc.Card(
+            [
+                dbc.CardHeader(
+                    children=self.clear_alert_button,
+                    className='d-flex',                # align right
+                    style={'justify-content': 'end'},  # align right
+                ),
+                self.alert_region,
+            ]
+        )
+
+    def setup_callback(self):
+        app = self.application.app
+
+        # ===== clear alerts ==-==
+        @app.callback(
+            Output(self.alert_region.id, 'children', allow_duplicate=True),
+            Input(self.clear_alert_button.id, self.clear_alert_button.Prop.n_clicks),
+            prevent_initial_call=True,  # required if allow_duplicate=True
+        )
+        def clear_alerts(_):
+            return []
+
+    def create_alerts(self, msg, color='secondary', current_alerts=None) -> List[Component]:
+
+        if current_alerts is None:
+            current_alerts = []
+
+        new_alert = dbc.Alert(
+            msg,
+            id=f'alert-{len(current_alerts) + 1}',
+            dismissable=True,
+            color=color,
+        )
+
+        new_alerts = [new_alert]
+        new_alerts.extend(current_alerts)
+
+        return new_alerts