-
Notifications
You must be signed in to change notification settings - Fork 0
/
install.html
156 lines (146 loc) · 6.53 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
<!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 — dcEmb v0.1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/embecosm-theme.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" />
<link rel="next" title="Testing Suite" href="testingsuite.html" />
<link rel="prev" title="Building Your Own model" href="howto.html" />
</head><body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="Embecosm Logo" width="185" height="75"/></a>
</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 class="right" >
<a href="testingsuite.html" title="Testing Suite"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="howto.html" title="Building Your Own model"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">dcEmb v0.1.0 documentation</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>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="currentmodels.html">Current Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="doxygen.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto.html">Building Your Own model</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="#dependencies">Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="#platforms">Platforms</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="testingsuite.html">Testing Suite</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/install.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="install"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<p>The software has been designed to have no requirements to build beyond a modern
C++ compiler and (currently) CMake, and should be fairly straightforward to
build on any modern platform.</p>
<section id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Cmake</p></li>
<li><p>C++ 14 compatible compiler</p></li>
<li><p>Git</p></li>
</ul>
</section>
<section id="platforms">
<h2>Platforms<a class="headerlink" href="#platforms" title="Permalink to this headline">¶</a></h2>
<section id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h3>
<ol class="arabic simple">
<li><p>Clone the repository</p></li>
<li><p>Initialise git submodules (git submodule update --init)</p></li>
<li><p>Create and navigate into a build directory (mkdir build && cd build)</p></li>
<li><p>Run CMake (cmake .. && cmake --build)</p></li>
<li><p>Run the executable of your choice (e.g, ./dcm_3body)</p></li>
</ol>
</section>
<section id="mac">
<h3>Mac<a class="headerlink" href="#mac" title="Permalink to this headline">¶</a></h3>
<ol class="arabic simple">
<li><p>Clone the repository</p></li>
<li><p>Initialise git submodules (git submodule update --init)</p></li>
<li><p>Create and navigate into a build directory (mkdir build && cd build)</p></li>
<li><p>Run CMake (cmake .. && cmake --build)</p></li>
<li><p>Run the executable of your choice (e.g, ./dcm_3body)</p></li>
</ol>
</section>
<section id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
<p>WIP</p>
</section>
</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 class="right" >
<a href="testingsuite.html" title="Testing Suite"
>next</a> |</li>
<li class="right" >
<a href="howto.html" title="Building Your Own model"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">dcEmb v0.1.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Installation</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2022, William Jones.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.1.
</div>
</body>
</html>