Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions examples/all_types/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
## All Types Example

This is an example for `nipanel` that demonstrates all supported data types
This is an example for `nipanel` that demonstrates all supported data types.

### Feature

- Demonstrates support for all data types
- Demonstrates all supported data types

### Required Software

- Python 3.9 or later

### Usage

Run `poetry run python examples/all_types/all_types.py`
```pwsh
poetry install --with examples
poetry run python examples/all_types/all_types.py
```
7 changes: 5 additions & 2 deletions examples/hello/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Hello

This is a simple nipanel example that displays a Streamlit app.
This is a simple `nipanel` example that displays a Streamlit app.

### Feature

Expand All @@ -12,4 +12,7 @@ This is a simple nipanel example that displays a Streamlit app.

### Usage

Run `poetry run python examples/hello/hello.py`
```pwsh
poetry install --with examples
poetry run python examples/hello/hello.py
```
8 changes: 5 additions & 3 deletions examples/nidaqmx/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Prerequisites
Prerequisites
===============
Requires a Physical or Simulated Device : https://github.com/ni/nidaqmx-python/blob/master/README.rst (Getting Started Section)

Expand All @@ -16,5 +16,7 @@ This is a nipanel example that displays an interactive Streamlit app and updates

### Usage

Run `poetry run examples/nidaqmx/nidaqmx_continuous_analog_input.py`

```pwsh
poetry install --with examples
poetry run examples/nidaqmx/nidaqmx_continuous_analog_input.py
```
11 changes: 7 additions & 4 deletions examples/niscope/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
Prerequisites
Prerequisites
===============
Requires a Physical or Simulated Device. Refer to the [Getting Started Section](https://github.com/ni/nidaqmx-python/blob/master/README.rst) to learn how to create a simulated device. This example uses NI oscilloscopes/digitizers, which have the module numbering pattern _51xx_. One example is NI PXIe-5114.

## Sample

This is a nipanel example that displays an interactive Streamlit app and updates and fetches data from device.

### Feature

Script demonstrates NIScope waveform data getting continuously acquired.
Script demonstrates NIScope waveform data getting continuously acquired.
- Supports various data types

### Required Software
Expand All @@ -16,5 +17,7 @@ Script demonstrates NIScope waveform data getting continuously acquired.

### Usage

Run `poetry run examples/niscope/niscope_ex_fetch_forever.py`

```pwsh
poetry install --with examples
poetry run examples/niscope/niscope_ex_fetch_forever.py
```
7 changes: 5 additions & 2 deletions examples/performance_checker/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Performance checker Example

This example measures the performance of a stremlit panel with a graph.
This example measures the performance of a streamlit panel with a graph.

## Features

Expand All @@ -15,4 +15,7 @@ This example measures the performance of a stremlit panel with a graph.

### Usage

Run `poetry run python examples/performance_checker/performance_checker.py`
```pwsh
poetry install --with examples
poetry run python examples/performance_checker/performance_checker.py
```
7 changes: 5 additions & 2 deletions examples/simple_graph/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Simple Graph Example

This example demonstrates using nipanel with Streamlit to display a dynamic sine wave using the `streamlit-echarts` library.
This example demonstrates using `nipanel` with Streamlit to display a dynamic sine wave using the `streamlit-echarts` library.

## Features

Expand All @@ -15,4 +15,7 @@ This example demonstrates using nipanel with Streamlit to display a dynamic sine

### Usage

Run `poetry run python examples/simple_graph/simple_graph.py`
```pwsh
poetry install --with examples
poetry run python examples/simple_graph/simple_graph.py
```