forked from openradar/vm-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
quickstart.html
179 lines (167 loc) · 10.5 KB
/
quickstart.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
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Quick start — An Open Virtual Machine for Cross-Platform Weather Radar Science</title>
<link rel="stylesheet" href="_static/agogo.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
<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>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Downloads" href="downloads.html" />
<link rel="prev" title="Features" href="features.html" />
</head><body>
<div class="header-wrapper" role="banner">
<div class="header">
<div class="headertitle"><a
href="index.html">An Open Virtual Machine for Cross-Platform Weather Radar Science</a></div>
<div class="rel" role="navigation" aria-label="related navigation">
<a href="features.html" title="Features"
accesskey="P">previous</a> |
<a href="downloads.html" title="Downloads"
accesskey="N">next</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="quick-start">
<h1>Quick start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h1>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">We do no longer support 32-bit environments!</p>
</div>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p>Install <a class="reference external" href="https://www.virtualbox.org">VirtualBox</a> and <a class="reference internal" href="downloads.html"><span class="doc">download
the latest VM image</span></a>.</p>
</div>
<div class="section" id="import-the-vm-in-virtualbox">
<h2>Import the VM in VirtualBox<a class="headerlink" href="#import-the-vm-in-virtualbox" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Start VirtualBox.</li>
<li>From the File menu, choose <code class="docutils literal notranslate"><span class="pre">Import</span> <span class="pre">Appliance</span></code>.</li>
<li>Choose the <cite>*.ova</cite> file which you downloaded above</li>
<li>Check <code class="docutils literal notranslate"><span class="pre">Appliance</span> <span class="pre">Settings</span></code>: make sure that <em>“Guest OS Type”</em> “Debian (64bit)”.</li>
<li><em>optional</em>: under <code class="docutils literal notranslate"><span class="pre">Appliance</span> <span class="pre">Settings</span></code>, you can increase RAM to 4096 MB
(only recommended if your OS has more than 6 GB RAM).</li>
<li>Click <code class="docutils literal notranslate"><span class="pre">Import</span></code>, wait for the VM to import. The VM should appear on the left sidebar.</li>
</ul>
</div>
<div class="section" id="launch-the-vm">
<h2>Launch the VM<a class="headerlink" href="#launch-the-vm" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>In VirtualBox, select the appliance and click the <code class="docutils literal notranslate"><span class="pre">Start</span></code> button.</li>
<li>Wait for VM to boot, then login as user <code class="docutils literal notranslate"><span class="pre">vagrant</span></code> with password <code class="docutils literal notranslate"><span class="pre">vagrant</span></code>.</li>
<li>In some cases, it may be necessary to reboot the VM if nothing appears after a minute or so (use <code class="docutils literal notranslate"><span class="pre">Reset</span></code>).</li>
</ul>
</div>
<div class="section" id="start-jupyter">
<h2>Start jupyter<a class="headerlink" href="#start-jupyter" title="Permalink to this headline">¶</a></h2>
<p>Once you have logged into the VM, you can access the course materials by starting a jupyter notebook server.</p>
<p>However, the VM is currently in a phase of transition: it contains <strong>two Python environments</strong> which are required
by different packages.</p>
<p><strong>If you want to run BALTRAD or Radx notebooks, execute</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">./start_notebook.sh</span></code></p>
<p>which will run <code class="docutils literal notranslate"><span class="pre">jupyter</span></code> from within the system Python (2.7) environment.</p>
<p><strong>If you want to run Py-ART, wradlib, or PyTMatrix notebooks, execute</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">./start_notebook.sh</span> <span class="pre">openradar</span></code></p>
<p>which will run <code class="docutils literal notranslate"><span class="pre">jupyter</span></code> from within the <code class="docutils literal notranslate"><span class="pre">conda</span></code> Python 3.6 environment <code class="docutils literal notranslate"><span class="pre">openradar</span></code>.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">As a result of using seperate Python environments, the interoperability demos that run
BALTRAD, Py-ART and wradlib in <em>one</em> environment are currently not operational.</p>
</div>
</div>
<div class="section" id="run-jupyter-notebooks">
<h2>Run jupyter notebooks<a class="headerlink" href="#run-jupyter-notebooks" title="Permalink to this headline">¶</a></h2>
<p>After you have started <code class="docutils literal notranslate"><span class="pre">jupyter</span></code>, open a browser window on your host machine and
navigate to <a class="reference external" href="http://127.0.0.1:8888/tree">http://127.0.0.1:8888/tree</a>. For recent versions of <code class="docutils literal notranslate"><span class="pre">jupyter</span></code>
(i.e. when you used <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">./start_notebook.sh</span> <span class="pre">openradar</span></code>), you need to
copy and paste the <a class="reference external" href="https://jupyter-notebook.readthedocs.io/en/stable/security.html">secure token</a>
into the browser window. The secure token is shown in the VM terminal window.</p>
<p>If you are unable to copy and paste the secure token from the VM terminal into the browser,
you can set a password instead. Shut down the <code class="docutils literal notranslate"><span class="pre">jupyter</span></code> server in the VM terminal (<code class="docutils literal notranslate"><span class="pre">Ctrl+c</span></code>),
set a password via, and restart the server:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ source $CONDA_DIR/bin/activate openradar
(openradar) $ jupyter notebook password
Enter password:
Verify password:
...
$ ./start_notebook.sh openradar
</pre></div>
</div>
<p>In order to get started, you can choose from a selection of course notebooks.
See <a class="reference internal" href="courses.html"><span class="doc">here</span></a> for more details on available courses.</p>
</div>
<div class="section" id="having-any-problems">
<h2>Having any problems?<a class="headerlink" href="#having-any-problems" title="Permalink to this headline">¶</a></h2>
<p>There are a some known issues. Please see <a class="reference internal" href="knownissues.html"><span class="doc">here</span></a> how to address them.</p>
<p>If you are experiencing any other problems, please <a class="reference external" href="http://github.com/openradar/oss_weather_radar_vm/issues">raise an issue</a>.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h3>Table Of Contents</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="background.html">Background</a></li>
<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li>
<li class="toctree-l1"><a class="reference internal" href="build.html">Build the VM from source</a></li>
<li class="toctree-l1"><a class="reference internal" href="sharedir.html">Share data between guest and host</a></li>
<li class="toctree-l1"><a class="reference internal" href="courses.html">Courses</a></li>
<li class="toctree-l1"><a class="reference internal" href="community.html">Community</a></li>
<li class="toctree-l1"><a class="reference internal" href="team.html">Development Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="knownissues.html">Known Issues</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
<div role="search">
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<a href="features.html" title="Features"
>previous</a> |
<a href="downloads.html" title="Downloads"
>next</a>
</div>
<div role="note" aria-label="source link">
<br/>
<a href="_sources/quickstart.rst.txt"
rel="nofollow">Show Source</a>
</div>
</div>
<div class="right">
<div class="footer" role="contentinfo">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.4.
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</body>
</html>