Merge branch 'main' of https://github.com/ni/nipanel-python

Author: Dilmi Wickramanayake

.github/workflows/check_docs.yml

@@ -12,10 +12,10 @@ jobs:
       - name: Check out repo
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Set up Python
-        uses: ni/python-actions/setup-python@a3bfe1baa6062fd6157683651d653d527967d4d4 # v0.3.1
+        uses: ni/python-actions/setup-python@5286c12d65d90b2ea738bd57d452dc4366497581 # v0.4.1
         id: setup-python
       - name: Set up Poetry
-        uses: ni/python-actions/setup-poetry@a3bfe1baa6062fd6157683651d653d527967d4d4 # v0.3.1
+        uses: ni/python-actions/setup-poetry@5286c12d65d90b2ea738bd57d452dc4366497581 # v0.4.1
       - name: Check for lock changes
         run: poetry check --lock
       - name: Cache virtualenv (with docs)

.github/workflows/check_nipanel.yml

@@ -12,10 +12,10 @@ jobs:
       - name: Check out repo
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Set up Python
-        uses: ni/python-actions/setup-python@a3bfe1baa6062fd6157683651d653d527967d4d4 # v0.3.1
+        uses: ni/python-actions/setup-python@5286c12d65d90b2ea738bd57d452dc4366497581 # v0.4.1
         id: setup-python
       - name: Set up Poetry
-        uses: ni/python-actions/setup-poetry@a3bfe1baa6062fd6157683651d653d527967d4d4 # v0.3.1
+        uses: ni/python-actions/setup-poetry@5286c12d65d90b2ea738bd57d452dc4366497581 # v0.4.1
       - name: Check for lock changes
         run: poetry check --lock
       - name: Cache virtualenv

.github/workflows/run_unit_tests.yml

@@ -19,12 +19,12 @@ jobs:
       - name: Check out repo
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Set up Python
-        uses: ni/python-actions/setup-python@a3bfe1baa6062fd6157683651d653d527967d4d4 # v0.3.1
+        uses: ni/python-actions/setup-python@5286c12d65d90b2ea738bd57d452dc4366497581 # v0.4.1
         id: setup-python
         with:
           python-version: ${{ matrix.python-version }}
       - name: Set up Poetry
-        uses: ni/python-actions/setup-poetry@a3bfe1baa6062fd6157683651d653d527967d4d4 # v0.3.1
+        uses: ni/python-actions/setup-poetry@5286c12d65d90b2ea738bd57d452dc4366497581 # v0.4.1
       - name: Cache virtualenv
         uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
         with:

CONTRIBUTING.md

@@ -56,15 +56,14 @@ start docs\_build\index.html
 
 ## Running examples
 
-1. First, run the PythonPanelService (not part of this repo, provided seperately)
-2. Run the command `poetry run python examples/hello/hello.py`
-3. Open http://localhost:42001/panel-service/panels/hello_panel/ in your browser
-4. If there is an error about missing imports (especially nipanel), execute this
-   command (from the nipanel-python directory) to install the dependencies into the venv: 
-   `%localappdata%\Temp\python_panel_service_venv\Scripts\python.exe -m pip install .\[examples,dev]`,
-    then restart the PythonPanelService and re-run hello.py.
-
-You can see all running panels (and stop them) at: http://localhost:42001/panel-service/
+1. Run the **PythonPanelService** (not part of this repo, provided seperately)
+2. `poetry install --with examples` to get the dependencies needed for the examples
+3. Run the examples with these command(s):
+    - `poetry run python examples/hello/hello.py`
+    - `poetry run python examples/all_types/all_types.py`
+    - `poetry run python examples/simple_graph/simple_graph.py`
+    - `poetry run python examples/nidaqmx/nidaqmx_continuous_analog_input.py` (requires real or simulated devices)
+4. Open http://localhost:42001/panel-service/ in your browser, which will show all running panels
 
 # Debugging on the streamlit side
 

examples/all_types/all_types_panel.py

@@ -5,11 +5,11 @@
 
 import nipanel
 
-panel = nipanel.get_panel_accessor()
 
 st.set_page_config(page_title="All Types Example", page_icon="📊", layout="wide")
 st.title("All Types Example")
 
