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

Commit b357dbd

Browse files
author
Ehsan Totoni
committed
move install to docs
1 parent cb9689a commit b357dbd

23 files changed

+264
-94
lines changed

README.rst

+1-38
Original file line numberDiff line numberDiff line change
@@ -18,41 +18,4 @@ These academic papers describe the underlying methods in HPAT:
1818
- `HPAT at HotOS'17 <http://dl.acm.org/citation.cfm?id=3103004>`_
1919
- `HiFrames on arxiv <https://arxiv.org/abs/1704.02341>`_
2020

21-
Installing HPAT
22-
===============
23-
24-
These commands install HPAT and its dependencies such as Numba, LLVM and HDF5
25-
on Ubuntu Linux::
26-
27-
$ sudo apt install llvm-4.0 make libc6-dev gcc-4.8
28-
$ # download and install Anaconda python distribution
29-
$ conda create -n HPAT
30-
$ source activate HPAT
31-
$ conda install numpy scipy pandas gcc mpich2 llvmlite
32-
$ git clone https://github.com/IntelLabs/numba.git
33-
$ cd numba
34-
$ git checkout hpat_req
35-
$ python setup.py develop
36-
$ cd ..
37-
$ # download hdf5 and cd inside
38-
$ CC=mpicc CXX=mpicxx ./configure --enable-parallel
39-
$ make; make install
40-
$ cd ..
41-
$ export HDF5_DIR=/home/user/hdf5-1.10.1/hdf5/
42-
$ export C_INCLUDE_PATH=$C_INCLUDE_PATH:$HDF5_DIR/include
43-
$ export CPLUS_INCLUDE_PATH=$CPLUS_INCLUDE_PATH:$HDF5_DIR/include
44-
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HDF5_DIR/lib
45-
$ export LIBRARY_PATH=$LIBRARY_PATH:$HDF5_DIR/lib
46-
$ git clone https://github.com/h5py/h5py.git
47-
$ cd h5py
48-
$ python setup.py configure --hdf5=$HDF5_DIR
49-
$ LDSHARED="mpicc -shared" CXX=mpicxx LD=mpicc CC="mpicc" python setup.py install
50-
$ cd ..
51-
$ git clone https://github.com/IntelLabs/hpat.git
52-
$ cd hpat
53-
$ LDSHARED="mpicxx -shared" CXX=mpicxx LD=mpicxx CC="mpicxx -std=c++11" python setup.py develop
54-
55-
Commands for running the logistic regression example::
56-
57-
$ python generate_data/gen_logistic_regression.py
58-
$ mpirun -n 2 python examples/logistic_regression.py
21+
HPAT's documentation can be found `here <https://intellabs.github.io/hpat/>`_.
1.07 KB
Binary file not shown.

docs/_build/doctrees/index.doctree

55 Bytes
Binary file not shown.
5.79 KB
Binary file not shown.
145 Bytes
Binary file not shown.
125 Bytes
Binary file not shown.
417 Bytes
Binary file not shown.

docs/_build/html/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 7e92f68e7de450dabf122e0b9219a2a0
3+
config: 2ca56a9ba859c2fc39c9a2235e6870fa
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_sources/index.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ HPAT documentation
1313
source/overview
1414
source/supported
1515
source/notsupported
16+
source/install
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. _install:
2+
3+
Installing HPAT
4+
===============
5+
6+
These commands install HPAT and its dependencies such as Numba, LLVM and HDF5
7+
on Ubuntu Linux::
8+
9+
$ sudo apt install llvm-4.0 make libc6-dev gcc-4.8
10+
$ # download and install Anaconda python distribution
11+
$ conda create -n HPAT
12+
$ source activate HPAT
13+
$ conda install numpy scipy pandas gcc mpich2 llvmlite
14+
$ git clone https://github.com/IntelLabs/numba.git
15+
$ cd numba
16+
$ git checkout hpat_req
17+
$ python setup.py develop
18+
$ cd ..
19+
$ # download hdf5 and cd inside
20+
$ CC=mpicc CXX=mpicxx ./configure --enable-parallel
21+
$ make; make install
22+
$ cd ..
23+
$ export HDF5_DIR=/home/user/hdf5-1.10.1/hdf5/
24+
$ export C_INCLUDE_PATH=$C_INCLUDE_PATH:$HDF5_DIR/include
25+
$ export CPLUS_INCLUDE_PATH=$CPLUS_INCLUDE_PATH:$HDF5_DIR/include
26+
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HDF5_DIR/lib
27+
$ export LIBRARY_PATH=$LIBRARY_PATH:$HDF5_DIR/lib
28+
$ git clone https://github.com/h5py/h5py.git
29+
$ cd h5py
30+
$ python setup.py configure --hdf5=$HDF5_DIR
31+
$ LDSHARED="mpicc -shared" CXX=mpicxx LD=mpicc CC="mpicc" python setup.py install
32+
$ cd ..
33+
$ git clone https://github.com/IntelLabs/hpat.git
34+
$ cd hpat
35+
$ LDSHARED="mpicxx -shared" CXX=mpicxx LD=mpicxx CC="mpicxx -std=c++11" python setup.py develop
36+
37+
Commands for running the logistic regression example::
38+
39+
$ python generate_data/gen_logistic_regression.py
40+
$ mpirun -n 2 python examples/logistic_regression.py

