<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - +/pykokkos @ master</title>
<meta name="description" content="README.md in +/pykokkos at master.">
<meta property="og:title" content="README.md - +/pykokkos @ master">
<meta property="og:description" content="README.md in +/pykokkos at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="1a80dfe8f0fa1ab32b56ecb137124503be29b0bb">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>+/pykokkos</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/+/pykokkos</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Joseph Ryan</span><span class="commit-message" data-commit="ca856e5a1677eef6290681f1a63efb68cab316fc">Make pykokkos an actual python package</span><span class="snapshot-sha sha" data-commit="ca856e5a1677eef6290681f1a63efb68cab316fc">ca856e5</span><time datetime="2020-02-28T17:16:44-06:00" title="2020-02-28 17:16:44 -0600">2020-02-28</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/%2B/pykokkos/ref/master/">master</a><a class="all" href="/%2B/pykokkos/refs">all refs →</a></div></details><nav class="crumbs"><a href="/%2B/pykokkos/">pykokkos</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>938 B</span><span>33 lines</span></span><span class="actions"><a class="raw" href="/%2B/pykokkos/raw/8ecf838ffa58b9e1fc069ee2933e487d1f64c2a7/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>PyKokkos</h1>
<p>This project is an attempt to utilize Python to initialize and orchestrate
<a href="https://github.com/kokkos/kokkos">Kokkos</a> workloads. An additional feature is
using Python to C++ translation to enable writing even the performance sensitive
work units in pure Python.</p>
<h2>Usage</h2>
<h3>Setting up your environment</h3>
<p>Clone pykokkos and in its root directory run <code>pip install --user -e .</code></p>
<p>You also need to download the Kokkos library to <code>$HOME/projects/kokkos</code>. This
location will be configurable in the future.</p>
<pre class="language-bash"><a-f>git</a-f> clone https://github.com/kokkos/kokkos.git <a-o>$</a-o><a-pr>HOME</a-pr>/projects/kokkos</pre>
<p>Kokkos also requires a C++11 compiler, and the different backends require other
tools. For example if you're using a GPU you need nvcc.</p>
<p>As for Python, version 3.8 or later is required and the following packages are
required</p>
<h3>Running examples</h3>
<p>Simply navigate to <code>examples/</code> and run <code>python add1.py</code></p>
<h3>Writing your own workloads</h3>
<p>TODO</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>PyKokkos</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">This project is an attempt to utilize Python to initialize and orchestrate</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">[Kokkos](https://github.com/kokkos/kokkos) workloads. An additional feature is</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">using Python to C++ translation to enable writing even the performance sensitive</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">work units in pure Python.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>##</a-p> <a-tt>Usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>###</a-p> <a-tt>Setting up your environment</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">Clone pykokkos and in its root directory run `pip install --user -e .`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">You also need to download the Kokkos library to `$HOME/projects/kokkos`. This</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">location will be configurable in the future.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>git clone https://github.com/kokkos/kokkos.git </a-p><a-o>$</a-o><a-pr>HOME</a-pr><a-p>/projects/kokkos</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>Kokkos also requires a C++11 compiler, and the different backends require other</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>tools. For example if you&#39;re using a GPU you need nvcc.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>As for Python, version 3.8 or later is required and the following packages are</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>required</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>### </a-p><a-tt>Running examples</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>Simply navigate to `examples/` and run `python add1.py`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>### </a-p><a-tt>Writing your own workloads</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">TODO</span></span></pre></div></div>
</main>
</body>
</html>
