-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstallation.html
190 lines (175 loc) · 9.58 KB
/
installation.html
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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation — IGLU documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.png"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></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="IGLU Environments" href="envs.html" />
<link rel="prev" title="IGLU: Interactive Grounded Language Understanding in Minecraft" 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"> IGLU
<img src="_static/logo.png" class="logo" alt="Logo"/>
</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" />
<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="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#global">Global</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#install-jdk-1-8">Install JDK 1.8</a></li>
<li class="toctree-l3"><a class="reference internal" href="#install-xvfb">Install xvfb</a></li>
<li class="toctree-l3"><a class="reference internal" href="#install-iglu-environment">install IGLU environment</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#docker">Docker</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#testing-installation">Testing installation</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="envs.html">IGLU Environments</a></li>
<li class="toctree-l1"><a class="reference internal" href="tasks.html">Tasking the environment</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">IGLU API reference:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="auto/iglu.html">iglu package</a></li>
<li class="toctree-l1"><a class="reference internal" href="auto/iglu.tasks.html">iglu.tasks package</a></li>
<li class="toctree-l1"><a class="reference internal" href="auto/modules.html">iglu</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">IGLU</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"></a> »</li>
<li>Installation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/installation.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="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<section id="global">
<h2>Global<a class="headerlink" href="#global" title="Permalink to this headline"></a></h2>
<section id="install-jdk-1-8">
<h3>Install JDK 1.8<a class="headerlink" href="#install-jdk-1-8" title="Permalink to this headline"></a></h3>
<p>On Ubuntu/Debian:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo add-apt-repository ppa:openjdk-r/ppa
sudo apt-get update
sudo apt-get install openjdk-8-jdk
</pre></div>
</div>
<p>On Mac:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew tap AdoptOpenJDK/openjdk
brew cask install adoptopenjdk8
</pre></div>
</div>
<p>On Windows:</p>
<p>Please use <a class="reference external" href="https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html">Windows installer</a>.</p>
</section>
<section id="install-xvfb">
<h3>Install xvfb<a class="headerlink" href="#install-xvfb" title="Permalink to this headline"></a></h3>
<p>By default <cite>iglu</cite> renders using virtual display using <cite>xvfb</cite> software renderer.</p>
<p>Debian and Ubuntu</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo apt-get install xvfb
</pre></div>
</div>
</section>
<section id="install-iglu-environment">
<h3>install IGLU environment<a class="headerlink" href="#install-iglu-environment" title="Permalink to this headline"></a></h3>
<p><cite>iglu</cite> env requires python version <cite>3.7</cite> or newer. If you are using <cite>conda</cite> you can easily install that in local conda env:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda create -n iglu_env <span class="nv">python</span><span class="o">=</span><span class="m">3</span>.7
conda activate iglu_env
</pre></div>
</div>
<p>You can install using pip: <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">iglu</span></code></p>
<p>To install the package manually, do the following:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git clone [email protected]:iglu-contest/iglu_env.git <span class="o">&&</span> <span class="nb">cd</span> iglu_env
python setup.py install
</pre></div>
</div>
</section>
</section>
<section id="docker">
<h2>Docker<a class="headerlink" href="#docker" title="Permalink to this headline"></a></h2>
<p>All commands below should be run from repository root i.e., after you run <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git@github.com:iglu-contest/iglu_env.git</span> <span class="pre">&&</span> <span class="pre">cd</span> <span class="pre">iglu_env</span></code>.</p>
<p>First, make sure you are using recent docker version. The installation was tested with version <cite>20.10.6</cite>. Also, make sure
you are using <a class="reference external" href="https://github.com/NVIDIA/nvidia-container-runtime">nvidia-container-runtime</a> as default docker runtime.</p>
<p>To get the most recent image, pull that using</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker pull iglucontest/env:latest
</pre></div>
</div>
<p>Alternatively, you can build images manually:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker build -t iglu_base -f docker/base.Dockerfile .
docker build --build-arg <span class="nv">BASE</span><span class="o">=</span>iglu_base --network host -t iglu_env -f docker/iglu.Dockerfile .
</pre></div>
</div>
<section id="testing-installation">
<h3>Testing installation<a class="headerlink" href="#testing-installation" title="Permalink to this headline"></a></h3>
<p>To test <cite>iglu</cite> in the container, run the following command from the root of cloned repo:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker run --network host --rm -it -v <span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>:/root/iglu_dev iglu python iglu_dev/test_env.py
</pre></div>
</div>
<p>You should see step counter followed by total reward of random agent.</p>
</section>
</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="IGLU: Interactive Grounded Language Understanding in Minecraft" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="envs.html" class="btn btn-neutral float-right" title="IGLU Environments" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2021, IGLU team.</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>