-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstall.html
222 lines (201 loc) · 13.4 KB
/
install.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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<!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>Installing OpenDrift — OpenDrift documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css" />
<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=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></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="Performance in OpenDrift" href="performance.html" />
<link rel="prev" title="History" href="history_link.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">
OpenDrift
<img src="_static/opendrift_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" 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">
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Introduction to OpenDrift</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="history_link.html">History</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installing OpenDrift</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#alternative-1-using-mambaforge-or-miniforge-and-git-recommended">Alternative 1: Using Mambaforge (or Miniforge) and Git (recommended)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#alternative-2-using-mambaforge-or-miniforge">Alternative 2: Using Mambaforge (or Miniforge)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#modify-install-to-use-git-version">Modify install to use Git version</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#building-and-using-the-docker-image">Building and using the Docker image</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="performance.html">Performance in OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html">Theory</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html#drift-in-the-ocean">Drift in the Ocean</a></li>
<li class="toctree-l1"><a class="reference internal" href="choosing_a_model.html">How to choose which model to use</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_a_new_model.html">How to write a new module</a></li>
<li class="toctree-l1"><a class="reference internal" href="gallery/index.html">Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="oil_types.html">Oil types</a></li>
<li class="toctree-l1"><a class="reference internal" href="interaction_with_coastline.html">Interaction with coastline</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using OpenDrift in a container</a></li>
<li class="toctree-l1"><a class="reference internal" href="gui.html">Graphical User Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="services.html">Services using OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="autoapi/index.html">API Reference</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">OpenDrift</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">Installing OpenDrift</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/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="installing-opendrift">
<h1>Installing OpenDrift<a class="headerlink" href="#installing-opendrift" title="Link to this heading"></a></h1>
<section id="alternative-1-using-mambaforge-or-miniforge-and-git-recommended">
<h2>Alternative 1: Using Mambaforge (or Miniforge) and Git (recommended)<a class="headerlink" href="#alternative-1-using-mambaforge-or-miniforge-and-git-recommended" title="Link to this heading"></a></h2>
<ol class="arabic simple">
<li><p>Install <a class="reference external" href="https://conda-forge.org/miniforge/">miniforge</a></p></li>
<li><p>Clone OpenDrift:</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/OpenDrift/opendrift.git
$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>opendrift/
</pre></div>
</div>
<ol class="arabic simple" start="3">
<li><p>Create environment with the required dependencies and install OpenDrift</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mamba<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-f<span class="w"> </span>environment.yml
$<span class="w"> </span>conda<span class="w"> </span>activate<span class="w"> </span>opendrift
$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>--no-deps<span class="w"> </span>-e<span class="w"> </span>.
</pre></div>
</div>
<p>This installs the OpenDrift package as an editable package. You can therefore directly make changes to the repository or fetch the newest changes with <code class="code docutils literal notranslate"><span class="pre">git</span> <span class="pre">pull</span></code>. You do not need to add OpenDrift to PYTHONPATH as long as you have the <code class="code docutils literal notranslate"><span class="pre">opendrift</span></code> environment activated.</p>
<p>Occasionally, new dependencies will be added to environment.yml. Then the local conda environment can be updated with:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mamba<span class="w"> </span>env<span class="w"> </span>update<span class="w"> </span>-f<span class="w"> </span>environment.yml
</pre></div>
</div>
</section>
<section id="alternative-2-using-mambaforge-or-miniforge">
<h2>Alternative 2: Using Mambaforge (or Miniforge)<a class="headerlink" href="#alternative-2-using-mambaforge-or-miniforge" title="Link to this heading"></a></h2>
<ol class="arabic simple">
<li><p>Install <a class="reference external" href="https://conda-forge.org/miniforge/">miniforge</a></p></li>
<li><p>Set up a <em>Python 3</em> environment for opendrift and install opendrift</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mamba<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span>opendrift<span class="w"> </span><span class="nv">python</span><span class="o">=</span><span class="m">3</span><span class="w"> </span>opendrift
$<span class="w"> </span>conda<span class="w"> </span>activate<span class="w"> </span>opendrift
</pre></div>
</div>
<section id="modify-install-to-use-git-version">
<span id="source-install"></span><h3>Modify install to use Git version<a class="headerlink" href="#modify-install-to-use-git-version" title="Link to this heading"></a></h3>
<p>If you later want to edit the OpenDrift source code, or be able to update from repository with <cite>git pull</cite>, the following two steps are necessary. This yields the same as Alternative 1.</p>
<ol class="arabic simple" start="3">
<li><p>Clone OpenDrift:</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/OpenDrift/opendrift.git
$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>opendrift/
</pre></div>
</div>
<ol class="arabic simple" start="4">
<li><p>Remove original package:</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mamba<span class="w"> </span>remove<span class="w"> </span>--force<span class="w"> </span>opendrift
</pre></div>
</div>
<ol class="arabic simple" start="5">
<li><p>Install as editable:</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>--no-deps<span class="w"> </span>-e<span class="w"> </span>.
</pre></div>
</div>
</section>
</section>
<section id="building-and-using-the-docker-image">
<h2>Building and using the Docker image<a class="headerlink" href="#building-and-using-the-docker-image" title="Link to this heading"></a></h2>
<p>It is also possible to run OpenDrift in a <a class="reference external" href="https://www.docker.com/">docker</a>
container. You can either use the <a class="reference external" href="https://hub.docker.com/r/opendrift/opendrift">pre-built images (each release or latest
master)</a>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-it<span class="w"> </span>--rm<span class="w"> </span>opendrift/opendrift:latest
</pre></div>
</div>
<p>or if you want to re-build the image using your local version of opendrift, check out opendrift and make your changes, then:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/OpenDrift/opendrift.git
$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>opendrift/
</pre></div>
</div>
<p>re-build the image:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>docker<span class="w"> </span>build<span class="w"> </span>-t<span class="w"> </span>opendrift<span class="w"> </span>.
</pre></div>
</div>
<p>and run it:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-it<span class="w"> </span>--rm<span class="w"> </span>opendrift
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="history_link.html" class="btn btn-neutral float-left" title="History" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="performance.html" class="btn btn-neutral float-right" title="Performance in OpenDrift" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2020, Knut-Frode Dagestad ([email protected]) and Gaute Hope ([email protected])..</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>