Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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/notebooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

The Jupyter Notebooks contained within the sub-directories of this directory demonstrate usage and functionality of the Measurement Data Store Python API.

These notebooks make use of the main Python environment / kernel of `ni.datastore`. To execute the code in these notebooks, first execute the following command from the repo's root directory:
These notebooks use a dedicated Python environment. To create it, execute the following commands from the repository root:

```sh
```powershell
cd examples\notebooks
poetry install
```

After executing this command, select the environment that it creates as the kernel to use for executing any of the provided notebooks that is of interest to you.
This creates one environment containing the dependencies used by all of the notebooks, including the local
`ni.datastore` package and the notebook utilities. Select the environment that it creates as the kernel
when executing any notebook in this directory.
4 changes: 2 additions & 2 deletions examples/notebooks/alias/alias.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "ni-datastore-py3.14",
"display_name": ".venv",
"language": "python",
"name": "python3"
},
Expand All @@ -239,7 +239,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.14.0"
"version": "3.13.15"
}
},
"nbformat": 4,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "ni-datastore-py3.10",
"display_name": ".venv",
"language": "python",
"name": "python3"
},
Expand All @@ -216,7 +216,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.11"
"version": "3.13.15"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion examples/notebooks/overview/publish_measurement.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.7"
"version": "3.13.15"
}
},
"nbformat": 4,
Expand Down
3,440 changes: 3,440 additions & 0 deletions examples/notebooks/poetry.lock

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions examples/notebooks/poetry.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[virtualenvs]
in-project = true
2 changes: 1 addition & 1 deletion examples/notebooks/publish/publish_batch.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.2"
"version": "3.13.15"
}
},
"nbformat": 4,
Expand Down
23 changes: 23 additions & 0 deletions examples/notebooks/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[project]
name = "datastore_notebooks"
version = "1.0.0"
description = "Jupyter notebooks demonstrating the NI Measurement Data Store Python API"
readme = "README.md"
requires-python = ">=3.10,<4.0"
dynamic = ["dependencies"]

[tool.poetry]
requires-poetry = ">=2.1,<3.0"
package-mode = false

[tool.poetry.dependencies]
python = "^3.10"
ni-datastore = { path = "../..", develop = true }
datastore-utilities = { path = "../../utilities", develop = true }
plotly = ">=5.0"
jupyter = ">=1.1.1"
jupyterlab = ">=4.6.4"

[build-system]
requires = ["poetry-core>=1.8"]
build-backend = "poetry.core.masonry.api"
2 changes: 1 addition & 1 deletion examples/notebooks/query/publish_sample_data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.7"
"version": "3.13.15"
}
},
"nbformat": 4,
Expand Down
4 changes: 2 additions & 2 deletions examples/notebooks/query/query_measurements.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "ni-datastore-py3.10",
"display_name": ".venv",
"language": "python",
"name": "python3"
},
Expand All @@ -248,7 +248,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.11"
"version": "3.13.15"
}
},
"nbformat": 4,
Expand Down
4 changes: 2 additions & 2 deletions examples/notebooks/query/query_metadata.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "ni-datastore-py3.10",
"display_name": ".venv",
"language": "python",
"name": "python3"
},
Expand All @@ -416,7 +416,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.11"
"version": "3.13.15"
}
},
"nbformat": 4,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.7"
"version": "3.13.15"
}
},
"nbformat": 4,
Expand Down
Loading
Loading