-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathinstallation.html
More file actions
163 lines (142 loc) · 9.23 KB
/
installation.html
File metadata and controls
163 lines (142 loc) · 9.23 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
<!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>3. Downloading and Installation — Raysect Documentation</title>
<link rel="stylesheet" href="_static/theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/RaysectLogo_web.ico"/>
<script src="_static/documentation_options.js?v=39bb1c6d"></script>
<script src="_static/doctools.js?v=9bcbadda"></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="4. How it works" href="how_it_works.html" />
<link rel="prev" title="2. License" href="license.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">
Raysect
<img src="_static/RaysectLogo_web.png" class="logo" alt="Logo"/>
</a>
<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">
<p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">2. License</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">3. Downloading and Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#prerequisites">3.1. Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation">3.2. Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#testing">3.3. Testing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="how_it_works.html">4. How it works</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart_guide.html">5. Quickstart Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="observers.html">6. Sampling and Observers</a></li>
<li class="toctree-l1"><a class="reference internal" href="primitives.html">7. Primitives</a></li>
<li class="toctree-l1"><a class="reference internal" href="materials.html">8. Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="conventions.html">9. Conventions</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">10. References</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">11. Glossary</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Demonstrations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html">1. Core Functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#materials">2. Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#observers">3. Observers</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#optics">4. Optics</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_reference/core/core.html">1. Raysect Core</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/primitives/primitives.html">2. Primitives Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/optical/optical.html">3. Optical Module</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">Raysect</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"><span class="section-number">3. </span>Downloading and 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="downloading-and-installation">
<h1><span class="section-number">3. </span>Downloading and Installation<a class="headerlink" href="#downloading-and-installation" title="Link to this heading">¶</a></h1>
<section id="prerequisites">
<h2><span class="section-number">3.1. </span>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
<p>The Raysect package requires Python 3.3+, numpy, scipy and matplotlib. Scipy version 0.13 or
higher is recommended. Raysect has not been tested on Python 2, currently support for Python
2 is not planned. IPython is recommended for interactive use.</p>
</section>
<section id="installation">
<h2><span class="section-number">3.2. </span>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
<p>Raysect is available from the python package repository <a class="reference external" href="https://pypi.python.org/pypi/raysect">pypi</a>. The easiest way to install Raysect is using <a class="reference external" href="https://pip.pypa.io/en/stable/">pip</a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">raysect</span>
</pre></div>
</div>
<p>If pip is not available, the source files can be downloaded from <a class="reference external" href="https://pypi.python.org/pypi/raysect">pypi</a> or from our <a class="reference external" href="https://github.com/raysect/source">development repository</a>. Once you have the source files, locate the folder containing setup.py and run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>
</div>
<p>If all the required dependencies are present (cython, numpy, scipy and matplotlib), this should start the Raysect compilation and installation process.</p>
<p>If you would like to play with the bleeding-edge code or contribute to development, please see the Raysect development repository on <a class="reference external" href="https://github.com/raysect/source">github</a>.</p>
</section>
<section id="testing">
<h2><span class="section-number">3.3. </span>Testing<a class="headerlink" href="#testing" title="Link to this heading">¶</a></h2>
<p>A selection of test scripts can be run with the <cite>nose</cite> testing framework. These are routinely
run on the development version. Running <code class="docutils literal notranslate"><span class="pre">nosetests</span></code> at the terminal in the source directory
should run all of these tests to completion without errors or failures.</p>
<p>Many of the demos used throughout the Raysect documentation are distributed with the source code in
the <code class="docutils literal notranslate"><span class="pre">demo</span></code> folder.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="license.html" class="btn btn-neutral float-left" title="2. License" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="how_it_works.html" class="btn btn-neutral float-right" title="4. How it works" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2014-2025, Dr Alex Meakins.</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>