Skip to content

Commit 58f3290

Browse files
AHartmaierAHartmaier
committed
Updated documentation
1 parent 16f1020 commit 58f3290

40 files changed

+1717
-1298
lines changed

‎docs/builds/doctrees/authors.doctree

-1.33 KB
Binary file not shown.

‎docs/builds/doctrees/environment.pickle

-1010 KB
Binary file not shown.

‎docs/builds/doctrees/kanapy.doctree

-3.13 KB
Binary file not shown.

‎docs/builds/doctrees/usage.doctree

86 Bytes
Binary file not shown.

‎docs/builds/html/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 1088bd2cd6ad06e0273ed970b573d402
3+
config: 0764df39882787b764dfdce0c6465641
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/builds/html/_modules/index.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Overview: module code &mdash; kanapy 6.3.0 documentation</title>
6+
<title>Overview: module code &mdash; kanapy 6.3.8 documentation</title>
77
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
88
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
99

@@ -14,8 +14,8 @@
1414

1515
<script src="../_static/jquery.js?v=5d32c60e"></script>
1616
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17-
<script src="../_static/documentation_options.js?v=80ea5fc2"></script>
18-
<script src="../_static/doctools.js?v=888ff710"></script>
17+
<script src="../_static/documentation_options.js?v=a3796ccd"></script>
18+
<script src="../_static/doctools.js?v=9a2dae69"></script>
1919
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
2020
<script src="../_static/js/theme.js"></script>
2121
<link rel="index" title="Index" href="../genindex.html" />
@@ -34,7 +34,7 @@
3434
kanapy
3535
</a>
3636
<div class="version">
37-
6.3.0
37+
6.3.8
3838
</div>
3939
<div role="search">
4040
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

‎docs/builds/html/_modules/kanapy/api.html

+231-82
Large diffs are not rendered by default.

‎docs/builds/html/_modules/kanapy/cli.html

+126-88
Large diffs are not rendered by default.

‎docs/builds/html/_modules/kanapy/collisions.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>kanapy.collisions &mdash; kanapy 6.3.0 documentation</title>
6+
<title>kanapy.collisions &mdash; kanapy 6.3.8 documentation</title>
77
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
88
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
99

@@ -14,8 +14,8 @@
1414

1515
<script src="../../_static/jquery.js?v=5d32c60e"></script>
1616
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17-
<script src="../../_static/documentation_options.js?v=80ea5fc2"></script>
18-
<script src="../../_static/doctools.js?v=888ff710"></script>
17+
<script src="../../_static/documentation_options.js?v=a3796ccd"></script>
18+
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1919
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2020
<script src="../../_static/js/theme.js"></script>
2121
<link rel="index" title="Index" href="../../genindex.html" />
@@ -34,7 +34,7 @@
3434
kanapy
3535
</a>
3636
<div class="version">
37-
6.3.0
37+
6.3.8
3838
</div>
3939
<div role="search">
4040
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

‎docs/builds/html/_modules/kanapy/entities.html

+14-14
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>kanapy.entities &mdash; kanapy 6.3.0 documentation</title>
6+
<title>kanapy.entities &mdash; kanapy 6.3.8 documentation</title>
77
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
88
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
99

@@ -14,8 +14,8 @@
1414

1515
<script src="../../_static/jquery.js?v=5d32c60e"></script>
1616
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17-
<script src="../../_static/documentation_options.js?v=80ea5fc2"></script>
18-
<script src="../../_static/doctools.js?v=888ff710"></script>
17+
<script src="../../_static/documentation_options.js?v=a3796ccd"></script>
18+
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1919
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2020
<script src="../../_static/js/theme.js"></script>
2121
<link rel="index" title="Index" href="../../genindex.html" />
@@ -34,7 +34,7 @@
3434
kanapy
3535
</a>
3636
<div class="version">
37-
6.3.0
37+
6.3.8
3838
</div>
3939
<div role="search">
4040
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -81,10 +81,9 @@
8181

