Skip to content
This repository has been archived by the owner on Feb 2, 2024. It is now read-only.

Commit

Permalink
move install to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ehsan Totoni committed Sep 11, 2017
1 parent cb9689a commit b357dbd
Show file tree
Hide file tree
Showing 23 changed files with 264 additions and 94 deletions.
39 changes: 1 addition & 38 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,41 +18,4 @@ These academic papers describe the underlying methods in HPAT:
- `HPAT at HotOS'17 <http://dl.acm.org/citation.cfm?id=3103004>`_
- `HiFrames on arxiv <https://arxiv.org/abs/1704.02341>`_

Installing HPAT
===============

These commands install HPAT and its dependencies such as Numba, LLVM and HDF5
on Ubuntu Linux::

$ sudo apt install llvm-4.0 make libc6-dev gcc-4.8
$ # download and install Anaconda python distribution
$ conda create -n HPAT
$ source activate HPAT
$ conda install numpy scipy pandas gcc mpich2 llvmlite
$ git clone https://github.com/IntelLabs/numba.git
$ cd numba
$ git checkout hpat_req
$ python setup.py develop
$ cd ..
$ # download hdf5 and cd inside
$ CC=mpicc CXX=mpicxx ./configure --enable-parallel
$ make; make install
$ cd ..
$ export HDF5_DIR=/home/user/hdf5-1.10.1/hdf5/
$ export C_INCLUDE_PATH=$C_INCLUDE_PATH:$HDF5_DIR/include
$ export CPLUS_INCLUDE_PATH=$CPLUS_INCLUDE_PATH:$HDF5_DIR/include
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HDF5_DIR/lib
$ export LIBRARY_PATH=$LIBRARY_PATH:$HDF5_DIR/lib
$ git clone https://github.com/h5py/h5py.git
$ cd h5py
$ python setup.py configure --hdf5=$HDF5_DIR
$ LDSHARED="mpicc -shared" CXX=mpicxx LD=mpicc CC="mpicc" python setup.py install
$ cd ..
$ git clone https://github.com/IntelLabs/hpat.git
$ cd hpat
$ LDSHARED="mpicxx -shared" CXX=mpicxx LD=mpicxx CC="mpicxx -std=c++11" python setup.py develop

Commands for running the logistic regression example::

$ python generate_data/gen_logistic_regression.py
$ mpirun -n 2 python examples/logistic_regression.py
HPAT's documentation can be found `here <https://intellabs.github.io/hpat/>`_.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/source/install.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/source/notsupported.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/source/overview.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/source/supported.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7e92f68e7de450dabf122e0b9219a2a0
config: 2ca56a9ba859c2fc39c9a2235e6870fa
tags: 645f666f9bcd5a90fca523b33c5a78b7
1 change: 1 addition & 0 deletions docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ HPAT documentation
source/overview
source/supported
source/notsupported
source/install
40 changes: 40 additions & 0 deletions docs/_build/html/_sources/source/install.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
.. _install:

Installing HPAT
===============

These commands install HPAT and its dependencies such as Numba, LLVM and HDF5
on Ubuntu Linux::

$ sudo apt install llvm-4.0 make libc6-dev gcc-4.8
$ # download and install Anaconda python distribution
$ conda create -n HPAT
$ source activate HPAT
$ conda install numpy scipy pandas gcc mpich2 llvmlite
$ git clone https://github.com/IntelLabs/numba.git
$ cd numba
$ git checkout hpat_req
$ python setup.py develop
$ cd ..
$ # download hdf5 and cd inside
$ CC=mpicc CXX=mpicxx ./configure --enable-parallel
$ make; make install
$ cd ..
$ export HDF5_DIR=/home/user/hdf5-1.10.1/hdf5/
$ export C_INCLUDE_PATH=$C_INCLUDE_PATH:$HDF5_DIR/include
$ export CPLUS_INCLUDE_PATH=$CPLUS_INCLUDE_PATH:$HDF5_DIR/include
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HDF5_DIR/lib
$ export LIBRARY_PATH=$LIBRARY_PATH:$HDF5_DIR/lib
$ git clone https://github.com/h5py/h5py.git
$ cd h5py
$ python setup.py configure --hdf5=$HDF5_DIR
$ LDSHARED="mpicc -shared" CXX=mpicxx LD=mpicc CC="mpicc" python setup.py install
$ cd ..
$ git clone https://github.com/IntelLabs/hpat.git
$ cd hpat
$ LDSHARED="mpicxx -shared" CXX=mpicxx LD=mpicxx CC="mpicxx -std=c++11" python setup.py develop

Commands for running the logistic regression example::

$ python generate_data/gen_logistic_regression.py
$ mpirun -n 2 python examples/logistic_regression.py
6 changes: 3 additions & 3 deletions docs/_build/html/_sources/source/notsupported.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ variable should have a single type. The example below is not type stable since
variable ``a`` can be both a float and an array of floats::

if flag:
a = np.ones(10)
else:
a = 1.0
else:
a = np.ones(10)

The use of ``isinstance`` operator of Python often means type instabillity and
is not supported.
Expand All @@ -27,7 +27,7 @@ Similarly, function calls should also be deterministic. The below example is
not supported since function ``f`` is not known in advance::

if flag:
f = np.ones
f = np.zeros
else:
f = np.random.ranf
A = f(10)
Expand Down
7 changes: 7 additions & 0 deletions docs/_build/html/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,13 @@ table.field-list td, table.field-list th {
margin: 0;
}

.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}

/* -- other body styles ----------------------------------------------------- */

ol.arabic {
Expand Down
11 changes: 4 additions & 7 deletions docs/_build/html/genindex.html
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@


<!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>Index &#8212; HPAT 0.1 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
Expand All @@ -25,7 +22,7 @@
<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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />

Expand All @@ -35,7 +32,7 @@
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head>
<body role="document">
<body>


<div class="document">
Expand Down Expand Up @@ -83,7 +80,7 @@ <h3>Quick search</h3>
&copy;2017, Ehsan Totoni.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
12 changes: 5 additions & 7 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@

<!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>HPAT documentation &#8212; HPAT 0.1 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
Expand All @@ -24,7 +21,7 @@
<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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Overview" href="source/overview.html" />
Expand All @@ -35,7 +32,7 @@
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head>
<body role="document">
<body>


<div class="document">
Expand Down Expand Up @@ -63,6 +60,7 @@ <h1>HPAT documentation<a class="headerlink" href="#hpat-documentation" title="Pe
<li class="toctree-l2"><a class="reference internal" href="source/notsupported.html#type-stability">Type Stability</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source/install.html">Installing HPAT</a></li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -105,7 +103,7 @@ <h3>Quick search</h3>
&copy;2017, Ehsan Totoni.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

|
Expand Down
Binary file modified docs/_build/html/objects.inv
Binary file not shown.
11 changes: 4 additions & 7 deletions docs/_build/html/search.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@

<!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>Search &#8212; HPAT 0.1 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
Expand All @@ -24,7 +21,7 @@
<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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" />
Expand All @@ -42,7 +39,7 @@


</head>
<body role="document">
<body>


<div class="document">
Expand Down Expand Up @@ -93,7 +90,7 @@ <h3>Related Topics</h3>
&copy;2017, Ehsan Totoni.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit b357dbd

Please sign in to comment.