installation.html
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installation — PyNUFFT 0.3.3 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="PyNUFFT 0.3.3 documentation" href="../index.html"/>
<link rel="up" title="Quick start" href="../getstart.html"/>
<link rel="next" title="An 1D example" href="example.html"/>
<link rel="prev" title="Quick start" href="../getstart.html"/>
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> PyNUFFT
</a>
<div class="version">
0.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../whatnew.html">What's new</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../getstart.html">Quick start</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="example.html">An 1D example</a></li>
<li class="toctree-l2"><a class="reference internal" href="more2D.html">A 2D example</a></li>
<li class="toctree-l2"><a class="reference internal" href="more3D.html">Multi-dimensional NUFFT</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../misc.html">Miscellaneousness</a></li>
<li class="toctree-l1"><a class="reference internal" href="../versionhistory.html">Version history</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html">API documentaiton</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">PyNUFFT</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="../getstart.html">Quick start</a> »</li>
<li>Installation</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/quickstart/installation.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">ΒΆ</a></h1>
<p><strong>Dependencies</strong></p>
<ul class="simple">
<li>Tested using Python 3.4 on Linux-64.</li>
<li>Numpy-1.13.3 and Scipy-0.19.1.</li>
<li>Matplotlib is required for image display.</li>
<li>Continuum's <a class="reference external" href="https://www.continuum.io/downloads">Anaconda</a> environment should provide all the above packages.</li>
</ul>
<p><strong>Quick Installation</strong></p>
<p>Install pynufft by using <a class="reference external" href="https://en.wikipedia.org/wiki/Pip_(package_manager)">pip</a> command:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install pynufft
</pre></div>
</div>
<p><strong>Installation from Git Repository</strong></p>
<p><a class="reference external" href="https://en.wikipedia.org/wiki/Git">git</a> is a version control program, which allows you to clone the latest code base from <a class="reference external" href="https://github.com/jyhmiinlin/pynufft">pynufft</a> repository:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ git clone https://github.com/jyhmiinlin/pynufft
$ cd pynufft
$ python setup.py install --user
</pre></div>
</div>
<p><strong>Test if the installation is successful</strong></p>
<p>In Python environment, import pynufft:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pynufft.tests</span> <span class="k">as</span> <span class="nn">tests</span>
<span class="gp">>>> </span><span class="n">tests</span><span class="o">.</span><span class="n">test_installation</span><span class="p">()</span>
</pre></div>
</div>
<p>If the required data and functions are available, you will see all the required files exist:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>Does pynufft.py exist? True
Does om1D.npz exist? True
Does om2D.npz exist? True
Does om3D.npz exist? True
Does phantom_3D_128_128_128.npz exist? True
Does phantom_256_256.npz exist? True
Does example_1D.py exist? True
Does example_2D.py exist? True
reikna has been installed.
pyopencl has been installed.
pycuda has been installed.
</pre></div>
</div>
<p><strong>Uninstall pynufft</strong></p>
<p>Simply use "pip uninstall" to remove pynufft:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ pip uninstall pynufft
</pre></div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="example.html" class="btn btn-neutral float-right" title="An 1D example" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../getstart.html" class="btn btn-neutral" title="Quick start" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Jyh-Miin Lin.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.3.3',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>