-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstallation.html
176 lines (157 loc) · 7.38 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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<!-- Licensed under the Apache 2.0 License -->
<link rel="stylesheet" type="text/css" href="_static/fonts/open-sans/stylesheet.css" />
<!-- Licensed under the SIL Open Font License -->
<link rel="stylesheet" type="text/css" href="_static/fonts/source-serif-pro/source-serif-pro.css" />
<link rel="stylesheet" type="text/css" href="_static/css/bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/bootstrap-theme.min.css" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installation — XVOF documentation</title>
<link rel="stylesheet" href="_static/guzzle.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" 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/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Case creation" href="case_creation.html" />
<link rel="prev" title="XVOF Documentation" href="documentation.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="case_creation.html" title="Case creation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="documentation.html" title="XVOF Documentation"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">XVOF documentation</a> »</li>
</ul>
</div>
<div class="container-wrapper">
<div id="mobile-toggle">
<a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
</div>
<div id="left-column">
<div class="sphinxsidebar">
<h4>Previous topic</h4>
<p class="topless"><a href="documentation.html"
title="previous chapter">XVOF Documentation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="case_creation.html"
title="next chapter">Case creation</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/installation.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div class="sidebar-block">
<div class="sidebar-wrapper">
<div id="main-search">
<form class="form-inline" action="search.html" method="GET" role="form">
<div class="input-group">
<input name="q" type="text" class="form-control" placeholder="Search...">
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
</div>
</div>
<div id="right-column">
<div role="navigation" aria-label="breadcrumbs navigation">
<ol class="breadcrumb">
<li><a href="index.html">Docs</a></li>
<li>Installation</li>
</ol>
</div>
<div class="document clearer body">
<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li>Download the GitHub XVOF repository (<cite>git clone</cite> or download)</li>
<li>Install pyenv with a python version > 3.7 (follow instructions in <a class="reference external" href="https://github.com/pyenv/pyenv#installation">https://github.com/pyenv/pyenv#installation</a>). This will enable to modify the python of pyenv instead of the system python</li>
<li>Install cmake and swig :</li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">cmake</span>
<span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">swig</span>
</pre></div>
</div>
<p>Cmake will enable to build the C library for the eos computation and SWIG translates it as a python module
Cmake version should be > 3.12.</p>
<ul class="simple">
<li>To activate python of pyenv :</li>
</ul>
<p>from XVOF repository type</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pyenv</span> <span class="n">local</span> <span class="mf">3.7</span><span class="o">.</span><span class="mi">7</span>
</pre></div>
</div>
<p>(python3.8 can currently create bug when installing the library C for equation of state, so it is recommended to use 3.7 version)</p>
<ul class="simple">
<li>To install the XVOF code and dependencies :</li>
</ul>
<p>from XVOF repository type :</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">pip</span>
<span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="o">.</span>
</pre></div>
</div>
<p>This will also build the lib C for equation of state computation.</p>
</div>
</div>
<div class="footer-relations">
<div class="pull-left">
<a class="btn btn-default" href="documentation.html" title="previous chapter (use the left arrow)">XVOF Documentation</a>
</div>
<div class="pull-right">
<a class="btn btn-default" href="case_creation.html" title="next chapter (use the right arrow)">Case creation</a>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearfix"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="case_creation.html" title="Case creation"
>next</a> |</li>
<li class="right" >
<a href="documentation.html" title="XVOF Documentation"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">XVOF documentation</a> »</li>
</ul>
</div>
<script type="text/javascript">
$("#mobile-toggle a").click(function () {
$("#left-column").toggle();
});
</script>
<script type="text/javascript" src="_static/js/bootstrap.js"></script>
<div class="footer">
© Copyright 2020, M. Gorecki, G. Peillex. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>