From ec9da49e93a5e2361efa4a6918b4a18444910c9b Mon Sep 17 00:00:00 2001 From: Jonathan Gutow Date: Thu, 20 Apr 2023 15:59:53 -0500 Subject: [PATCH] Binder demo updates --- usage_examples/JupyterPiDAQ Demo.ipynb | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/usage_examples/JupyterPiDAQ Demo.ipynb b/usage_examples/JupyterPiDAQ Demo.ipynb index cedb25d..9191a34 100644 --- a/usage_examples/JupyterPiDAQ Demo.ipynb +++ b/usage_examples/JupyterPiDAQ Demo.ipynb @@ -36,7 +36,7 @@ "id": "3b12e468", "metadata": {}, "source": [ - "When setup is done a new menu appears at the end of the toolbar. The menu options insert jupyter widget based GUIs for starting a run, displaying the data as tables or plots, or composing an expression to calculate a new column in a DataFrame." + "In the classic Jupyter notebook environment when setup is done a new menu appears at the end of the toolbar. The menu options insert jupyter widget based GUIs for starting a run, displaying the data as tables or plots, or composing an expression to calculate a new column in a DataFrame. Currently, this convenience menu does not work in the Jupyter lab environment." ] }, { @@ -45,9 +45,9 @@ "metadata": {}, "source": [ "## Collecting Data\n", - "Collect some data by selecting this text/markdown cell and the selecting \"Insert new run after selection...\" from the \"DAQ commands\" menu. That should insert a cell immediately below this one with widgets for setting up the data acquisition. The widgets look like: \n", + "Collect some data by selecting this text/markdown cell and the selecting \"Insert new run after selection...\" from the \"DAQ commands\" menu. That should insert a cell immediately below this one containing the command to generate the collection setup GUI. To just type the command use `Run(\"Name_for_Run\")`, where you replace Name_for_Run with the name you want for the run. When you run the cell you should see the GUI: \n", "\n", - "I suggest selecting at least two traces and setting the data collection rate to the maximum of 3 Hz. Then you will not have to wait long to collect a significant amount of data to look at. When the parameters are what you want, click on \"Set Parameters\". This will lock in the parameters and display the button for starting the data collection and the graph the data will be displayed in.\n", + "I suggest selecting at least two traces and setting the data collection rate to between 3 and 5 Hz. Then you will not have to wait long to collect a significant amount of data to look at. When the parameters are what you want, click on \"Set Parameters\". This will lock in the parameters and display the button for starting the data collection and the graph the data will be displayed in.\n", "\n", "You may want to do a few runs to experiment with the options." ] @@ -58,8 +58,8 @@ "metadata": {}, "source": [ "When a run is stopped two things happen:\n", - " 1. The data is saved to a .csv file so that it could be loaded into another notebook for more analysis.\n", - " 1. The plotly widget state is saved to the notebook. This means that the interactive graph will be available the next time the notebook is open. This has the side-effect of requiring the user to trust the notebook the next time they open it, because it leaves JS code injected into the notebook." + " 1. The data is saved to an .html file so that it could be loaded into another notebook for more analysis or reloaded into this notebook, if the cell output is deleted.\n", + " 1. The display is reset to remove run controls." ] }, { @@ -72,7 +72,7 @@ "Selecting the \"Show data in table...\" option in the menu will insert a cell immediately below the currently selected cell displaying a widget in which you can select which data set to display.\n", "### As a scatter or line plot\n", "Selecting the \"Insert new plot after selection...\" option in the menu will insert two cells immediately below the currently selected cell. The first cell will be used to generate a GUI to lead you through creation of the code to generate the plot. The second cell is where the plot creation code is generated. The first tab of this GUI looks like:\n", - " Once the plot is created the cell with the GUI will be automatically deleted." + " In the classic Jupyter notebook, once the plot is created the cell with the GUI will be automatically deleted." ] }, { @@ -83,7 +83,7 @@ "## Calculating a New Column\n", "Selecting \"Calculate new column...\" from the menu will add two cells immediately below the selected cell. The first cell will create the GUI to lead you through creation of the code to calculate the new column. The second cell is where the code is built. The first tab of the GUI looks like:\n", " \n", - "The cell containing the GUI will be deleted after doing the calculation." + "In the classic Jupyter notebook the cell containing the GUI will be deleted after doing the calculation." ] }, { @@ -111,7 +111,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.8" + "version": "3.11.3" } }, "nbformat": 4,