pyfemtet 0.4.9__py3-none-any.whl → 0.4.11__py3-none-any.whl

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

pyfemtet/opt/visualization/complex_components/control_femtet.py

@@ -0,0 +1,195 @@
+# type hint
+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
+
+# the others
+import logging
+import os
+from enum import Enum
+import json
+# noinspection PyUnresolvedReferences
+from pythoncom import com_error
+
+from pyfemtet.opt.visualization.base import PyFemtetApplicationBase, AbstractPage, logger
+from pyfemtet.opt.interface._femtet import FemtetInterface
+
+
+class FemtetState(Enum):
+    unconnected = -1
+    missing = 0
+    connected_but_empty = 1
+    connected = 2
+
+
+class FemtetControl(AbstractPage):
+
+    def __init__(self):
+        super().__init__()
+        self.fem: FemtetInterface = None
+
+    def setup_component(self):
+
+        # noinspection PyAttributeOutsideInit
+        self.dummy = html.Div(
+            id='control-femtet-dummy',
+            hidden=True,
+        )
+
+        # button
+        # noinspection PyAttributeOutsideInit
+        self.connect_femtet_button = dbc.Button(
+            children='Connect to Femtet',
+            id='connect-femtet-button',
+            outline=True,
+            color='primary',
+        )
+
+        # noinspection PyAttributeOutsideInit
+        self.connect_femtet_button_spinner = dbc.Spinner(
+            self.connect_femtet_button,
+            color='primary',
+        )
+
+        # store femtet connection state
+        # noinspection PyAttributeOutsideInit
+        self.femtet_state_prop = 'data-femtet-state'  # must start with "data-"
+        # noinspection PyAttributeOutsideInit
+        self.femtet_state = html.Data(
+            id='femtet-state',
+            **{
+                self.femtet_state_prop: {
+                    'pid': 0,
+                    'alert': '',
+                }
+            }
+        )
+
+    def setup_layout(self):
+        self.layout = [self.dummy, self.femtet_state]
+
+    def setup_callback(self):
+        # setup callback of subpages
+        super().setup_callback()
+
+        app = self.application.app
+
+        # ===== launch femtet and show spinner =====
+        @app.callback(
+            Output(self.femtet_state.id, self.femtet_state_prop),
+            Output(self.connect_femtet_button.id, self.connect_femtet_button.Prop.children),  # for spinner
+            Input(self.connect_femtet_button.id, self.connect_femtet_button.Prop.n_clicks),)
+        def connect_femtet(_):
+
+            # ignore when loaded
+            if callback_context.triggered_id is None:
+                raise PreventUpdate
+
+            # create FemtetInterface arguments
+            kwargs, warning_msg = self.create_femtet_interface_args()
+
+            # try to launch femtet
+            try:
+                self.fem = FemtetInterface(**kwargs)
+
+            except com_error:
+                # model_name is not included in femprj
+                kwargs.update(dict(model_name=None))
+                self.fem = FemtetInterface(**kwargs)
+                warning_msg = 'Analysis model name described in csv does not exist in project.'
+
+            # if 'new' femtet, Interface try to terminate Femtet when the self.fem is reconstructed.
+            self.fem.quit_when_destruct = False
+
+            state_data = {
+                'pid': self.fem.femtet_pid,
+                'alert': warning_msg,
+            }
+
+            return state_data, no_update
+
+    def create_femtet_interface_args(self) -> [dict, str]:
+        """Returns the argument of FemtetInterface and warning message
+
+        # femprj_path=None,
+        # model_name=None,
+        # connect_method='auto',  # dask worker では __init__ の中で 'new' にするので super() の引数にしない。（しても意味がない）
+        # save_pdt='all',  # 'all' or None
+        # strictly_pid_specify=True,  # dask worker では True にしたいので super() の引数にしない。
+        # allow_without_project=False,  # main でのみ True を許容したいので super() の引数にしない。
+        # open_result_with_gui=True,
+        # parametric_output_indexes_use_as_objective=None,
+
+        """
+
+        kwargs = dict(
+            connect_method='auto',
+            femprj_path=None,
+            model_name=None,
+            allow_without_project=True,
+        )
+
+        # check holding history
+        if self.application.history is None:
+            return kwargs, 'History csv is not read yet. Open your project manually.'
+
+        # get metadata
+        additional_metadata = self.application.history.metadata[0]
+
+        # check metadata exists
+        if additional_metadata == '':
+            return kwargs, 'Cannot read project data from csv. Open your project manually.'
+
+        # check the metadata is valid json
+        try:
+            d = json.loads(additional_metadata)
+            femprj_path = os.path.abspath(d['femprj_path'])
+        except (TypeError, json.decoder.JSONDecodeError, KeyError):
+            return kwargs, ('Cannot read project data from csv because of the invalid format. '
+                            'Valid format is like: '
+                            '"{""femprj_path"": ""c:\\path\\to\\sample.femprj"", ""model_name"": ""<model_name>""}". ' 
+                            'Open your project manually.')
+
+        # check containing femprj
+        if femprj_path is None:
+            return kwargs, 'Cannot read project data from csv. Open your project manually.'
+
+        # check femprj exists
+        if not os.path.exists(femprj_path):
+            return kwargs, '.femprj file described in csv is not found. Open your project manually.'
+
+        # at this point, femprj is valid at least.
+        kwargs.update({'femprj_path': femprj_path})
+
+        # check model name
+        model_name = d['model_name'] if 'model_name' in d.keys() else None
+        msg = '' if model_name is not None else 'Analysis model name is not specified. Open your model in the project manually.'
+        kwargs.update({'model_name': model_name})
+        return kwargs, msg
+
+    def check_femtet_state(self) -> FemtetState:
+
+        # check fem is initialized
+        if self.fem is None:
+            return FemtetState.missing
+
+        Femtet = self.fem.Femtet
+
+        # check Femtet is constructed
+        if Femtet is None:
+            return FemtetState.missing
+
+        # check Femtet is alive
+        if not self.fem.femtet_is_alive():
+            return FemtetState.missing
+
+        # check a project is opened
+        if Femtet.Project == '':
+            return FemtetState.connected_but_empty
+
+        return FemtetState.connected

