arbok-inspector 1.3.0__py3-none-any.whl

arbok_inspector/cli.py

@@ -0,0 +1,4 @@
+import runpy
+
+def main():
+    runpy.run_module('arbok_inspector.main', run_name='__main__')

arbok_inspector/configurations/1d_plot.json

@@ -0,0 +1,49 @@
+{
+  "data": [],
+  "layout": {
+    "template": "plotly_dark",
+    "autosize": true,
+    "margin": {
+      "l": 40,
+      "r": 40,
+      "t": 40,
+      "b": 40
+    },
+    "xaxis": {
+      "type": "linear",
+      "title": {
+        "text": "placeholder x-axis",
+        "font": {
+          "size": 12
+        }
+      }
+    },
+    "yaxis": {
+      "type": "linear",
+      "title": {
+        "text": "placeholder y-axis",
+        "font": {
+          "size": 12
+        }
+      }
+    },
+    "title": {
+      "text": "placeholder title",
+      "x": 0.5,
+      "xanchor": "center",
+      "yanchor": "bottom",
+      "font": {
+        "size": 16
+      }
+    },
+    "legend": {
+      "x": 1,
+      "y": 1,
+      "xanchor": "right",
+      "yanchor": "top",
+      "bgcolor": "rgba(0,0,0,0.5)",
+      "bordercolor": "white",
+      "borderwidth": 1
+    }
+  }
+}

arbok_inspector/configurations/2d_plot.json

@@ -0,0 +1,60 @@
+{
+  "data": [
+    {
+      "type": "heatmap",
+      "z": null,
+      "x": null,
+      "y": null,
+      "colorscale": "magma",
+      "colorbar": {
+        "thickness": 10,
+        "xanchor": "left",
+        "x": 1.0
+      },
+      "showscale": true
+    }
+  ],
+  "layout": {
+    "template": "plotly_dark",
+    "autosize": true,
+    "margin": {
+      "l": 40,
+      "r": 40,
+      "t": 40,
+      "b": 40
+    },
+    "xaxis": {
+      "type": "linear",
+      "title": {
+        "text": "placeholder x-axis",
+        "font": {
+          "size": 12
+        }
+      },
+      "tickfont": {
+        "size": 12
+      }
+    },
+    "yaxis": {
+      "type": "linear",
+      "title": {
+        "text": "placeholder y-axis",
+        "font": {
+          "size": 12
+        }
+      },
+      "tickfont": {
+        "size": 12
+      }
+    },
+    "title": {
+      "text": "placeholder title",
+      "x": 0.5,
+      "xanchor": "center",
+      "yanchor": "bottom",
+      "font": {
+        "size": 12
+      }
+    }
+  }
+}

arbok_inspector/dev.py

@@ -0,0 +1,19 @@
+from nicegui import ui
+from pathlib import Path
+import asyncio
+from typing import Optional
+
+from arbok_inspector.state import inspector
+from arbok_inspector.pages import greeter, database_browser
+
+def main():
+    ui.run(
+        title='Arbok Inspector',
+        favicon='🐍',
+        dark=True,
+        show=True,
+        port=8090
+    )
+
+if __name__ in {"__main__", "__mp_main__"}:
+    main()

arbok_inspector/helpers/string_formaters.py

@@ -0,0 +1,37 @@
+
+import xarray as xr
+from arbok_inspector.helpers.unit_formater import unit_formatter
+
+def title_formater(run):
+    """
+    Format title string for plots based on selected dimensions.
+    
+    Args:
+        run: The Run object containing the data.
+    Returns:
+        A formatted title string.
+    """
+    title = ""
+    for dim in run.dim_axis_option["select_value"]:
+        title += f"{dim.name} = {unit_formatter(run, dim, dim.select_index)}<br>"
+    return title
+
+def axis_label_formater(ds: xr.DataArray, dim_name: str) -> str:
+    """
+    Format axis label by replacing '__' with '.' and bolding the last part.
+    
+    Args:
+        dim_name: The dimension name string.
+    Returns:
+        A formatted axis label string.
+    """
+    dim_list = dim_name.split('__')
+    print(f"{dim_list=}")
+    if 'units' in ds.coords[dim_name].attrs:
+        unit = ds.coords[dim_name].attrs['units']
+    else:
+        unit = ""
+    if len(dim_list) > 1:
+        return f"{'.'.join(dim_list[:-1])}.<b>{dim_list[-1]}</b> ({unit})"
+    else:
+        return f"<b>{dim_list[0]}</b> ({unit})"

