-
Notifications
You must be signed in to change notification settings - Fork 535
Expand file tree
/
Copy pathinstall.html
More file actions
200 lines (180 loc) · 11.7 KB
/
install.html
File metadata and controls
200 lines (180 loc) · 11.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Install SystemDS — SystemDS 3.3.0-dev documentation</title>
<link rel="stylesheet" type="text/css" href="../static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="../static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../static/jquery.js?v=5d32c60e"></script>
<script src="../static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../static/documentation_options.js?v=492a8e1f"></script>
<script src="../static/doctools.js?v=9a2dae69"></script>
<script src="../static/sphinx_highlight.js?v=dc90522c"></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="QuickStart" href="simple_examples.html" />
<link rel="prev" title="SystemDS" href="../index.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="../index.html" class="icon icon-home">
SystemDS
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="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">
<p class="caption" role="heading"><span class="caption-text">Getting Started:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Install SystemDS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#pip">Pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="#source">Source</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="simple_examples.html">QuickStart</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../guide/federated.html">Federated Environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="../guide/algorithms_basics.html">Built-in Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../guide/python_end_to_end_tut.html">Python end-to-end tutorial</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/context/systemds_context.html">SystemDSContext</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/operator/algorithms.html">Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/operator/node/matrix.html">Matrix</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/operator/node/frame.html">Frame</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/operator/node/list.html">List</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/operator/node/scalar.html">Scalar</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/operator/node/source.html">Source</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Internals API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/operator/operation_node.html">Operation Node</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/script_building/dag.html">Dag</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/script_building/script.html">Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/utils/converters.html">Converters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/utils/helpers.html">Helpers</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="../index.html">SystemDS</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="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Install SystemDS</li>
<li class="wy-breadcrumbs-aside">
<a href="../sources/getting_started/install.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="install-systemds">
<h1>Install SystemDS<a class="headerlink" href="#install-systemds" title="Link to this heading"></a></h1>
<p>SystemDS can be installed via <cite>pip</cite> or installed from source.</p>
<section id="pip">
<h2>Pip<a class="headerlink" href="#pip" title="Link to this heading"></a></h2>
<p>Installation is quite simple with <cite>pip</cite>, just execute the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">systemds</span>
</pre></div>
</div>
<p>SystemDS is a java-project, the <cite>pip</cite> package contains all the necessary <cite>jars</cite>,
but you will need java version 11 installed. Do not use an older or newer
version of java, because SystemDS is non compatible with other java versions.</p>
<p>Check the output of <code class="docutils literal notranslate"><span class="pre">java</span> <span class="pre">-version</span></code>. The output should look similar to:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">openjdk</span> <span class="n">version</span> <span class="s2">"11.0.18"</span> <span class="mi">2023</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">17</span>
<span class="n">OpenJDK</span> <span class="n">Runtime</span> <span class="n">Environment</span> <span class="p">(</span><span class="n">build</span> <span class="mf">11.0.18</span><span class="o">+</span><span class="mi">10</span><span class="o">-</span><span class="n">post</span><span class="o">-</span><span class="n">Ubuntu</span><span class="o">-</span><span class="mi">0</span><span class="n">ubuntu122</span><span class="mf">.04</span><span class="p">)</span>
<span class="n">OpenJDK</span> <span class="mi">64</span><span class="o">-</span><span class="n">Bit</span> <span class="n">Server</span> <span class="n">VM</span> <span class="p">(</span><span class="n">build</span> <span class="mf">11.0.18</span><span class="o">+</span><span class="mi">10</span><span class="o">-</span><span class="n">post</span><span class="o">-</span><span class="n">Ubuntu</span><span class="o">-</span><span class="mi">0</span><span class="n">ubuntu122</span><span class="mf">.04</span><span class="p">,</span> <span class="n">mixed</span> <span class="n">mode</span><span class="p">,</span> <span class="n">sharing</span><span class="p">)</span>
</pre></div>
</div>
<p>The important part is in the first line <code class="docutils literal notranslate"><span class="pre">openjdk</span> <span class="pre">version</span> <span class="pre">"11.xx"</span></code>,
please make sure this is the case.</p>
</section>
<section id="source">
<h2>Source<a class="headerlink" href="#source" title="Link to this heading"></a></h2>
<p>To Install from source involves multiple steps.</p>
<p>Install Dependencies</p>
<ul class="simple">
<li><p><a class="reference external" href="https://maven.apache.org/">Maven</a></p></li>
<li><p><a class="reference external" href="https://www.python.org/downloads/">Python 3.6+</a> and</p></li>
<li><p><a class="reference external" href="https://openjdk.java.net/install/">OpenJDK 11.xxx Java</a></p></li>
</ul>
<p>Once installed you please verify your version numbers.
Additionally you have to install a few python packages.
We suggest to create a new virtual environment using virtual env.
All commands are run inside src/main/python/.
We assume that in the following scripts python==python3</p>
<blockquote>
<div><p>python -m venv python_venv</p>
</div></blockquote>
<p>Now, we activate the environment.</p>
<blockquote>
<div><p>source python_venv/bin/activate</p>
</div></blockquote>
<p>In case of using Linux. For Windows PowerShell use:</p>
<blockquote>
<div><p>Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
python_venv/Scripts/Activate.ps1</p>
</div></blockquote>
<p>Note depending on your installation you might need to use pip3 instead of pip:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">numpy</span> <span class="n">py4j</span> <span class="n">wheel</span> <span class="n">requests</span>
</pre></div>
</div>
<p>Then to build the system you do the following</p>
<ul class="simple">
<li><p>Clone the Git Repository: <a class="reference external" href="https://github.com/apache/systemds.git">https://github.com/apache/systemds.git</a></p></li>
<li><p>Open an terminal at the root of the repository.</p></li>
<li><p>Package the Java code using the <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">package</span> <span class="pre">-P</span> <span class="pre">distribution</span></code> command</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cd</span> <span class="pre">src/main/python</span></code> to point at the root of the SystemDS Python library.</p></li>
<li><p>Build the Python API <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">create_python_dist.py</span></code></p></li>
<li><p>Install with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">.</span></code></p></li>
</ul>
<p>After this you are ready to go.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../index.html" class="btn btn-neutral float-left" title="SystemDS" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="simple_examples.html" class="btn btn-neutral float-right" title="QuickStart" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, Apache SystemDS.</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>