Deploying to gh-pages from @ fury-gl/fury@148d18b 🚀

fury-gl · Feb 27, 2024 · e7212c1 · e7212c1
1 parent 97e82f4
commit e7212c1
Show file tree

Hide file tree

Showing 432 changed files with 1,436 additions and 2,298 deletions.
diff --git a/dev/.buildinfo b/dev/.buildinfo
@@ -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: 0d89303200ce0aeec75e3d1afdd65e57
+config: a75a76f1d604287380393f92d82d1b9e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/dev/.doctrees/auto_examples/20_stream/viz_interaction.doctree b/dev/.doctrees/auto_examples/20_stream/viz_interaction.doctree
diff --git a/dev/.doctrees/auto_examples/20_stream/viz_widget.doctree b/dev/.doctrees/auto_examples/20_stream/viz_widget.doctree
diff --git a/dev/.doctrees/community.doctree b/dev/.doctrees/community.doctree
diff --git a/dev/.doctrees/environment.pickle b/dev/.doctrees/environment.pickle
diff --git a/dev/.doctrees/reference/fury.actor.doctree b/dev/.doctrees/reference/fury.actor.doctree
diff --git a/dev/.doctrees/reference/fury.actors.doctree b/dev/.doctrees/reference/fury.actors.doctree
diff --git a/dev/.doctrees/reference/fury.colormap.doctree b/dev/.doctrees/reference/fury.colormap.doctree
diff --git a/dev/.doctrees/reference/fury.data.doctree b/dev/.doctrees/reference/fury.data.doctree
diff --git a/dev/.doctrees/reference/fury.deprecator.doctree b/dev/.doctrees/reference/fury.deprecator.doctree
diff --git a/dev/.doctrees/reference/fury.layout.doctree b/dev/.doctrees/reference/fury.layout.doctree
diff --git a/dev/.doctrees/reference/fury.stream.doctree b/dev/.doctrees/reference/fury.stream.doctree
diff --git a/dev/.doctrees/reference/fury.ui.doctree b/dev/.doctrees/reference/fury.ui.doctree
diff --git a/dev/.doctrees/reference/fury.window.doctree b/dev/.doctrees/reference/fury.window.doctree
diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/dev/_downloads/add7a5726ae59960b3bcb9ef1af5110c/viz_interaction.py b/dev/_downloads/add7a5726ae59960b3bcb9ef1af5110c/viz_interaction.py
@@ -18,7 +18,6 @@
 
 Notes
 -----
-
 If you don't have ffmpeg installed, you need to install it to use WebRTC
 
 Linux
@@ -29,6 +28,7 @@
 OS X
 
 `brew install ffmpeg opus libvpx pkg-config`
+
 """
 
 import multiprocessing

diff --git a/dev/_downloads/bd014674b55899498e6c47d54b8c1e50/viz_widget.py b/dev/_downloads/bd014674b55899498e6c47d54b8c1e50/viz_widget.py
@@ -31,8 +31,9 @@
 `brew install ffmpeg opus libvpx pkg-config`
 
 Notes
-------
+-----
 For this example your python version should be 3.8 or greater
+
 """
 
 import asyncio

