fix(jupyter): more support

.gitignore

@@ -1,7 +1,7 @@
 .DS_Store
 node_modules
 .venv*
-
+.ipynb_checkpoints
 
 # local env files
 .env.local

documentation/jupyter/README-osx.md

@@ -0,0 +1,31 @@
+## Running ParaView within Jupyter
+
+### Install packages
+
+```bash
+python3.9 -m venv .venv
+source .venv/bin/activate
+pip install -U pip
+pip install pv-visualizer
+pip install jupyterlab
+```
+
+### Run example
+
+```bash
+export PYTHONPATH=/Applications/ParaView-5.10.1.app/Contents/Python
+export DYLD_LIBRARY_PATH=/Applications/ParaView-5.10.1.app/Contents/Libraries
+source .venv/bin/activate
+jupyter-lab
+```
+
+Then in a cell
+
+```python
+from pv_visualizer.app.jupyter import show
+show()
+```
+
+## Running Jupyter within ParaView
+
+This path is not yet working.

documentation/jupyter/example/.ipynb_checkpoints/test-checkpoint.ipynb

@@ -0,0 +1,63 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "97651108-21d4-48dc-a322-4af0b0c8790a",
+   "metadata": {},
+   "source": [
+    "Only run next cell to get the ENV variable to set before starting Jupyterlab after having defined TRAME_PARAVIEW=/ParaView.app/"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "383795b4-4603-4732-90a8-d2f2edbf5537",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import trame.env.paraview"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e9d1072c-9326-48f1-bdab-26fe3331c658",
+   "metadata": {},
+   "source": [
+    "Just run the following section once you've exported __PYTHONPATH__ and __DYLD_LIBRARY_PATH__ for mac"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "ae9f4e67-b4ab-4ea0-98e1-6c4958957b06",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pv_visualizer.app.jupyter import show\n",
+    "\n",
+    "show()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.13"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

documentation/jupyter/example/test.ipynb

@@ -0,0 +1,63 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "97651108-21d4-48dc-a322-4af0b0c8790a",
+   "metadata": {},
+   "source": [
+    "Only run next cell to get the ENV variable to set before starting Jupyterlab after having defined TRAME_PARAVIEW=/ParaView.app/"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "383795b4-4603-4732-90a8-d2f2edbf5537",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import trame.env.paraview"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e9d1072c-9326-48f1-bdab-26fe3331c658",
+   "metadata": {},
+   "source": [
+    "Just run the following section once you've exported __PYTHONPATH__ and __DYLD_LIBRARY_PATH__ for mac"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "ae9f4e67-b4ab-4ea0-98e1-6c4958957b06",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pv_visualizer.app.jupyter import show\n",
+    "\n",
+    "show()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.13"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

pv_visualizer/app/engine/__init__.py

@@ -1,28 +1,28 @@
 r"""
 Define your classes and create the instances that you need to expose
 """
+import logging
 from .reactions import register_reactions
 from .proxymanager import ParaviewProxyManager
 from paraview import simple
 
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+
 # ---------------------------------------------------------
 # Methods
 # ---------------------------------------------------------
 
 
-def initialize(server):
-    args, _ = server.cli.parse_known_args()
-    #
+def initialize(server, plugins=None):
     pxm = ParaviewProxyManager()
     pxm.set_server(server)
 
-    plugins = args.plugins.split(",") if args.plugins else []
     if plugins:
-        print("\nLoading ParaView plugins:")
+        logger.info("\nLoading ParaView plugins:")
         for plugin in plugins:
-            print(f"  - {plugin}")
+            logger.info(f"  - {plugin}")
             simple.LoadDistributedPlugin(plugin)
-        print()
 
     # Bind methods to controller + trigger name
     register_reactions(server)

pv_visualizer/app/engine/proxymanager/core.py

@@ -1,4 +1,5 @@
 import os
+import logging
 from pathlib import Path
 
 from trame.app.singleton import Singleton
@@ -15,6 +16,9 @@
 
 PENDING = True
 
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+
 # -----------------------------------------------------------------------------
 # PV <=> Simput proxy state exchange
 # -----------------------------------------------------------------------------
@@ -80,7 +84,7 @@ def fetch(simput_proxy):
             pv_property = paraview.unwrap(pv_proxy.GetProperty(name))
 
             if pv_property is None:
-                # print(f"No property {name} for proxy {pv_proxy.GetXMLName()}")
+                # logger.info(f"No property {name} for proxy {pv_proxy.GetXMLName()}")
                 continue
 
             # Custom handling for proxy
@@ -108,7 +112,7 @@ def fetch(simput_proxy):
                 else:
                     value = pv_property.GetElement(0)
 
-                # print(f"{property_class}({size})::{name} = {value} ({type(value)})")
+                # logger.info(f"{property_class}({size})::{name} = {value} ({type(value)})")
                 simput_proxy.set_property(name, value)
 
         simput_proxy.commit()
@@ -148,14 +152,14 @@ def update(simput_proxy, *property_names):
     @staticmethod
     def before_delete(simput_proxy):
         pv_proxy = simput_proxy.object
-        print(
+        logger.info(
             "Deleting PV proxy",
             simput_proxy.id,
             pv_proxy.GetGlobalIDAsString(),
             pv_proxy.GetReferenceCount(),
         )
         simple.Delete(pv_proxy)
-        print("simple.Delete() => done", pv_proxy.GetReferenceCount())
+        logger.info("simple.Delete() => done", pv_proxy.GetReferenceCount())
 
 
 # -----------------------------------------------------------------------------
@@ -345,7 +349,7 @@ def _proxy_extract_sub(
                     for i in range(size):
                         s_proxy = prop.GetProxy(i)
                         if s_proxy is not None:
-                            # print("add sub proxy", s_proxy.GetClassName())
+                            # logger.info("add sub proxy", s_proxy.GetClassName())
                             list_to_fill.append(s_proxy)
 
         return list_to_fill

pv_visualizer/app/engine/proxymanager/decorators.py

@@ -7,6 +7,10 @@
 ./Qt/ApplicationComponents/pqSpreadSheetViewDecorator.cxx
 ./Qt/ApplicationComponents/pqAnimationShortcutDecorator.cxx
 """
+import logging
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
 
 
 class AdvancedDecorator:
@@ -406,4 +410,4 @@ def get_decorator(proxy, config):
     if _type in globals():
         return globals()[_type](proxy, config)
 
-    print(f"~~~ no decorator for {_type} ~~~")
+    logger.info(f"~~~ no decorator for {_type} ~~~")

pv_visualizer/app/engine/proxymanager/definitions.py

@@ -1,3 +1,4 @@
+import logging
 import yaml
 import json
 import base64
@@ -8,6 +9,8 @@
 
 from paraview import servermanager
 
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
 
 # -----------------------------------------------------------------------------
 # Spec key
@@ -184,7 +187,7 @@ def property_yaml(property):
     # currently simput don't properly manage list of proxy as property...
     # i.e. views.RenderView.Representations
     if property_definition["type"] == "proxy" and size != 1:
-        print(
+        logger.info(
             "Skip multi-proxy property",
             property.GetParent().GetXMLName(),
             property.GetXMLName(),
@@ -246,12 +249,12 @@ def should_skip(property):
     #     return True
 
     if property.GetIsInternal():
-        # print("skip internal")
+        # logger.info("skip internal")
         return True
 
     visibility = property.GetPanelVisibility()
     if visibility in ["never"]:
-        # print("skip visibility", visibility)
+        # logger.info("skip visibility", visibility)
         return True
 
     if property.IsA("vtkSMProxyProperty"):
@@ -357,7 +360,7 @@ def proxy_ui(proxy):
         # Skip custom widget until they get implemented
         if domains.PANEL_WIDGETS.get(group.GetPanelWidget()) == "skip":
             group_key = "skip"
-            # print(f"> Skip {group.GetPanelWidget()}")
+            # logger.info(f"> Skip {group.GetPanelWidget()}")
 
         # Create group
         xml_group = xml_groups.get(group_key)

pv_visualizer/app/engine/proxymanager/domain_helpers.py

@@ -1,5 +1,9 @@
 import sys
 from . import paraview
+import logging
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
 
 # -----------------------------------------------------------------------------
 # General util functions
@@ -153,6 +157,6 @@ def domain_unknown(domain):
 
     if class_name not in UNKNOWN_DOMAINS:
         UNKNOWN_DOMAINS.add(class_name)
-        print("domain_unknown::class", class_name)
+        logger.info("domain_unknown::class", class_name)
 
     return {}