+panel = nipanel.get_panel_accessor()
 for name in all_types_with_values.keys():
     col1, col2 = st.columns([0.4, 0.6])
 

examples/hello/hello_panel.py

@@ -4,8 +4,9 @@
 
 import nipanel
 
-panel = nipanel.get_panel_accessor()
 
 st.set_page_config(page_title="Hello World Example", page_icon="📊", layout="wide")
 st.title("Hello World Example")
+
+panel = nipanel.get_panel_accessor()
 st.write(panel.get_value("hello_string", ""))

examples/nidaqmx/nidaqmx_continuous_analog_input.py

@@ -10,6 +10,7 @@
 panel_script_path = Path(__file__).with_name("nidaqmx_continuous_analog_input_panel.py")
 panel = nipanel.create_panel(panel_script_path)
 
+# How to use nidaqmx: https://nidaqmx-python.readthedocs.io/en/stable/
 with nidaqmx.Task() as task:
     task.ai_channels.add_ai_voltage_chan("Dev1/ai0")
     task.ai_channels.add_ai_thrmcpl_chan("Dev1/ai1")
@@ -18,10 +19,13 @@
     )
     panel.set_value("sample_rate", task._timing.samp_clk_rate)
     task.start()
+    print(f"Panel URL: {panel.panel_url}")
     try:
-        print(f"\nPress Ctrl + C to stop")
+        print(f"Press Ctrl + C to stop")
         while True:
-            data = task.read(number_of_samples_per_channel=1000)
+            data = task.read(
+                number_of_samples_per_channel=1000  # pyright: ignore[reportArgumentType]
+            )
             panel.set_value("voltage_data", data[0])
             panel.set_value("thermocouple_data", data[1])
     except KeyboardInterrupt:

examples/nidaqmx/nidaqmx_continuous_analog_input_panel.py

@@ -5,8 +5,8 @@
 
 import nipanel
 
-panel = nipanel.get_panel_accessor()
 
+st.set_page_config(page_title="NI-DAQmx Example", page_icon="📈", layout="wide")
 st.title("Analog Input - Voltage and Thermocouple in a Single Task")
 voltage_tab, thermocouple_tab = st.tabs(["Voltage", "Thermocouple"])
 
@@ -21,13 +21,15 @@
     unsafe_allow_html=True,
 )
 
+panel = nipanel.get_panel_accessor()
 thermocouple_data = panel.get_value("thermocouple_data", [0.0])
 voltage_data = panel.get_value("voltage_data", [0.0])
 
-sample_rate = panel.get_value("sample_rate", 0)
+sample_rate = panel.get_value("sample_rate", 0.0)
 
 st.header("Voltage & Thermocouple")
 voltage_therm_graph = {
+    "animation": False,
     "tooltip": {"trigger": "axis"},
     "legend": {"data": ["Voltage (V)", "Temperature (C)"]},
     "xAxis": {
@@ -64,7 +66,7 @@
         },
     ],
 }
-st_echarts(options=voltage_therm_graph, height="400px")
+st_echarts(options=voltage_therm_graph, height="400px", key="voltage_therm_graph")
 
 voltage_tab.header("Voltage")
 with voltage_tab:

examples/simple_graph/simple_graph.py

@@ -32,7 +32,7 @@
 
         # Slowly vary the frequency for a more dynamic visualization
         frequency = 1.0 + 0.5 * math.sin(time.time() / 5.0)
-        time.sleep(1)
+        time.sleep(0.1)
 
 except KeyboardInterrupt:
     print("Exiting...")

examples/simple_graph/simple_graph_panel.py

@@ -5,11 +5,11 @@
 
 import nipanel
 
-panel = nipanel.get_panel_accessor()
 
 st.set_page_config(page_title="Simple Graph Example", page_icon="📈", layout="wide")
 st.title("Simple Graph Example")
 
+panel = nipanel.get_panel_accessor()
 time_points = panel.get_value("time_points", [0.0])
 sine_values = panel.get_value("sine_values", [0.0])
 amplitude = panel.get_value("amplitude", 1.0)
@@ -56,4 +56,4 @@
 }
 
 # Display the chart
-st_echarts(options=options, height="400px")
+st_echarts(options=options, height="400px", key="graph")