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

Revision as of 09:16, 19 December 2018 (view source) Adewar (Talk | contribs) ← Older edit		Latest revision as of 12:21, 27 June 2019 (view source) Adewar (Talk | contribs)
(5 intermediate revisions by the same user not shown)
Line 2:		Line 2:
	'''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'''		'''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:		If you have Git already set up, this is easy to do:
Line 12:		Line 13:
	python setup.py develop --user		python setup.py develop --user
	</pre>		</pre>
−	The user flag installs ChipWhisperer in the user's <b>local</b> python site-packages directory. Note bleeding-edge development is done on the "develop" branch, which you probably want if you are trying GIT.	+	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 jupyter/
		+	git submodule update
		+	</pre>
		+
		+	If you want to contribute to chipwhisperer-jupyter, you'll want to checkout the cw5dev branch in chipwhisperer-jupyter:
		+
		+	<pre>
		+	cd jupyter
		+	git checkout cw5dev
		+	</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:
	<pre>		<pre>
	cd ..		cd ..
−	git submodule init	+	git submodule init openadc/
	git submodule update		git submodule update
	cd openadc/controlsw/python		cd openadc/controlsw/python
	python setup.py develop --user		python setup.py develop --user
	</pre>		</pre>
		+
		+	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.
		+
		+
		+	'''NOTE: To run %%bash blocks on Windows, you need run jupyter notebook using a bash console, such as git bash. Jupyter will still work without this, but %%bash blocks will not run'''

---

Latest revision as of 12:21, 27 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 jupyter/
git submodule update

If you want to contribute to chipwhisperer-jupyter, you'll want to checkout the cw5dev branch in chipwhisperer-jupyter:

cd jupyter
git checkout cw5dev

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.

NOTE: To run %%bash blocks on Windows, you need run jupyter notebook using a bash console, such as git bash. Jupyter will still work without this, but %%bash blocks will not run