https://github.com/jyhmiinlin/pynufft
Tip revision: 5565c1c6bbb92002eec6d7282743bae17922a46d authored by Jyh-Miin Lin on 19 March 2022, 08:57:48 UTC
minor update for the doc
minor update for the doc
Tip revision: 5565c1c
index.html
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to PyNUFFT’s User Manual! — PyNUFFT 2022.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Overview" href="overview/init.html" />
</head>
<body class="wy-body-for-nav">
<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="#" class="icon icon-home"> PyNUFFT
<img src="_static/logo.jpeg" class="logo" alt="Logo"/>
</a>
<div class="version">
2022.1.2
</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="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview/init.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/init.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutor/init.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="manu/init.html">Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="API/init.html">API documentation</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="acknow/init.html">Acknowledgements</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">PyNUFFT</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> »</li>
<li>Welcome to PyNUFFT’s User Manual!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.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">
<section id="welcome-to-pynufft-s-user-manual">
<h1>Welcome to PyNUFFT’s User Manual!<a class="headerlink" href="#welcome-to-pynufft-s-user-manual" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview/init.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview/pynufft.html">The Python Non-uniform fast Fourier transform (PyNUFFT)</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/Nd_NUFFT.html">Multi-dimensional NUFFT</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/CPU_GPU.html">CPU and GPU (HSA)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation/init.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation/init.html#system-requirements">System requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/init.html#software">Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/init.html#general-installation">General Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/init.html#special-topics">Special topics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutor/init.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutor/basic_use.html">Basic use of PyNUFFT</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutor/example.html">The 1D example</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutor/more2D.html">The 2D example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manu/init.html">Manual</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manu/NUFFT_cpu.html">NUFFT</a></li>
<li class="toctree-l2"><a class="reference internal" href="manu/NUFFT_hsa.html">NUFFT(device)</a></li>
<li class="toctree-l2"><a class="reference internal" href="manu/multiple_NUFFT.html">Multiple NUFFT instances</a></li>
<li class="toctree-l2"><a class="reference internal" href="manu/multiple_NUFFT.html#multiprocessing-experimental">Multiprocessing (experimental)</a></li>
<li class="toctree-l2"><a class="reference internal" href="manu/realistic_om.html">k-Space trajectories (om)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="API/init.html">API documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="API/init.html#nufft-class">NUFFT class</a></li>
<li class="toctree-l2"><a class="reference internal" href="API/init.html#cpu-solvers">CPU solvers</a></li>
<li class="toctree-l2"><a class="reference internal" href="API/init.html#hsa-solvers">HSA solvers</a></li>
<li class="toctree-l2"><a class="reference internal" href="API/init.html#nudft-class">NUDFT class</a></li>
<li class="toctree-l2"><a class="reference internal" href="API/init.html#helper-functions">Helper functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="API/init.html#metaprogramming-subroutines-using-reikna-pyopencl-pycuda">Metaprogramming subroutines (using reikna, pyopencl, pycuda)</a></li>
</ul>
</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="acknow/init.html">Acknowledgements</a></li>
</ul>
</div>
<section id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h2>
</section>
<section id="contact-information">
<h2>Contact information<a class="headerlink" href="#contact-information" title="Permalink to this headline"></a></h2>
<p><a class="reference external" href="mailto:pynufft%40gmail.com">pynufft<span>@</span>gmail<span>.</span>com</a></p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="overview/init.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2012-2022, PyNUFFT services.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>