diff --git a/dev/_downloads/f3c12cee7268b7b98cd3da9316478888/viz_interaction.ipynb b/dev/_downloads/f3c12cee7268b7b98cd3da9316478888/viz_interaction.ipynb
@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "\n# Streaming FURY with user interaction\n\nIn this tutorial, we show how to use the FURY Streaming system to\nserve an interactive visualization through a web browser.\n\nYou can choose between two different encodings: WebRTC or MJPEG.\nWebRTC is a more robust option and can be used to perform\na live streaming with a low-latency connection for example using\nngrok. However, to use webRTC you need to install the aiortc library.\n\n```bash\npip install aiortc\n```\n## Notes\n\nIf you don't have ffmpeg installed, you need to install it to use WebRTC\n\nLinux\n\n\n`apt install libavdevice-dev libavfilter-dev libopus-dev libvpx-dev pkg-config`\n\nOS X\n\n`brew install ffmpeg opus libvpx pkg-config`\n"
+        "\n# Streaming FURY with user interaction\n\nIn this tutorial, we show how to use the FURY Streaming system to\nserve an interactive visualization through a web browser.\n\nYou can choose between two different encodings: WebRTC or MJPEG.\nWebRTC is a more robust option and can be used to perform\na live streaming with a low-latency connection for example using\nngrok. However, to use webRTC you need to install the aiortc library.\n\n```bash\npip install aiortc\n```\n## Notes\nIf you don't have ffmpeg installed, you need to install it to use WebRTC\n\nLinux\n\n\n`apt install libavdevice-dev libavfilter-dev libopus-dev libvpx-dev pkg-config`\n\nOS X\n\n`brew install ffmpeg opus libvpx pkg-config`\n"
       ]
     },
     {

diff --git a/dev/_modules/fury.html b/dev/_modules/fury.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>fury &#8212; FURY 0.10.0.dev381+ga165c531 documentation</title>
+    <title>fury &#8212; FURY 0.10.0.dev382+g148d18b2 documentation</title>
 
 
 
@@ -39,7 +39,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=796348d33e8b1d947c94">
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=796348d33e8b1d947c94">
 
-    <script src="../_static/documentation_options.js?v=a39306c1"></script>
+    <script src="../_static/documentation_options.js?v=25c2161f"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -299,11 +299,12 @@ <h1>Source code for fury</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Return dict describing the context of this package.</span>
 
 <span class="sd">    Parameters</span>
-<span class="sd">    ------------</span>
+<span class="sd">    ----------</span>
 <span class="sd">    pkg_path : str</span>
 <span class="sd">       path containing __init__.py for package</span>
+
 <span class="sd">    Returns</span>
-<span class="sd">    ----------</span>
+<span class="sd">    -------</span>
 <span class="sd">    context : dict</span>
 <span class="sd">       with named parameters of interest</span>
 

diff --git a/dev/_modules/fury/actor.html b/dev/_modules/fury/actor.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>fury.actor &#8212; FURY 0.10.0.dev381+ga165c531 documentation</title>
+    <title>fury.actor &#8212; FURY 0.10.0.dev382+g148d18b2 documentation</title>
 
 
 
@@ -39,7 +39,7 @@
   <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=796348d33e8b1d947c94">
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=796348d33e8b1d947c94">
 
-    <script src="../../_static/documentation_options.js?v=a39306c1"></script>
+    <script src="../../_static/documentation_options.js?v=25c2161f"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -3090,9 +3090,10 @@ <h1>Source code for fury.actor</h1><div class="highlight"><pre>
     <span class="n">bb_type</span><span class="o">=</span><span class="s1">&#39;spherical&#39;</span>
 <span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Create a billboard actor.</span>
-<span class="sd">-</span>
+<span class="sd">    -</span>
 <span class="sd">    Billboards are 2D elements placed in a 3D world. They offer possibility to</span>
 <span class="sd">    draw different shapes/elements at the fragment shader level.</span>
+
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
 <span class="sd">    centers : ndarray, shape (N, 3)</span>
@@ -3122,6 +3123,7 @@ <h1>Source code for fury.actor</h1><div class="highlight"><pre>
 <span class="sd">    Returns</span>
 <span class="sd">    -------</span>
 <span class="sd">    billboard_actor: Actor</span>
+
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">verts</span><span class="p">,</span> <span class="n">faces</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">prim_square</span><span class="p">()</span>
     <span class="n">res</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">repeat_primitive</span><span class="p">(</span>
@@ -3492,12 +3494,11 @@ <h1>Source code for fury.actor</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="Container.__init__">
 <a class="viewcode-back" href="../../reference/fury.actor.html#fury.actor.Container.__init__">[docs]</a>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">layout</span><span class="o">=</span><span class="n">layout</span><span class="o">.</span><span class="n">Layout</span><span class="p">()):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-
-<span class="sd">        Parameters</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Parameters</span>
 <span class="sd">        ----------</span>
 <span class="sd">        layout : ``fury.layout.Layout`` object</span>
 <span class="sd">            Items of this container will be arranged according to `layout`.</span>
+
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">layout</span> <span class="o">=</span> <span class="n">layout</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_items</span> <span class="o">=</span> <span class="p">[]</span>
@@ -3528,6 +3529,7 @@ <h1>Source code for fury.actor</h1><div class="highlight"><pre>
 <span class="sd">            If True the items are added as-is, otherwise a shallow copy is</span>
 <span class="sd">            made first. If you intend to reuse the items elsewhere you</span>
 <span class="sd">            should set `borrow=False`. Default: True.</span>
+
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_need_update</span> <span class="o">=</span> <span class="kc">True</span>
 
@@ -4116,6 +4118,7 @@ <h1>Source code for fury.actor</h1><div class="highlight"><pre>
     <span class="n">edge_opacity</span><span class="o">=</span><span class="mf">0.8</span><span class="p">,</span>
 <span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Create a marker actor with different shapes.</span>
+
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
 <span class="sd">    centers : ndarray, shape (N, 3)</span>
@@ -4299,8 +4302,7 @@ <h1>Source code for fury.actor</h1><div class="highlight"><pre>
     <span class="n">scales</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span>
     <span class="n">opacity</span><span class="o">=</span><span class="mf">1.0</span>
 <span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    VTK actor for visualizing ellipsoids.</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;VTK actor for visualizing ellipsoids.</span>
 
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
@@ -4322,7 +4324,6 @@ <h1>Source code for fury.actor</h1><div class="highlight"><pre>
 <span class="sd">    tensor_ellipsoid: Actor</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>
-
     <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">centers</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
         <span class="n">centers</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="n">centers</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">centers</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
@@ -4374,8 +4375,7 @@ <h1>Source code for fury.actor</h1><div class="highlight"><pre>
     <span class="n">scales</span><span class="o">=</span><span class="mf">.6</span><span class="p">,</span>
     <span class="n">opacity</span><span class="o">=</span><span class="mf">1.0</span>
 <span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    VTK actor for visualizing the cone of uncertainty representing the</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;VTK actor for visualizing the cone of uncertainty representing the</span>
 <span class="sd">    variance of the main direction of diffusion.</span>
 
 <span class="sd">    Parameters</span>
@@ -4400,7 +4400,6 @@ <h1>Source code for fury.actor</h1><div class="highlight"><pre>
 <span class="sd">    double_cone: Actor</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>
-
     <span class="n">valid_mask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">evecs</span><span class="p">)</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">axis</span><span class="o">=</span><span class="p">(</span><span class="o">-</span><span class="mi">2</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">))</span> <span class="o">&gt;</span> <span class="mi">0</span>
     <span class="n">indices</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nonzero</span><span class="p">(</span><span class="n">valid_mask</span><span class="p">)</span>
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,7 +18,6 @@ @@
     Notes
     -----
     If you don't have ffmpeg installed, you need to install it to use WebRTC
     Linux
@@ Expand All / @@ -29,6 +28,7 @@ @@
     OS X
     `brew install ffmpeg opus libvpx pkg-config`
     """
     import multiprocessing
@@ Expand Down @@