-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathintroduction.html
More file actions
178 lines (157 loc) · 9.61 KB
/
introduction.html
File metadata and controls
178 lines (157 loc) · 9.61 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
<!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>1. Introduction — 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="2. License" href="license.html" />
<link rel="prev" title="Welcome" 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">
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 current"><a class="current reference internal" href="#">1. Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#what-is-raysect">1.1. What is raysect</a></li>
<li class="toctree-l2"><a class="reference internal" href="#feature-set">1.2. Feature set</a></li>
<li class="toctree-l2"><a class="reference internal" href="#structure-architecture">1.3. Structure/Architecture</a></li>
<li class="toctree-l2"><a class="reference internal" href="#contributions">1.4. Contributions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">2. License</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">3. Downloading and Installation</a></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">1. </span>Introduction</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/introduction.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="introduction">
<h1><span class="section-number">1. </span>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h1>
<section id="what-is-raysect">
<h2><span class="section-number">1.1. </span>What is raysect<a class="headerlink" href="#what-is-raysect" title="Link to this heading">¶</a></h2>
<p>Raysect is an open-source python framework for geometrical optical simulations. It is designed
to be a physically realistic ray-tracer generally applicable to research problems in science
and engineering. A core philosophy at the heart of Raysect’s design is that scientific robustness
and flexibility takes precedence over speed. For other use cases where speed is more important
there are plenty of suitable ray-tracers, such as Povray for example. Raysect has been designed
to be easy to extend by a physicist/engineer.</p>
</section>
<section id="feature-set">
<h2><span class="section-number">1.2. </span>Feature set<a class="headerlink" href="#feature-set" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Path tracer for efficient configurable ray-tracing.</p></li>
<li><p>Full scenegraph for managing complex geometry and coordinate transforms.</p></li>
<li><p>A complete set of geometric primitives, lens types, meshes and CSG operations.</p></li>
<li><p>A wide range of simulated physical observers such as CCDs, cameras, fibreoptics, etc.</p></li>
<li><p>Advanced optical material models, an associated material library (BRDFs), metals, glasses.</p></li>
<li><p>Supports serial or multi-core operation. MPI not currently supported.</p></li>
<li><p>Geometric optics => ray simulations with prisims, lenses, etc.</p></li>
</ul>
</section>
<section id="structure-architecture">
<h2><span class="section-number">1.3. </span>Structure/Architecture<a class="headerlink" href="#structure-architecture" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Raysect is an OOP framework written in a combination of python and cython. All major functionality
is accessible from python. It is possible to extend all components from python, however to gain full
speed, the cython api should be used.</p></li>
<li><p>The core of raysect is actually completely generalised and can be used for other ray-tracing applications
such as neutron transport, etc. However, at the present time the optical model is the only application
which has been implemented.</p></li>
<li><p>The core of Raysect is a generalised kernel for calculating interactions with rays and or volumes onto
which physics models that require raytracing (such as geometric optics) can be built.</p></li>
</ul>
</section>
<section id="contributions">
<h2><span class="section-number">1.4. </span>Contributions<a class="headerlink" href="#contributions" title="Link to this heading">¶</a></h2>
<p>Anyone is welcome to make contributions to Raysect using the standard OpenSource git workflow.
Contributing developers should fork Raysect into their own github account and develop on their own
local branches. Code can be periodically merged through pull requests. Anyone can contribute bug
reports and documentation ideas through our <a class="reference external" href="https://github.com/raysect/source/issues">github issue queue</a>.</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="Welcome" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="license.html" class="btn btn-neutral float-right" title="2. License" 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>