-
Notifications
You must be signed in to change notification settings - Fork 0
/
Installation.html
151 lines (137 loc) · 6.09 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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Installation — mcvine 1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head><body>
<div class="header">
<table><tr>
<!--
<td>
<div style="text-align: left; padding: 7px 7px 10px 10px">
<a href="index.html"><img src="_static/mcvine.png" border="0" alt="py4sci"
height="80"/></a>
</div>
</td>
-->
<td style="">
<div class="banner">MCViNE: Monte Carlo VIrtual Neutron Experiment</div>
</td>
</tr>
</table>
</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"
accesskey="I">index</a></li>
<li><a href="http://mcvine.org">MCViNE</a> » </li>
<li><a href="index.html">Documentation</a> » </li>
<li><a href="search.html">search</a> »</li>
<li class="nav-item nav-item-this"><a href="">Installation</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#optional-dependencies">Optional dependencies</a></li>
<li><a class="reference internal" href="#install-the-latest-unstable-build">Install the latest unstable build</a></li>
</ul>
</li>
</ul>
<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 id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="installation">
<span id="id1"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<p>MCViNE can be installed in most of recent linux distributions by using conda</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$ conda create -n mcvine <span class="nv">python</span><span class="o">=</span><span class="m">3</span>.6 <span class="c1"># create an environment for mcvine</span>
$ <span class="nb">source</span> activate mcvine <span class="c1"># activate mcvine environment</span>
$ conda config --add channels conda-forge <span class="c1"># add conda channels</span>
$ conda config --add channels diffpy
$ conda config --add channels mantid
$ conda config --add channels mcvine
$ conda install mcvine
</pre></div>
</div>
<p>To install conda on a linux distribution, please refer to
<a class="reference external" href="http://conda.pydata.org/docs/install/quick.html#linux-miniconda-install">miniconda quick install</a>.</p>
<p>If you want to build mcvine from source,
please refer to
<a class="reference external" href="https://github.com/mcvine/conda-recipes">the mcvine conda recipes</a>.</p>
<section id="optional-dependencies">
<h2>Optional dependencies<a class="headerlink" href="#optional-dependencies" title="Permalink to this headline">¶</a></h2>
<p>If we want to use MCPL data files from mcstas simulations, <cite>mcpl</cite> python
package need to be installed ($ pip install mcpl).</p>
<p>Other packages that may be useful</p>
<ul class="simple">
<li><p>lmfit</p></li>
<li><p>tqdm</p></li>
<li><p>awscli</p></li>
</ul>
</section>
<section id="install-the-latest-unstable-build">
<h2>Install the latest unstable build<a class="headerlink" href="#install-the-latest-unstable-build" title="Permalink to this headline">¶</a></h2>
<p>Latest build of mcvine can be installed by</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$ conda install -c mcvine/label/unstable mcvine <span class="nv">python</span><span class="o">=</span><span class="m">3</span>.6
</pre></div>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></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><a href="http://mcvine.org">MCViNE</a> » </li>
<li><a href="index.html">Documentation</a> » </li>
<li><a href="search.html">search</a> »</li>
<li class="nav-item nav-item-this"><a href="">Installation</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2006-2016, Jiao Lin, Michael Aivazis, and Brent Fultz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>