arbok_inspector/helpers/unit_formater.py

@@ -0,0 +1,29 @@
+"""Helper functions for formatting units with SI prefixes."""
+
+def unit_formatter(run, dim, index: int) -> str:
+    """
+    If value is larger than 1e3, format with SI prefix.
+    Same if smaller than 1e-3.
+
+    Args:
+        run (Run): Run object containing the data
+        dim (Dim): Dimension object
+        index (int): Index of the value to format
+    """
+    unit_tuples = [
+        ('G', 1e9), ('M', 1e6), ('k', 1e3), ('m', 1e-3), ('µ', 1e-6), ('n', 1e-9)]
+    try:
+        value = run.full_data_set[dim.name].values[index]
+        unit = run.full_data_set[dim.name].attrs['units']
+        if abs(value) >= 1e3 or (abs(value) < 1e-3 and value != 0):
+            for prefix, factor in unit_tuples:
+                if abs(value) >= factor or (abs(value) < 1e-3 and value != 0 and factor < 1):
+                    scaled_value = value / factor
+                    return f'{scaled_value:.3f} {prefix}<b>{unit}</b>'
+        if unit is None or unit == '':
+            return f'{value:.3f}'
+        else:
+            return f'{value:.3f} ({unit})'
+    except Exception as e:
+        print(f"Error in unit_formatter: {e}")
+        return 'N/A'

arbok_inspector/main.py

@@ -0,0 +1,15 @@
+from nicegui import ui
+from pathlib import Path
+import asyncio
+from typing import Optional
+
+from arbok_inspector.state import inspector
+from arbok_inspector.pages import greeter, database_browser
+
+ui.run(
+    title='Arbok Inspector',
+    favicon='🐍',
+    dark=True,
+    show=True,
+    port=8090
+)

arbok_inspector/pages/__init__.py

@@ -0,0 +1,2 @@
+from .greeter import greeter_page
+from .database_browser import database_browser_page

arbok_inspector/pages/database_browser.py

