V5:Installing ChipWhisperer/Installing ChipWhisperer from Git

If you want the cutting-edge version of ChipWhisperer, you can clone the repository.

NOTE: On Unix based OS (Mac, Linux, etc), python often links to python2. You may need to replace python and pip calls with python3 and pip3 calls, respectively

If you have Git already set up, this is easy to do:

git clone https://github.com/newaetech/chipwhisperer.git
cd chipwhisperer
git checkout cw5dev
cd software
pip install -r requirements.txt
python setup.py develop --user

The user flag installs ChipWhisperer in the user's local python site-packages directory.

You probably also want the Jupyter notebooks, which are the tutorial interface for ChipWhisperer 5. If not, you can skip this step.

cd ..
git submodule init jupyter/
git submodule update

You may also want the OpenADC software, which is necessary to build new firmware for the ChipWhisperer FPGA. This is unnecessary for most users. If you need it:

cd ..
git submodule init openadc/
git submodule update
cd openadc/controlsw/python
python setup.py develop --user

Once ChipWhisperer and the Jupyter notebooks are installed, you can the tutorials through Jupyter by typing

jupyter notebook

into the command prompt, which should open a new Window in your browser. Navigate to chipwhisperer/software/jupyter/ to get started with the new Jupyter tutorials.