pyfemtet/opt/visualization/{_graphs.py → complex_components/main_figure_creator.py}

@@ -1,6 +1,8 @@
 import plotly.graph_objs as go
 import plotly.express as px
 
+from pyfemtet.opt._femopt_core import History
+
 
 class _ColorSet:
     non_domi = {True: '#007bff', False: '#6c757d'}  # color
@@ -37,7 +39,7 @@ _cs = _ColorSet()
 _ss = _SymbolSet()
 
 
-def update_hypervolume_plot(history, df):
+def get_hypervolume_plot(_: History, df):
     df = _ls.localize(df)
 
     # create figure
@@ -58,26 +60,28 @@ def update_hypervolume_plot(history, df):
     return fig
 
 
-def update_default_figure(history, df):
+def get_default_figure(history, df):
+    # df = history.local_data  # monitor process and history process is different workers, so history.local_data is not updated in monitor process.
+    # df = history.actor_data.copy()  # access to actor from flask callback makes termination unstable.
 
     # data setting
     obj_names = history.obj_names
 
-    if len(obj_names) == 0:
-        fig = go.Figure()
+    fig = go.Figure()
 
-    elif len(obj_names) == 1:
-        fig = update_single_objective_plot(history, df)
+    if len(obj_names) == 1:
+        fig = _get_single_objective_plot(history, df)
 
     elif len(obj_names) >= 2:
-        fig = update_multi_objective_pairplot(history, df)
+        fig = _get_multi_objective_pairplot(history, df)
 
     fig.update_traces(hoverinfo="none", hovertemplate=None)
+    fig.update_layout(clickmode='event+select')
 
     return fig
 
 
-def update_single_objective_plot(history, df):
+def _get_single_objective_plot(history, df):
 
     df = _ls.localize(df)
     obj_name = history.obj_names[0]
@@ -125,7 +129,7 @@ def update_single_objective_plot(history, df):
     return fig
 
 
-def update_multi_objective_pairplot(history, df):
+def _get_multi_objective_pairplot(history, df):
     df = _ls.localize(df)
 
     obj_names = history.obj_names
@@ -183,43 +187,3 @@ def update_multi_objective_pairplot(history, df):
     )
 
     return fig
-
-
-def _debug():
-    import os
-
-    os.chdir(os.path.dirname(__file__))
-    csv_path = 'sample.csv'
-
-    show_static_monitor(csv_path)
-
-
-def show_static_monitor(csv_path):
-    from pyfemtet.opt._femopt_core import History
-    from pyfemtet.opt.visualization._monitor import ResultViewerApp
-    _h = History(history_path=csv_path)
-    _monitor = ResultViewerApp(history=_h)
-    _monitor.run()
-
-
-def entry_point():
-    import argparse
-    parser = argparse.ArgumentParser()
-
-    parser.add_argument('csv_path', help='pyfemtet を実行した結果の csv ファイルのパスを指定してください。', type=str)
-
-    # parser.add_argument(
-    #     "-c",
-    #     "--csv-path",
-    #     help="pyfemtet.opt による最適化結果 csv ファイルパス",
-    #     type=str,
-    # )
-
-    args = parser.parse_args()
-
-    if args.csv_path:
-        show_static_monitor(args.csv_path)
-
-
-if __name__ == '__main__':
-    _debug()