Updated notebook text and resized the images (Xilinx#397)

kshitijzutshi · Jul 31, 2017 · af02cea · af02cea
1 parent d9c53da
commit af02cea
Show file tree

Hide file tree

Showing 14 changed files with 8 additions and 9 deletions.
diff --git a/boards/Pynq-Z1/logictools/notebooks/boolean_generator.ipynb b/boards/Pynq-Z1/logictools/notebooks/boolean_generator.ipynb
@@ -86,8 +86,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Step 4: Run the boolean generator verify operation\n",
-    "__Note: Unused on-board LEDs `LD0`, `LD1` and `LD3` are switched ON by default.__"
+    "### Step 4: Run the boolean generator verify operation"
    ]
   },
   {

diff --git a/boards/Pynq-Z1/logictools/notebooks/fsm_generator.ipynb b/boards/Pynq-Z1/logictools/notebooks/fsm_generator.ipynb
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/boolean_generator.png b/boards/Pynq-Z1/logictools/notebooks/images/boolean_generator.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/fsm_spec_format.png b/boards/Pynq-Z1/logictools/notebooks/images/fsm_spec_format.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/fsm_wiring.png b/boards/Pynq-Z1/logictools/notebooks/images/fsm_wiring.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/logictools_block_diagram.png b/boards/Pynq-Z1/logictools/notebooks/images/logictools_block_diagram.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/pattern_generator_wiring.png b/boards/Pynq-Z1/logictools/notebooks/images/pattern_generator_wiring.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/waveform_output_dictionary.png b/boards/Pynq-Z1/logictools/notebooks/images/waveform_output_dictionary.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/waveform_spec_format0.png b/boards/Pynq-Z1/logictools/notebooks/images/waveform_spec_format0.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/waveform_spec_format1.png b/boards/Pynq-Z1/logictools/notebooks/images/waveform_spec_format1.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/waveform_spec_format2.png b/boards/Pynq-Z1/logictools/notebooks/images/waveform_spec_format2.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/images/waveform_spec_format3.png b/boards/Pynq-Z1/logictools/notebooks/images/waveform_spec_format3.png
diff --git a/boards/Pynq-Z1/logictools/notebooks/pattern_generator_and_trace_analyzer.ipynb b/boards/Pynq-Z1/logictools/notebooks/pattern_generator_and_trace_analyzer.ipynb
@@ -98,7 +98,7 @@
    "metadata": {},
    "source": [
     "### Step 3: Instantiate the pattern generator and trace analyzer objects\n",
-    "Users can choose whether to use the trace analyzer with the `trace()` method.    \n",
+    "Users can choose whether to use the trace analyzer by calling the `trace()` method.    \n",
     "The analyzer can be set to trace a specific number of samples using, `num_analyzer_samples` argument."
    ]
   },
@@ -160,7 +160,7 @@
     "### Step 6: Run and display waveform\n",
     "\n",
     "The ` run()` method will execute all the samples, `show_waveform()` method is used to display the waveforms.   \n",
-    "Alternatively, we can also use `step()` method to single step the pattern. It is shown in a separate example notebook."
+    "Alternatively, we can also use `step()` method to single step the pattern."
    ]
   },
   {
@@ -193,7 +193,7 @@
    "metadata": {},
    "source": [
     "### Step 7: Stop the pattern generator\n",
-    "Calling `stop()` will clear the logic values on output pins; however, the waveform will be recorded locally in the PG instance."
+    "Calling `stop()` will clear the logic values on output pins; however, the waveform will be recorded locally in the pattern generator instance."
    ]
   },
   {

diff --git a/boards/Pynq-Z1/logictools/notebooks/wavedrom_tutorial.ipynb b/boards/Pynq-Z1/logictools/notebooks/wavedrom_tutorial.ipynb
@@ -6,9 +6,9 @@
    "source": [
     "# `logictools` WaveDrom Tutorial\n",
     "[WaveDrom](http://wavedrom.com) is a tool for rendering digital timing waveforms. The waveforms are defined in a simple textual format.   \n",
-    "The notebook will show how to render digital waveforms using the pynq library.\n",
+    "This notebook will show how to render digital waveforms using the pynq library.\n",
     "\n",
-    "The __`logictools`__ overlay uses WaveDrom format to specify and generate real signals on the board.\n",
+    "The __`logictools`__ overlay uses the same format as WaveDrom to specify and generate real signals on the board.\n",
     "\n",
     "A full tutorial of WaveDrom can be found [here](http://wavedrom.com/tutorial.html)"
    ]
@@ -35,7 +35,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "A simple function to add wavedrom diagrams into an ipython notebook. It utilises the wavedrom java script library.  \n",
+    "A simple function to add wavedrom diagrams into an jupyter notebook. It utilises the wavedrom java script library.  \n",
     "\n",
     "<font color=\"DodgerBlue\">**Example usage:**</font> \n",
     "```python\n",
@@ -220,7 +220,7 @@
     "* The Trace Analyzer is an input-only block that captures and records all the IO signals. These signals may be outputs driven by the generators or inputs to the PL that are driven by external circuits. The Trace Analyzer allows us to verify that the output signals we have specified from the generators are being applied correctly. It also allows us to debug and analyze the opearion of the external interface. \n",
     "   \n",
     "   \n",
-    "* The signals generated or captured by both the blocks can be displayed in the notebook by populating the WaveJSON dictionary that we have seen in this notebook. Users can access this dictionary through the provided API at to extend or modify the waveform with special annotations.\n",
+    "* The signals generated or captured by both the blocks can be displayed in the notebook by populating the WaveJSON dictionary that we have seen in this notebook. Users can access this dictionary through the provided API to extend or modify the waveform with special annotations.\n",
     "   \n",
     "   \n",
     "* we use a subset of the wave tokens that are allowed by WaveDrom to specify the waveforms for the Pattern Generator. However, users can call the `draw_waveform()` method on the dictionary populated by the Trace Analyzer to extend and modify the dictionary with annotations.\n",