-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathinstallation.html
More file actions
184 lines (164 loc) · 10.8 KB
/
installation.html
File metadata and controls
184 lines (164 loc) · 10.8 KB
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
<!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>Installation — CDTools 0.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<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=938c9ccc"></script>
<script src="_static/doctools.js?v=9a2dae69"></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="Examples" href="examples.html" />
<link rel="prev" title="Introduction to CDTools" href="index.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">
CDTools
</a>
<div class="version">
0.2
</div>
<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 class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Introduction to CDTools</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#step-1-download">Step 1: Download</a></li>
<li class="toctree-l2"><a class="reference internal" href="#step-2-install-dependencies">Step 2: Install Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="#step-3-install">Step 3: Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="#step-4-run-the-tests">Step 4: Run The Tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</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="general.html">General Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="models.html">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="tools/index.html">Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="indices_tables.html">Indices and tables</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">CDTools</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">Installation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/installation.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="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
<section id="step-1-download">
<h2>Step 1: Download<a class="headerlink" href="#step-1-download" title="Link to this heading"></a></h2>
<p>The source code for CDTools is hosted on <a class="reference external" href="https://github.com/cdtools-developers/cdtools">Github</a>. At the moment, the repository remains private while we decide on licensing. Access can be granted upon request by contacting <a class="reference external" href="mailto:alevitan%40mit.edu">Abe Levitan</a>.</p>
<p>The repository remains under active development as of late 2024.</p>
</section>
<section id="step-2-install-dependencies">
<h2>Step 2: Install Dependencies<a class="headerlink" href="#step-2-install-dependencies" title="Link to this heading"></a></h2>
<p>CDTools is regularly tested with Python versions 3.8 to 3.12, so it is recommended to use one of these versions. In general, CDTools requires Python 3.7 or higher.</p>
<p>The major dependency for CDTools is pytorch (version 1.9.0 or greater). Because the details of the installation can vary depending on platform, GPU availability, etc, it is recommended that you follow the install instructions on <a class="reference external" href="https://pytorch.org/get-started/locally/">the pytorch site</a> to install pytorch before installing the remaining dependencies.</p>
<p>pytorch stopped supporting installation using conda for installation, so it is recommended continue the installation using pip.</p>
<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>-r<span class="w"> </span>requirements.txt
</pre></div>
</div>
<p>This will install all required dependencies and verify that they meet the pytorch version requirements. Additionally, several optional dependencies used for testing and documentation will also be installed. The full set of dependencies and minimum requirements are listed below is listed below.</p>
<p>CDTools is reguarly tested with the latest versions of the packages shown below.</p>
<p>Required dependencies:</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference external" href="http://www.numpy.org">numpy</a> >= 1.0</p></li>
<li><p><a class="reference external" href="http://www.scipy.org">scipy</a> >= 1.0</p></li>
<li><p><a class="reference external" href="https://matplotlib.org">matplotlib</a> >= 2.0</p></li>
<li><p><a class="reference external" href="https://pytorch.org">pytorch</a> >= 1.9.0</p></li>
<li><p><a class="reference external" href="https://github.com/dateutil/dateutil/">python-dateutil</a></p></li>
<li><p><a class="reference external" href="https://www.h5py.org/">h5py</a> >= 2.1</p></li>
</ul>
</div></blockquote>
<p>Optional dependencies:</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference external" href="https://docs.pytest.org/">pytest</a></p></li>
<li><p><a class="reference external" href="https://www.fatiando.org/pooch/latest/">pooch</a></p></li>
<li><p><a class="reference external" href="https://www.sphinx-doc.org/">sphinx</a> >= 4.3.0</p></li>
<li><p><a class="reference external" href="https://sphinx-argparse.readthedocs.io">sphinx-argparse</a></p></li>
<li><p><a class="reference external" href="https://sphinx-rtd-theme.readthedocs.io/en/stable/">sphinx_rtd_theme</a> >= 0.5.1</p></li>
</ul>
</div></blockquote>
<p>The file “example_environment.yml”, included in the repository’s top level directory, contains an example of an environment with all dependencies properly installed on a linux machine with a GPU, circa early 2024.</p>
</section>
<section id="step-3-install">
<h2>Step 3: Install<a class="headerlink" href="#step-3-install" title="Link to this heading"></a></h2>
<p>To install CDTools, run the following command from the top level directory (the directory including the setup.py file).</p>
<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>.<span class="w"> </span>--no-deps
</pre></div>
</div>
<p>This will install a copy of the code, as it exists at the moment of installation. If you would prefer for changes to the code to propagate to the installed version without reinstalling, install the package in developer mode:</p>
<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>-e<span class="w"> </span>.<span class="w"> </span>--no-deps
</pre></div>
</div>
</section>
<section id="step-4-run-the-tests">
<h2>Step 4: Run The Tests<a class="headerlink" href="#step-4-run-the-tests" title="Link to this heading"></a></h2>
<p>To ensure that the installation has worked correctly, it is recommended that you run the unit tests. After ensuring that pytest is installed, run the following command from the top level directory:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pytest
</pre></div>
</div>
<p>If any tests fail, make sure that you have all the noted dependencies properly installed. If you do, and things still aren’t working, <a class="reference external" href="mailto:alevitan%40mit.edu">send me (Abe Levitan) an email</a> and we’ll get to the bottom of it. CDTools has been tested on linux and mac, on CPU, CUDA, and MPS.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Introduction to CDTools" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="examples.html" class="btn btn-neutral float-right" title="Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2019-2024, Abraham Levitan.</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>