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 "Installing ChipWhisperer/Installing ChipWhisperer from Releases"

From ChipWhisperer Wiki
Jump to: navigation, search
(Created page with "== Windows == Assuming you've got a working Python installation, the next step is to install & run ChipWhisperer itself. This requires you to get a copy of ChipWhisperer,...")
 
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Windows ==
+
Once you have a working Python installation, you're ready to install and run ChipWhisperer.  
Assuming you've got a working Python installation, the next step is to install &amp; run ChipWhisperer itself. This requires you to get a copy of ChipWhisperer, you should download the [https://www.assembla.com/wiki/show/chipwhisperer/ChipWhisperer_Software_Firmware_Releases Latest Release]. Download &amp; unzip the file somewhere. Note if you are adventurous you can clone the GIT Repository <code>git://git.assembla.com/chipwhisperer.git</code> instead, but this '''may be broken''' so you should start with the latest release instead.
+
  
Generally 'somewhere' will become your ChipWhisperer working directory. These examples assume you've chosen <code>C:\chipwhisperer</code> as your working directory.
+
First, download a ChipWhisperer release. You can get these from the [https://github.com/newaetech/chipwhisperer/releases/ Releases] page. Generally, the latest release is a good choice, but you might need an older version for various reasons. You want the source code in .zip or .tar.gz format - not a VMWare image.
  
Once you've got the file, we run the Python install procedure again (setup.py). We slightly modify it to use the ''develop'' command to reflect that the files will probably be changing frequently. Again open a terminal and run the following, adjusting paths as needed:
+
Next, uncompress your downloaded source code somewhere. Generally, 'somewhere' will become your ChipWhisperer working directory. For example, on Windows, you might want to use <code>C:\chipwhisperer\</code>.
  
<pre>cd c:\chipwhisperer\openadc\controlsw\python
+
Once you've got the file, run the Python install procedure (setup.py). Use the ''develop'' command to indicate that the files will probably be changing frequently. to do this, open a terminal and run the following, adjusting paths as needed:
python setup.py develop
+
 
 +
<pre>
 
cd c:\chipwhisperer\software
 
cd c:\chipwhisperer\software
 
python setup.py develop</pre>
 
python setup.py develop</pre>
If you wish to confirm the installation worked, you can run ChipWhispererAnalyzer in the same terminal:
 
  
<pre>cd c:\chipwhisperer\software\chipwhisperer\
+
'''NB''': This assumes the python command links to Python-2.7, and not Python-3.x. You may need to specify either python2.7 or python27 as the command instead of python to force this.
python CWAnalyzer.pyw</pre>
+
Alternatively you can just double-click on <code>CWAnalyzer.py</code> from Windows explorer, which should run the file using Python, ''provided you've registered Python to execute the .py extension''.
+
  
You can see a [http://www.youtube.com/watch?v=qd86cUD8iBs&hd=1 Video] of the Installation Procedure:
+
''In Linux, you might need to run this as root:''
 +
<code>sudo python setup.py develop</code>
  
[[File:Youtube-win7-install.png|YouTubeWin7Install]]_
+
The installation is now finished. To confirm the installation worked, you can run ChipWhispererAnalyzer in the same terminal:
  
== Linux ==
+
<pre>cd c:\chipwhisperer\software\chipwhisperer\
As in the Windows release, you can download a complete ChipWhisperer software release. Alternatively you can clone the ChipWhisperer repository with git, which is very simple on Linux:
+
python CWAnalyzer.pyw</pre>
  
<syntaxhighlight lang="bash">$ git clone git://git.assembla.com/chipwhisperer.git
+
Alternatively you can just double-click on <code>CWAnalyzer.py</code>, which should run the file using Python, ''provided you've registered Python to execute the .py extension''.
$ cd chipwhisperer
+
$ git clone git://git.assembla.com/openadc.git</syntaxhighlight >
+
Be aware that the git code may be broken, although we try not to commit completely untested code to the master branch. Either way once you have the chipwhisperer directory somewhere, do the following from within that directory:
+
<syntaxhighlight lang="bash">$ cd software
+
$ sudo python setup.py develop
+
$ cd ../openadc/controlsw/python
+
$ sudo python setup.py develop</syntaxhighlight >
+
  
'''NB''': This assumes the python command links to Python-2.7, and not Python-3.x. You may need to specify either python2.7 or python27 as the command instead of python to force this.
+
You can see a [http://www.youtube.com/watch?v=qd86cUD8iBs&hd=1 Video] of the installation procedure:
  
== Mac ==
+
[[File:Youtube-win7-install.png|link=https://www.youtube.com/watch?annotation_id=annotation_749386927&feature=iv&src_vid=qd86cUD8iBs&v=BrLBH2y2R8A]]

Latest revision as of 08:59, 19 May 2017

Once you have a working Python installation, you're ready to install and run ChipWhisperer.

First, download a ChipWhisperer release. You can get these from the Releases page. Generally, the latest release is a good choice, but you might need an older version for various reasons. You want the source code in .zip or .tar.gz format - not a VMWare image.

Next, uncompress your downloaded source code somewhere. Generally, 'somewhere' will become your ChipWhisperer working directory. For example, on Windows, you might want to use C:\chipwhisperer\.

Once you've got the file, run the Python install procedure (setup.py). Use the develop command to indicate that the files will probably be changing frequently. to do this, open a terminal and run the following, adjusting paths as needed:

cd c:\chipwhisperer\software
python setup.py develop

NB: This assumes the python command links to Python-2.7, and not Python-3.x. You may need to specify either python2.7 or python27 as the command instead of python to force this.

In Linux, you might need to run this as root: sudo python setup.py develop

The installation is now finished. To confirm the installation worked, you can run ChipWhispererAnalyzer in the same terminal:

cd c:\chipwhisperer\software\chipwhisperer\
python CWAnalyzer.pyw

Alternatively you can just double-click on CWAnalyzer.py, which should run the file using Python, provided you've registered Python to execute the .py extension.

You can see a Video of the installation procedure:

Youtube-win7-install.png