-
Notifications
You must be signed in to change notification settings - Fork 185
/
installation.html
144 lines (133 loc) · 7.44 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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installing matminer — matminer 0.7.6 documentation</title>
<link rel="stylesheet" href="_static/nature.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 href='https://fonts.googleapis.com/css?family=Lato:400,700' rel='stylesheet' type='text/css'>
</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="nav-item nav-item-0"><a href="index.html">matminer 0.7.6 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Installing matminer</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="installing-matminer">
<span id="installation-tutorial"></span><h1>Installing matminer<a class="headerlink" href="#installing-matminer" title="Permalink to this headline">¶</a></h1>
<p>Matminer requires Python 3.6+.</p>
<p>There are a couple of quick and easy ways to install matminer (see also some <strong>tips</strong> below):</p>
<div class="section" id="install-and-update-via-pip">
<h2>Install and update via pip<a class="headerlink" href="#install-and-update-via-pip" title="Permalink to this headline">¶</a></h2>
<p>If you have installed pip, simply run the command in a bash terminal:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install matminer
</pre></div>
</div>
<p>or, to install matminer in your user home folder, run the command:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install matminer --user
</pre></div>
</div>
<p>To update matminer, simply type <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">--upgrade</span> <span class="pre">matminer</span></code>.</p>
</div>
<div class="section" id="install-in-development-mode">
<h2>Install in development mode<a class="headerlink" href="#install-in-development-mode" title="Permalink to this headline">¶</a></h2>
<p>To install from the latest source of the matminer code in developmental mode, clone the Git source:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/hackingmaterials/matminer.git
</pre></div>
</div>
<p>and then enter the cloned repository/folder to install in developer mode:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> matminer
$ python setup.py develop
</pre></div>
</div>
<p>To update matminer, enter your cloned folder and type <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">pull</span></code> followed by <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">develop</span></code>.</p>
</div>
<div class="section" id="tips">
<h2>Tips<a class="headerlink" href="#tips" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p>Make sure you are using Python 3.6 or higher</p></li>
<li><p>If you have trouble with the installation of a component library (sympy, pymatgen, mdf-forge, etc.), you can try to run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre"><<component>></span></code> or (if you are using <a class="reference external" href="https://www.anaconda.com/distribution/">Anaconda</a>) <code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">install</span> <span class="pre"><<component>></span></code> first, and then re-try the installation.</p>
<blockquote>
<div><ul class="simple">
<li><p>For example, installing pymatgen on a Windows platform is easiest with Anaconda via <code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">install</span> <span class="pre">-c</span> <span class="pre">conda-forge</span> <span class="pre">pymatgen</span></code>.</p></li>
</ul>
</div></blockquote>
</li>
<li><p>If you still have trouble, open up a a ticket on our <a class="reference external" href="https://discuss.matsci.org/c/matminer">forum</a> describing your problem in full (including your system specifications, Python version information, and input/output log). There is a good likelihood that someone else is running into the same issue, and by posting it on the forum we can help make the documentation clearer and smoother.</p></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</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="#">Installing matminer</a><ul>
<li><a class="reference internal" href="#install-and-update-via-pip">Install and update via pip</a></li>
<li><a class="reference internal" href="#install-in-development-mode">Install in development mode</a></li>
<li><a class="reference internal" href="#tips">Tips</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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</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 class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.7.6 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Installing matminer</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2015, Anubhav Jain.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>