Difference between revisions of "CW5"

Installing ChipWhisperer 5 and Jupyter

For instructions on how to install ChipWhisperer 5 and Jupyter, please see our page V5:Installing_ChipWhisperer.

Running Jupyter

Once you have ChipWhisperer/Jupyter installed and have the associated hardware, you should be all set to run ChipWhisperer 5! To run ChipWhisperer 5 via a Virtual Machine, open your VM and start the ChipWhisperer Jupyter image. Once the Virtual Machine is booted, open either Firefox or Chrome. Go to your address bar and type in localhost:8888. A page requesting a password should appear. Enter your password that you set for Jupyter during installation and you'll be taken to the Jupyter homescreen.

For a native installation, open a Bash-like shell terminal (for Windows users, Git Bash will work fine) and navigate to where you installed ChipWhisperer. In Bash, run $ jupyter notebook. You should be taken to the Jupyter homescreen.

Running Tutorials

Starting with ChipWhisperer v5.0, tutorials have been moved from the wiki into Jupyter Notebooks. Use Jupyter's file browser to navigate to software/Jupyter, which contains all of the tutorial notebooks. If you'd like to see our suggested completion order, you can open !!Suggested_Completion_Order!!.ipynb. Once you've decided which tutorial to run, open the tutorial via Jupyter.

Once you've got a notebook open, you'll find a combination of rich text and Python (and few special blocks, like the %%bash blocks. Near the top of the page, you'll find a special Python block with #Parameters in it. This block is used to select which scope (via SCOPETYPE) as well as which target (via PLATFORM) you'll be using for the tutorial. Make sure to edit these parameters for which hardware you're using. A list of common SCOPETYPE and PLATFORM values can be found here (not yet available).

Now that this setup is complete, you can start actually running through the tutorials. To run a block, click on the block and make sure it's highlighted (the block should have either a green or blue outline around it), then click the >| Run button on the toolbar at the top of the screen. This will run the code inside of the block and move to the next one. Run the rest of the code block in the tutorial (all tutorials are designed to be able to be run with minimal modifications to the Python code).

Special Blocks

While running tutorials, you will come across special blocks. For ChipWhisperer's notebooks, the two most common ones are %%bash and %run. The %%bash blocks run the following lines using the Bash-like shell you used to open Jupyter with and are typically used for building firmware. The %run blocks, on the other hand, are used to run other Jupyter notebooks. This avoids duplicating some common blocks across tutorials. To find these notebooks, follow the path specified after the %run command. For example, if you see a block with %run "Helper_Scripts/Setup.ipynb", you can find that file at software/Jupyter/Helper_Scripts/Setup.ipynb.

Editing Blocks

To edit code blocks, simple click on the text portion of the block and begin making your changes. You'll know if you're in edit mode for a block because it will be highlighted in green.