8282
<h1>Source code for kanapy.entities</h1><div class="highlight"><pre>
8383
<span></span><span class="kn">import</span> <span class="nn">itertools</span>
84-
<span class="kn">import</span> <span class="nn">logging</span>
8584
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
8685
<span class="kn">import</span> <span class="nn">random</span>
87-
<span class="kn">from</span> <span class="nn">kanapy.collisions</span> <span class="kn">import</span> <span class="n">collision_react</span><span class="p">,</span> <span class="n">collision_routine</span>
86+
<span class="kn">from</span> <span class="nn">kanapy.collisions</span> <span class="kn">import</span> <span class="n">collision_routine</span>
8887
<span class="kn">from</span> <span class="nn">scipy.spatial</span> <span class="kn">import</span> <span class="n">Delaunay</span>
8988

9089

@@ -190,7 +189,7 @@ <h1>Source code for kanapy.entities</h1><div class="highlight"><pre>
190189
<span class="bp">self</span><span class="o">.</span><span class="n">speedx</span> <span class="o">=</span> <span class="mf">0.</span>
191190
<span class="bp">self</span><span class="o">.</span><span class="n">speedy</span> <span class="o">=</span> <span class="mf">0.</span>
192191
<span class="bp">self</span><span class="o">.</span><span class="n">speedz</span> <span class="o">=</span> <span class="mf">0.</span>
193-
<span class="bp">self</span><span class="o">.</span><span class="n">rotationMatrixGen</span><span class="p">()</span> <span class="c1"># Initialize roatation matrix for the ellipsoid</span>
192+
<span class="bp">self</span><span class="o">.</span><span class="n">rotation_matrix</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rotationMatrixGen</span><span class="p">()</span> <span class="c1"># Initialize roatation matrix for the ellipsoid</span>
194193
<span class="bp">self</span><span class="o">.</span><span class="n">surface_points</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">surfacePointsGen</span><span class="p">()</span> <span class="c1"># Initialize surface points for the ellipsoid</span>
195194
<span class="bp">self</span><span class="o">.</span><span class="n">inside_voxels</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># List that stores voxels belonging to the ellipsoid</span>
196195
<span class="bp">self</span><span class="o">.</span><span class="n">set_cub</span><span class="p">()</span> <span class="c1"># sets particle cuboid for collision testing with octree boxes</span>
@@ -253,6 +252,8 @@ <h1>Source code for kanapy.entities</h1><div class="highlight"><pre>
253252

254253
<span class="n">w</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">quat</span>
255254
<span class="n">Nq</span> <span class="o">=</span> <span class="n">w</span> <span class="o">*</span> <span class="n">w</span> <span class="o">+</span> <span class="n">x</span> <span class="o">*</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span> <span class="o">*</span> <span class="n">y</span> <span class="o">+</span> <span class="n">z</span> <span class="o">*</span> <span class="n">z</span>
255+
<span class="k">if</span> <span class="n">Nq</span> <span class="o">&lt;</span> <span class="n">FLOAT_EPS</span><span class="p">:</span>
256+
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">eye</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
256257

257258
<span class="n">s</span> <span class="o">=</span> <span class="mf">2.0</span> <span class="o">/</span> <span class="n">Nq</span>
258259
<span class="n">X</span> <span class="o">=</span> <span class="n">x</span> <span class="o">*</span> <span class="n">s</span>
@@ -268,12 +269,9 @@ <h1>Source code for kanapy.entities</h1><div class="highlight"><pre>
268269
<span class="n">yZ</span> <span class="o">=</span> <span class="n">y</span> <span class="o">*</span> <span class="n">Z</span>
269270
<span class="n">zZ</span> <span class="o">=</span> <span class="n">z</span> <span class="o">*</span> <span class="n">Z</span>
270271

