<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to PyOpenCL’s documentation! — PyOpenCL 2013.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/akdoc.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2013.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false
};
</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>
<link rel="top" title="PyOpenCL 2013.1 documentation" href="#" />
<link rel="next" title="OpenCL Runtime" href="runtime.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="runtime.html" title="OpenCL Runtime"
accesskey="N">next</a> |</li>
<li><a href="#">PyOpenCL 2013.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-pyopencl-s-documentation">
<h1>Welcome to PyOpenCL’s documentation!<a class="headerlink" href="#welcome-to-pyopencl-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>PyOpenCL gives you easy, Pythonic access to the <a class="reference external" href="http://www.khronos.org/opencl/">OpenCL</a> parallel computation API.
What makes PyOpenCL special?</p>
<ul class="simple">
<li>Object cleanup tied to lifetime of objects. This idiom,
often called
<a class="reference external" href="http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization">RAII</a>
in C++, makes it much easier to write correct, leak- and
crash-free code.</li>
<li>Completeness. PyOpenCL puts the full power of OpenCL’s API at your
disposal, if you wish. Every obscure <cite>get_info()</cite> query and
all CL calls are accessible.</li>
<li>Automatic Error Checking. All errors are automatically translated
into Python exceptions.</li>
<li>Speed. PyOpenCL’s base layer is written in C++, so all the niceties above
are virtually free.</li>
<li>Helpful Documentation. You’re looking at it. ;)</li>
<li>Liberal license. PyOpenCL is open-source under the
<a class="reference internal" href="misc.html#license"><em>MIT license</em></a>
and free for commercial, academic, and private use.</li>
</ul>
<p>Here’s an example, to give you an impression:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">pyopencl</span> <span class="kn">as</span> <span class="nn">cl</span>
<span class="kn">import</span> <span class="nn">numpy</span>
<span class="kn">import</span> <span class="nn">numpy.linalg</span> <span class="kn">as</span> <span class="nn">la</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">50000</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">numpy</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">50000</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">numpy</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
<span class="n">ctx</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">create_some_context</span><span class="p">()</span>
<span class="n">queue</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">CommandQueue</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
<span class="n">mf</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">mem_flags</span>
<span class="n">a_buf</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">Buffer</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">mf</span><span class="o">.</span><span class="n">READ_ONLY</span> <span class="o">|</span> <span class="n">mf</span><span class="o">.</span><span class="n">COPY_HOST_PTR</span><span class="p">,</span> <span class="n">hostbuf</span><span class="o">=</span><span class="n">a</span><span class="p">)</span>
<span class="n">b_buf</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">Buffer</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">mf</span><span class="o">.</span><span class="n">READ_ONLY</span> <span class="o">|</span> <span class="n">mf</span><span class="o">.</span><span class="n">COPY_HOST_PTR</span><span class="p">,</span> <span class="n">hostbuf</span><span class="o">=</span><span class="n">b</span><span class="p">)</span>
<span class="n">dest_buf</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">Buffer</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">mf</span><span class="o">.</span><span class="n">WRITE_ONLY</span><span class="p">,</span> <span class="n">b</span><span class="o">.</span><span class="n">nbytes</span><span class="p">)</span>
<span class="n">prg</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">Program</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="s">"""</span>
<span class="s"> __kernel void sum(__global const float *a,</span>
<span class="s"> __global const float *b, __global float *c)</span>
<span class="s"> {</span>
<span class="s"> int gid = get_global_id(0);</span>
<span class="s"> c[gid] = a[gid] + b[gid];</span>
<span class="s"> }</span>
<span class="s"> """</span><span class="p">)</span><span class="o">.</span><span class="n">build</span><span class="p">()</span>
<span class="n">prg</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">queue</span><span class="p">,</span> <span class="n">a</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="n">a_buf</span><span class="p">,</span> <span class="n">b_buf</span><span class="p">,</span> <span class="n">dest_buf</span><span class="p">)</span>
<span class="n">a_plus_b</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">empty_like</span><span class="p">(</span><span class="n">a</span><span class="p">)</span>
<span class="n">cl</span><span class="o">.</span><span class="n">enqueue_copy</span><span class="p">(</span><span class="n">queue</span><span class="p">,</span> <span class="n">a_plus_b</span><span class="p">,</span> <span class="n">dest_buf</span><span class="p">)</span>
<span class="k">print</span> <span class="n">la</span><span class="o">.</span><span class="n">norm</span><span class="p">(</span><span class="n">a_plus_b</span> <span class="o">-</span> <span class="p">(</span><span class="n">a</span><span class="o">+</span><span class="n">b</span><span class="p">))</span>
</pre></div>
</div>
<p>(You can find this example as <tt class="file docutils literal"><span class="pre">examples/demo.py</span></tt> in the PyOpenCL
source distribution.)</p>
</div>
<div class="section" id="contents">
<h1>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h1>
<p>A <a class="reference external" href="http://enja.org/2011/02/22/adventures-in-pyopencl-part-1-getting-started-with-python/">tutorial</a>
is on the web, thanks to Ian Johnson.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="runtime.html">OpenCL Runtime</a><ul>
<li class="toctree-l2"><a class="reference internal" href="runtime.html#module-pyopencl">Version Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="runtime.html#error-reporting">Error Reporting</a></li>
<li class="toctree-l2"><a class="reference internal" href="runtime.html#constants">Constants</a></li>
<li class="toctree-l2"><a class="reference internal" href="runtime.html#platforms-devices-and-contexts">Platforms, Devices and Contexts</a></li>
<li class="toctree-l2"><a class="reference internal" href="runtime.html#command-queues-and-events">Command Queues and Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="runtime.html#memory">Memory</a></li>
<li class="toctree-l2"><a class="reference internal" href="runtime.html#programs-and-kernels">Programs and Kernels</a></li>
<li class="toctree-l2"><a class="reference internal" href="runtime.html#gl-interoperability">GL Interoperability</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="array.html">Multi-dimensional arrays</a><ul>
<li class="toctree-l2"><a class="reference internal" href="array.html#data-types">Data Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="array.html#the-array-class">The <tt class="docutils literal"><span class="pre">Array</span></tt> Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="array.html#module-pyopencl.clmath">Elementwise Functions on <tt class="docutils literal"><span class="pre">Arrray</span></tt> Instances</a></li>
<li class="toctree-l2"><a class="reference internal" href="array.html#generating-arrays-of-random-numbers">Generating Arrays of Random Numbers</a></li>
<li class="toctree-l2"><a class="reference internal" href="array.html#fast-fourier-transforms">Fast Fourier Transforms</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="algorithm.html">Parallel Algorithms</a><ul>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#module-pyopencl.elementwise">Element-wise expression evalution (“map”)</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#module-pyopencl.reduction">Sums and counts (“reduce”)</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#module-pyopencl.scan">Prefix Sums (“scan”)</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#module-pyopencl.algorithm">Predicated copies (“partition”, “unique”, ...)</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#sorting-radix-sort">Sorting (radix sort)</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#building-many-variable-size-lists">Building many variable-size lists</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tools.html">Built-in Utilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tools.html#memory-pools">Memory Pools</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools.html#cl-object-dependent-caching">CL-Object-dependent Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools.html#testing">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools.html#device-characterization">Device Characterization</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="misc.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc.html#acknowledgments">Acknowledgments</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc.html#tips">Tips</a><ul>
<li class="toctree-l2"><a class="reference internal" href="misc.html#syntax-highlighting">Syntax highlighting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="misc.html#guidelines">Guidelines</a><ul>
<li class="toctree-l2"><a class="reference internal" href="misc.html#api-stability">API Stability</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#relation-with-opencl-s-c-bindings">Relation with OpenCL’s C Bindings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="misc.html#user-visible-changes">User-visible Changes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-2013-1">Version 2013.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-2012-1">Version 2012.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-2011-2">Version 2011.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-2011-1-2">Version 2011.1.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-2011-1-1">Version 2011.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-2011-1">Version 2011.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-92">Version 0.92</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-91-5">Version 0.91.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-91-4">Version 0.91.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-91-3">Version 0.91.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-91-2">Version 0.91.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-91-1">Version 0.91.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-91">Version 0.91</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-90-4">Version 0.90.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-90-3">Version 0.90.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-90-2">Version 0.90.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-90-1">Version 0.90.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html#version-0-90">Version 0.90</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="misc.html#license">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc.html#frequently-asked-questions">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc.html#citing-pyopencl">Citing PyOpenCL</a></li>
</ul>
</div>
<p>Note that this guide does not explain OpenCL programming and technology. Please
refer to the official <a class="reference external" href="http://khronos.org/opencl">Khronos OpenCL documentation</a>
for that.</p>
<p>PyOpenCL also has its own <a class="reference external" href="http://mathema.tician.de/software/pyopencl">web site</a>,
where you can find updates, new versions, documentation, and support.</p>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to PyOpenCL’s documentation!</a></li>
<li><a class="reference internal" href="#contents">Contents</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="runtime.html"
title="next chapter">OpenCL Runtime</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="runtime.html" title="OpenCL Runtime"
>next</a> |</li>
<li><a href="#">PyOpenCL 2013.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009, Andreas Kloeckner.
Last updated on Oct 15, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
