Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@AHartmaier
AHartmaier committed Oct 27, 2024
1 parent 16f1020 commit 58f3290
Show file tree
Hide file tree
Showing 40 changed files with 1,717 additions and 1,298 deletions.
Binary file modified docs/builds/doctrees/authors.doctree
View file
Binary file not shown.
Binary file modified docs/builds/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/builds/doctrees/kanapy.doctree
View file
Binary file not shown.
Binary file modified docs/builds/doctrees/usage.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/builds/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 1088bd2cd6ad06e0273ed970b573d402
config: 0764df39882787b764dfdce0c6465641
tags: 645f666f9bcd5a90fca523b33c5a78b7
8 changes: 4 additions & 4 deletions docs/builds/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; kanapy 6.3.0 documentation</title>
<title>Overview: module code &mdash; kanapy 6.3.8 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" />

Expand All @@ -14,8 +14,8 @@

<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=80ea5fc2"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/documentation_options.js?v=a3796ccd"></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" />
Expand All @@ -34,7 +34,7 @@
kanapy
</a>
<div class="version">
6.3.0
6.3.8
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
313 changes: 231 additions & 82 deletions docs/builds/html/_modules/kanapy/api.html
View file

Large diffs are not rendered by default.

214 changes: 126 additions & 88 deletions docs/builds/html/_modules/kanapy/cli.html
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/builds/html/_modules/kanapy/collisions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kanapy.collisions &mdash; kanapy 6.3.0 documentation</title>
<title>kanapy.collisions &mdash; kanapy 6.3.8 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" />

Expand All @@ -14,8 +14,8 @@

<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=80ea5fc2"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/documentation_options.js?v=a3796ccd"></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" />
Expand All @@ -34,7 +34,7 @@
kanapy
</a>
<div class="version">
6.3.0
6.3.8
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
28 changes: 14 additions & 14 deletions docs/builds/html/_modules/kanapy/entities.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kanapy.entities &mdash; kanapy 6.3.0 documentation</title>
<title>kanapy.entities &mdash; kanapy 6.3.8 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" />

Expand All @@ -14,8 +14,8 @@

<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=80ea5fc2"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/documentation_options.js?v=a3796ccd"></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" />
Expand All @@ -34,7 +34,7 @@
kanapy
</a>
<div class="version">
6.3.0
6.3.8
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down Expand Up @@ -81,10 +81,9 @@

<h1>Source code for kanapy.entities</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">itertools</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">random</span>
<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>
<span class="kn">from</span> <span class="nn">kanapy.collisions</span> <span class="kn">import</span> <span class="n">collision_routine</span>
<span class="kn">from</span> <span class="nn">scipy.spatial</span> <span class="kn">import</span> <span class="n">Delaunay</span>


Expand Down Expand Up @@ -190,7 +189,7 @@ <h1>Source code for kanapy.entities</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">speedx</span> <span class="o">=</span> <span class="mf">0.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">speedy</span> <span class="o">=</span> <span class="mf">0.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">speedz</span> <span class="o">=</span> <span class="mf">0.</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>
<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>
<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>
<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>
<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>
Expand Down Expand Up @@ -253,6 +252,8 @@ <h1>Source code for kanapy.entities</h1><div class="highlight"><pre>

<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>
<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>
<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>
<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>

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

<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>
<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>
<span class="k">else</span><span class="p">:</span>
<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>
<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>
<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>
<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>
<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>
<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>


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

<div class="viewcode-block" id="Ellipsoid.sync_poly">
<a class="viewcode-back" href="../../kanapy.html#kanapy.entities.Ellipsoid.sync_poly">[docs]</a>
<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>
<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>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Moves the center of the polygon to the center of the ellipsoid and</span>
<span class="sd"> scales the hull to fit inside the ellipsoid</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">scale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<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>
<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>
<span class="k">return</span>
<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>
Expand Down
Loading

0 comments on commit 58f3290

Please sign in to comment.