271-
<span class="k">if</span> <span class="n">Nq</span> <span class="o">&lt;</span> <span class="n">FLOAT_EPS</span><span class="p">:</span>
272-
<span class="bp">self</span><span class="o">.</span><span class="n">rotation_matrix</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">eye</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
273-
<span class="k">else</span><span class="p">:</span>
274-
<span class="bp">self</span><span class="o">.</span><span class="n">rotation_matrix</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">1.0</span> <span class="o">-</span> <span class="p">(</span><span class="n">yY</span> <span class="o">+</span> <span class="n">zZ</span><span class="p">),</span> <span class="n">xY</span> <span class="o">-</span> <span class="n">wZ</span><span class="p">,</span> <span class="n">xZ</span> <span class="o">+</span> <span class="n">wY</span><span class="p">],</span>
275-
<span class="p">[</span><span class="n">xY</span> <span class="o">+</span> <span class="n">wZ</span><span class="p">,</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="p">(</span><span class="n">xX</span> <span class="o">+</span> <span class="n">zZ</span><span class="p">),</span> <span class="n">yZ</span> <span class="o">-</span> <span class="n">wX</span><span class="p">],</span>
276-
<span class="p">[</span><span class="n">xZ</span> <span class="o">-</span> <span class="n">wY</span><span class="p">,</span> <span class="n">yZ</span> <span class="o">+</span> <span class="n">wX</span><span class="p">,</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="p">(</span><span class="n">xX</span> <span class="o">+</span> <span class="n">yY</span><span class="p">)]])</span></div>
272+
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">1.0</span> <span class="o">-</span> <span class="p">(</span><span class="n">yY</span> <span class="o">+</span> <span class="n">zZ</span><span class="p">),</span> <span class="n">xY</span> <span class="o">-</span> <span class="n">wZ</span><span class="p">,</span> <span class="n">xZ</span> <span class="o">+</span> <span class="n">wY</span><span class="p">],</span>
273+
<span class="p">[</span><span class="n">xY</span> <span class="o">+</span> <span class="n">wZ</span><span class="p">,</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="p">(</span><span class="n">xX</span> <span class="o">+</span> <span class="n">zZ</span><span class="p">),</span> <span class="n">yZ</span> <span class="o">-</span> <span class="n">wX</span><span class="p">],</span>
274+
<span class="p">[</span><span class="n">xZ</span> <span class="o">-</span> <span class="n">wY</span><span class="p">,</span> <span class="n">yZ</span> <span class="o">+</span> <span class="n">wX</span><span class="p">,</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="p">(</span><span class="n">xX</span> <span class="o">+</span> <span class="n">yY</span><span class="p">)]])</span></div>
277275

278276

279277
<div class="viewcode-block" id="Ellipsoid.surfacePointsGen">
@@ -370,11 +368,13 @@ <h1>Source code for kanapy.entities</h1><div class="highlight"><pre>
370368

371369
<div class="viewcode-block" id="Ellipsoid.sync_poly">
372370
<a class="viewcode-back" href="../../kanapy.html#kanapy.entities.Ellipsoid.sync_poly">[docs]</a>
373-
<span class="k">def</span> <span class="nf">sync_poly</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mf">1.6</span><span class="p">):</span>
371+
<span class="k">def</span> <span class="nf">sync_poly</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
374372
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
375373
<span class="sd"> Moves the center of the polygon to the center of the ellipsoid and</span>
376374
<span class="sd"> scales the hull to fit inside the ellipsoid</span>
377375
<span class="sd"> &quot;&quot;&quot;</span>
376+
<span class="k">if</span> <span class="n">scale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
377+
<span class="kn">from</span> <span class="nn">kanapy</span> <span class="kn">import</span> <span class="n">poly_scale</span> <span class="k">as</span> <span class="n">scale</span>
378378
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">inner</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
379379
<span class="k">return</span>
380380
<span class="n">opts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">inner</span><span class="o">.</span><span class="n">points</span>

0 commit comments

Comments
 (0)