docs/_build/html/_sources/source/notsupported.rst.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ variable should have a single type. The example below is not type stable since
1616
variable ``a`` can be both a float and an array of floats::
1717

1818
if flag:
19-
a = np.ones(10)
20-
else:
2119
a = 1.0
20+
else:
21+
a = np.ones(10)
2222

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

2929
if flag:
30-
f = np.ones
30+
f = np.zeros
3131
else:
3232
f = np.random.ranf
3333
A = f(10)

docs/_build/html/_static/basic.css

+7
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,13 @@ table.field-list td, table.field-list th {
398398
margin: 0;
399399
}
400400

401+
.field-name {
402+
-moz-hyphens: manual;
403+
-ms-hyphens: manual;
404+
-webkit-hyphens: manual;
405+
hyphens: manual;
406+
}
407+
401408
/* -- other body styles ----------------------------------------------------- */
402409

403410
ol.arabic {

docs/_build/html/genindex.html

+4-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11

2+
23
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
34
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
45

5-
66
<html xmlns="http://www.w3.org/1999/xhtml">
77
<head>
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
109
<title>Index &#8212; HPAT 0.1 documentation</title>
11-
1210
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1311
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14-
1512
<script type="text/javascript">
1613
var DOCUMENTATION_OPTIONS = {
1714
URL_ROOT: './',
@@ -25,7 +22,7 @@
2522
<script type="text/javascript" src="_static/jquery.js"></script>
2623
<script type="text/javascript" src="_static/underscore.js"></script>
2724
<script type="text/javascript" src="_static/doctools.js"></script>
28-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
25+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
2926
<link rel="index" title="Index" href="#" />
3027
<link rel="search" title="Search" href="search.html" />
3128

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

3734
</head>
38-
<body role="document">
35+
<body>
3936

4037

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

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

8986
</div>

docs/_build/html/index.html

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
1+
12
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
23
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
34

4-
55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8-
98
<title>HPAT documentation &#8212; HPAT 0.1 documentation</title>
10-
119
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1210
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13-
1411
<script type="text/javascript">
1512
var DOCUMENTATION_OPTIONS = {
1613
URL_ROOT: './',
@@ -24,7 +21,7 @@
2421
<script type="text/javascript" src="_static/jquery.js"></script>
2522
<script type="text/javascript" src="_static/underscore.js"></script>
2623
<script type="text/javascript" src="_static/doctools.js"></script>
27-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
24+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
2825
<link rel="index" title="Index" href="genindex.html" />
2926
<link rel="search" title="Search" href="search.html" />
3027
<link rel="next" title="Overview" href="source/overview.html" />
@@ -35,7 +32,7 @@
3532
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
3633

3734
</head>
38-
<body role="document">
35+
<body>
3936

4037

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

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

111109
|

docs/_build/html/objects.inv

24 Bytes
Binary file not shown.

docs/_build/html/search.html

+4-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
1+
12
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
23
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
34

4-
55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8-
98
<title>Search &#8212; HPAT 0.1 documentation</title>
10-
119
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1210
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13-
1411
<script type="text/javascript">
1512
var DOCUMENTATION_OPTIONS = {
1613
URL_ROOT: './',
@@ -24,7 +21,7 @@
2421
<script type="text/javascript" src="_static/jquery.js"></script>
2522
<script type="text/javascript" src="_static/underscore.js"></script>
2623
<script type="text/javascript" src="_static/doctools.js"></script>
27-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
24+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
2825
<script type="text/javascript" src="_static/searchtools.js"></script>
2926
<link rel="index" title="Index" href="genindex.html" />
3027
<link rel="search" title="Search" href="#" />
@@ -42,7 +39,7 @@
4239

4340

4441
</head>
45-
<body role="document">
42+
<body>
4643

4744

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

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

9996
</div>

docs/_build/html/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)