@@ -0,0 +1,139 @@
+import time
+from nicegui import ui, app
+
+from arbok_inspector.state import inspector
+from arbok_inspector.pages.run_view import run_page
+from arbok_inspector.widgets.update_day_selecter import update_day_selecter
+from arbok_inspector.widgets.build_run_selecter import build_run_selecter
+
+DAY_GRID_COLUMN_DEFS = [
+    {'headerName': 'Day', 'field': 'day'},
+]
+
+small_col_width = 30
+RUN_GRID_COLUMN_DEFS = [
+    {'headerName': 'Run ID', 'field': 'run_id', "width": small_col_width},
+    {'headerName': 'Name', 'field': 'name'},
+    {'headerName': 'Exp ID', 'field': 'exp_id', "width": small_col_width},
+    {'headerName': '# Results', 'field': 'result_counter', "width": small_col_width},
+    {'headerName': 'Started', 'field': 'run_timestamp', "width": small_col_width},
+    {'headerName': 'Finish', 'field': 'completed_timestamp', "width": small_col_width},
+]
+# RUN_PARAM_DICT = {
+#     'run_id': 'Run ID',
+#     'exp_id': 'Experiment ID',
+#     'result_counter': '# results',
+#     'run_timestamp': 'Started',
+#     'completed_timestamp': 'Completed',
+# }
+AGGRID_STYLE = 'height: 95%; min-height: 0;'
+EXPANSION_CLASSES = 'w-full p-0 gap-1 border border-gray-400 rounded-lg no-wrap items-start'
+
+@ui.page('/browser')
+async def database_browser_page():
+    """Database general page showing the selected database"""
+    _ = await ui.context.client.connected()
+    app.storage.general["avg_axis"] = 'iteration'
+    app.storage.general["result_keywords"] = None
+    app.storage.tab["avg_axis_input"] = None
+    app.storage.tab["result_keyword_input"] = None
+    offset_minutes = await ui.run_javascript('new Date().getTimezoneOffset()')
+    offset_hours = -float(offset_minutes) / 60
+    app.storage.general["timezone"] = offset_hours
+    print(f"TIMEZONE: UTC{offset_hours}")
+
+    grids = {'day': None, 'run': None}
+    with ui.column().classes('w-full h-screen'):
+        ui.add_head_html('<title>Arbok Inspector - Database general</title>')
+        with ui.row().classes('w-full items-center justify-between'):
+            ui.label('Arbok Inspector').classes('text-3xl font-bold mb-1')
+            
+            with ui.expansion('Database info and settings', icon='info', value=True)\
+                .classes(EXPANSION_CLASSES).props('expand-separator'):
+                build_database_info_section(grids)
+
+        with ui.row().classes('w-full flex-1'):
+            build_day_selecter(grids)
+            app.storage.tab['run_selecter'] = ui.column().classes('flex-1').classes('h-full')
+            build_run_selecter(target_day = None)
+
+def open_run_page(run_id: int):
+    # with ui.dialog() as dialog, ui.card():
+    #     ui.label(f'loading run {run_id} ...').classes(
+    #         'text-3xl font-bold mb-1')
+    # app.storage.general["run"] = Run(run_id)
+    # time.sleep(2)
+    # dialog.close()
+    shared_data['test'] = "hello"
+    app.storage.general["avg_axis"] = app.storage.tab["avg_axis_input"].value
+    app.storage.general["result_keywords"] = app.storage.tab["result_keyword_input"].value
+    print(f"Result Keywords:")
+    print(app.storage.general['result_keywords'])
+    ui.navigate.to(f'/run/{run_id}', new_tab=True)
+
+def build_database_info_section(grids):
+    """Build the database information and settings section."""
+    with ui.row().classes('w-full'):
+        build_info_section()
+        build_settings_section(grids)
+
+def build_info_section():
+    """Build the database information section."""
+    with ui.column().classes('w-1/3'):
+        ui.label('Database Information').classes('text-xl font-semibold mb-4')
+        if inspector.qcodes_database_path:
+            ui.label(f'Database Path: {str(inspector.qcodes_database_path)}').classes()
+        else:
+            ui.label('No database selected').classes('text-lg text-red-500')
+        
+def build_settings_section(grids):
+    """Build the database settings section."""
+    with ui.column().classes('w-1/2'):
+        with ui.row().classes('w-full'):
+            app.storage.tab["result_keyword_input"] = ui.input(
+                label = 'auto-plot keywords',
+                placeholder="e.g:\t\t[ ( 'Q1' , 'state' ), 'feedback' ]"
+                ).props('rounded outlined dense')\
+                .classes('w-full')\
+                .tooltip("""
+                    Selects all results that contain the specified keywords in their name.<br>
+                    Can be a single keyword (string) or a tuple of keywords.<br>
+                    The latter one requires all keywords to be present in the result name.<br>
+
+                    The given example would select all results that contain 'Q1' and 'state' in their name<br>
+                    or all results that contain 'feedback' in their name.
+                """).props('v-html')
+            app.storage.tab["avg_axis_input"] = ui.input(
+                label = 'average-axis keyword',
+                value = "iteration"
+                ).props('rounded outlined dense')\
+                .classes('w-full')
+        with ui.row().classes('w-full justify-start'):
+            ui.button(
+                text = 'Select New Database',
+                on_click=lambda: ui.navigate.to('/'),
+                color='purple').classes()
+            ui.button(
+                text = 'Reload',
+                on_click=lambda: update_day_selecter(grids['day']),
+                color = '#4BA701'
+                ).classes()
+
+def build_day_selecter(grids):
+    """Build the day selecter grid."""
+    with ui.column().style('width: 120px;').classes('h-full'):
+        grids['day'] = ui.aggrid(
+            {
+                'defaultColDef': {'flex': 1},
+                'columnDefs': DAY_GRID_COLUMN_DEFS,
+                'rowData': {},
+                'rowSelection': 'multiple',
+            },
+            theme = 'ag-theme-balham-dark')\
+            .classes('text-sm ag-theme-balham-dark')\
+            .style(AGGRID_STYLE)\
+            .on(
+                type = 'cellClicked',
+                handler = lambda event: build_run_selecter(event.args["value"])
+            )
+        update_day_selecter(grids['day'])

