As of August 2020 the site you are on (wiki.newae.com) is deprecated, and content is now at rtfm.newae.com.

Difference between revisions of "V5:Installing ChipWhisperer/Installing ChipWhisperer from Git"

From ChipWhisperer Wiki
Jump to: navigation, search
Line 13: Line 13:
 
</pre>
 
</pre>
 
The user flag installs ChipWhisperer in the user's <b>local</b> python site-packages directory.
 
The user flag installs ChipWhisperer in the user's <b>local</b> 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.
 +
<pre>
 +
cd ..
 +
git submodule init
 +
git submodule update jupyter/
 +
</pre>
  
 
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:
 
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:
Line 18: Line 25:
 
cd ..
 
cd ..
 
git submodule init
 
git submodule init
git submodule update
+
git submodule update openadc
 
cd openadc/controlsw/python
 
cd openadc/controlsw/python
 
python setup.py develop --user
 
python setup.py develop --user
 
</pre>
 
</pre>
  
Once ChipWhisperer is installed, you can run it through Jupyter by typing <pre>jupyter notebook</pre> 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.
+
Once ChipWhisperer and the Jupyter notebooks are installed, you can the tutorials through Jupyter by typing <pre>jupyter notebook</pre> 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.

Revision as of 10:24, 21 June 2019

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
git submodule update jupyter/

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
git submodule update openadc
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.