arbok_inspector/pages/greeter.py

@@ -0,0 +1,93 @@
+
+from nicegui import ui
+from arbok_inspector.state import inspector
+
+@ui.page('/')
+async def greeter_page() -> None:
+    """Main page that starts with file selection"""
+
+    # Show initial file selection dialog
+    with ui.dialog().classes('width=800px') as dialog:
+        dialog.props('persistent ') # width=800px max-width=90vw overflow-y-auto max-h-[90vh]
+
+        with ui.card().style('min-width: 300px; max-width: 1000px'):
+            inspector.initial_dialog = dialog
+            with ui.column().classes('items-center w-full justify-between max-w-5xl'):
+                ui.label('Welcome to Arbok Inspector 🐍🔎').classes(
+                    'text-4xl  text-center mb-6'
+                )
+                ui.label('Pick your database type:').classes(
+                    'text-2xl font-bold text-center mb-6'
+                )
+            with ui.row().classes('w-full gap-4 items-stretch'):
+                with ui.card().classes('flex-1'):
+                    build_qcodes_connection_section()
+
+                with ui.card().classes('flex-1 gap-4'):
+                    build_native_arbok_connection_section()
+    dialog.open()
+
+def build_qcodes_connection_section() -> None:
+    """Build the QCoDeS database connection section."""
+    ui.label('Please enter the path to your QCoDeS database file'
+            ).classes('text-body1 mb-4')
+    ui.image('https://microsoft.github.io/Qcodes/_images/qcodes_logo.png')
+    #ui.label('Database File Path').classes('text-subtitle2 mb-2')
+    path_input = ui.input(
+        label='Database file path',
+        placeholder='C:/path/to/your/database.db'
+    ).classes('w-full mb-2')
+    ui.button(
+        text = 'Load Database',
+        on_click=lambda: inspector.connect_to_qcodes_database(path_input),
+        icon='folder_open',
+        color='purple').classes('mb-4 w-full')
+    ui.separator()
+    ui.label('Supported formats: .db, .sqlite, .sqlite3'
+            ).classes('text-caption text-grey')
+
+def build_native_arbok_connection_section() -> None:
+    # ui.label('Enter credentials to your native postgresql database and minio server'
+    #         ).classes('text-body1 mb-4')
+    # ui.markdown('Visit [arbok-database](https://github.com/andncl/arbok_database) for more info.')
+    ui.markdown(
+        'Enter credentials to your native PostgreSQL database and MinIO server. '
+        'Visit [arbok-database](https://github.com/andncl/arbok_database) for more info.' 
+    ).classes('text-body1 mb-4')
+    database_url = ui.input(
+        label='Database address',
+        placeholder='"postgresql+psycopg2://<username>:<password>@<host>:<port>/<database>"'
+    ).classes('w-full mb-2')
+
+    minio_url = ui.input(
+        label='MiniO address',
+        value='http://localhost:9000',
+    ).classes('w-full mb-2')
+
+    minio_user = ui.input(
+        label='MiniO username',
+        value='minioadmin'
+    ).classes('w-full mb-2')
+
+    minio_password = ui.input(
+        label='MiniO password',
+        value='minioadmin',
+        password=True
+    ).classes('w-full')
+
+    minio_bucket = ui.input(
+        label='MiniO bucket',
+        placeholder='dev',
+    ).classes('w-full')
+
+    ui.button(
+        text = 'Connect Database and bucket',
+        on_click=lambda: inspector.connect_to_arbok_database(
+            database_url.value,
+            minio_url.value,
+            minio_user.value,
+            minio_password.value,
+            minio_bucket.value
+            ),
+        icon='folder_open',
+        color='#4BA701').classes('mb-4 w-full')