Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@praksharma
praksharma committed Aug 1, 2023
1 parent 939c8a2 commit c1a194c
Show file tree
Hide file tree
Showing 264 changed files with 269 additions and 2,825 deletions.
12 changes: 6 additions & 6 deletions Tutorials/1. Geometry/UKAEA SUT.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Permalink to this he
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/4fd22ddfb947c52880e9b84bb18b34981cceb9f103622507687e579dbf53b7b4.png" src="../../_images/4fd22ddfb947c52880e9b84bb18b34981cceb9f103622507687e579dbf53b7b4.png" />
<img alt="../../_images/baabcd891a803afc733555a6312f91b5f970222a371f4e02d91b536bc34a35fd.png" src="../../_images/baabcd891a803afc733555a6312f91b5f970222a371f4e02d91b536bc34a35fd.png" />
</div>
</div>
<div class="cell docutils container">
Expand Down Expand Up @@ -471,7 +471,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Permalink to this he
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>(-0.1, 1.0)
</pre></div>
</div>
<img alt="../../_images/37cf477df55adf351db90025982c124198d1b18b1737f23d51de2624eff92a80.png" src="../../_images/37cf477df55adf351db90025982c124198d1b18b1737f23d51de2624eff92a80.png" />
<img alt="../../_images/d4167ef51fc06b4e65aa4d5abde586d7ad63bc6897e5a7d62b9d479e3dd7138e.png" src="../../_images/d4167ef51fc06b4e65aa4d5abde586d7ad63bc6897e5a7d62b9d479e3dd7138e.png" />
</div>
</div>
<p>The last point of this tutorial is the possibility to transform a <em>TrimeshPolyhedron</em> to a <em>ShapelyPolygon</em>, by either projecting or slicing with a plane. This is also a functionality implemented in Trimesh.</p>
Expand All @@ -489,7 +489,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Permalink to this he
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/d26ab582099305e0e7bc80d09a8240a3ffa7f9be8e94349eb901d1ec64ffe9a5.png" src="../../_images/d26ab582099305e0e7bc80d09a8240a3ffa7f9be8e94349eb901d1ec64ffe9a5.png" />
<img alt="../../_images/49d4333b827bb4e25464c004161287b97fb3950e87a6b7264f939f5d56b54a2e.png" src="../../_images/49d4333b827bb4e25464c004161287b97fb3950e87a6b7264f939f5d56b54a2e.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -505,7 +505,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Permalink to this he
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/f0cae8869b67a0f7a991b726e2b479f3e23a03c61e82171488df322e502e93e0.png" src="../../_images/f0cae8869b67a0f7a991b726e2b479f3e23a03c61e82171488df322e502e93e0.png" />
<img alt="../../_images/1aabb562ac41bb59d27852e239b49a0d802181ca5c992d6654bd6c309f0a5d34.png" src="../../_images/1aabb562ac41bb59d27852e239b49a0d802181ca5c992d6654bd6c309f0a5d34.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -521,7 +521,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Permalink to this he
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/44cce0d7445c62ba4077f876bd5a7fd16ae863ae8ed4f09d39431bbb3ad4ce86.png" src="../../_images/44cce0d7445c62ba4077f876bd5a7fd16ae863ae8ed4f09d39431bbb3ad4ce86.png" />
<img alt="../../_images/3ba7264d7307ce668f47db873ff339666c2b118941ff46fb28f31d5460fc493b.png" src="../../_images/3ba7264d7307ce668f47db873ff339666c2b118941ff46fb28f31d5460fc493b.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -537,7 +537,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Permalink to this he
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/06e0d62823d1476107508070c1518640b43593c179b2b4b09e72261ec9906a9c.png" src="../../_images/06e0d62823d1476107508070c1518640b43593c179b2b4b09e72261ec9906a9c.png" />
<img alt="../../_images/589abd4dd426ff47376ec19a60c69afb15a76737cc72f12a206cbca8d7967d74.png" src="../../_images/589abd4dd426ff47376ec19a60c69afb15a76737cc72f12a206cbca8d7967d74.png" />
</div>
</div>
</section>
Expand Down
12 changes: 6 additions & 6 deletions Tutorials/1. Geometry/different sampling.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ <h1>Basic sampling techniques<a class="headerlink" href="#basic-sampling-techniq
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/c2717f581d7affdc7c5f2eae8f790349da90f9c1f92ba6c3c28c5c4f08f3cade.png" src="../../_images/c2717f581d7affdc7c5f2eae8f790349da90f9c1f92ba6c3c28c5c4f08f3cade.png" />
<img alt="../../_images/45a65315ec1de6c5be12e90872ddc4f206c794c99bc77480038cf3e54403bba9.png" src="../../_images/45a65315ec1de6c5be12e90872ddc4f206c794c99bc77480038cf3e54403bba9.png" />
<img alt="../../_images/88f56863aa41f62a5b9c962f6f131c707481b5ffc17add2adf6104139fca3b05.png" src="../../_images/88f56863aa41f62a5b9c962f6f131c707481b5ffc17add2adf6104139fca3b05.png" />
</div>
</div>
Expand Down Expand Up @@ -470,9 +470,9 @@ <h1>Basic sampling techniques<a class="headerlink" href="#basic-sampling-techniq
warnings.warn(&quot;&quot;&quot;Exact volume of this domain boundary is not known,
</pre></div>
</div>
<img alt="../../_images/3d78d7da60df3ad540e48d1950c798e6bd14bdd0455494d248227dbbd2bfb10f.png" src="../../_images/3d78d7da60df3ad540e48d1950c798e6bd14bdd0455494d248227dbbd2bfb10f.png" />
<img alt="../../_images/2bd3e5c449ac01e82ddc423fb6be6cafdfffeac7ca60f243978b5fe5caae4712.png" src="../../_images/2bd3e5c449ac01e82ddc423fb6be6cafdfffeac7ca60f243978b5fe5caae4712.png" />
<img alt="../../_images/7d16d0d68a6e2970fc5a311758c458bb27d777b532ab312fc309e91d17e1350d.png" src="../../_images/7d16d0d68a6e2970fc5a311758c458bb27d777b532ab312fc309e91d17e1350d.png" />
<img alt="../../_images/2d83933dfafca70d0497f3c9213165da55b49028cd024792ff95ff5911260e66.png" src="../../_images/2d83933dfafca70d0497f3c9213165da55b49028cd024792ff95ff5911260e66.png" />
<img alt="../../_images/f880423cb04828d28f2222f36db142e4bf8710e4d6e408d1ada84413772fd40b.png" src="../../_images/f880423cb04828d28f2222f36db142e4bf8710e4d6e408d1ada84413772fd40b.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -493,7 +493,7 @@ <h1>Basic sampling techniques<a class="headerlink" href="#basic-sampling-techniq
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/b5a00b2b796e5f32b9ca9f37e7e8b3558529e173128ad702715183dfa58f65e7.png" src="../../_images/b5a00b2b796e5f32b9ca9f37e7e8b3558529e173128ad702715183dfa58f65e7.png" />
<img alt="../../_images/1d09c6f58ebbe9d2c857fa511e9feae3940708b4e126c5c44fa9eedc254d283d.png" src="../../_images/1d09c6f58ebbe9d2c857fa511e9feae3940708b4e126c5c44fa9eedc254d283d.png" />
</div>
</div>
<div class="cell docutils container">
Expand Down Expand Up @@ -521,7 +521,7 @@ <h1>Basic sampling techniques<a class="headerlink" href="#basic-sampling-techniq
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/618ebeaadfffeceec5d12966dd9ecebe6af13535bff0e243b9e0360b4feb69dc.png" src="../../_images/618ebeaadfffeceec5d12966dd9ecebe6af13535bff0e243b9e0360b4feb69dc.png" />
<img alt="../../_images/d7fe42e8d6ac87d9597e127ddf493fef93c0b01d8f7dce1ad83e956274bf5481.png" src="../../_images/d7fe42e8d6ac87d9597e127ddf493fef93c0b01d8f7dce1ad83e956274bf5481.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -542,7 +542,7 @@ <h1>Basic sampling techniques<a class="headerlink" href="#basic-sampling-techniq
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/25367b12285dce3708c762bad68e64dca7a83efb0b63939c3e9ce2dd4bac37ae.png" src="../../_images/25367b12285dce3708c762bad68e64dca7a83efb0b63939c3e9ce2dd4bac37ae.png" />
<img alt="../../_images/9d62b3b4564cfd9469dc316e58737f39119bd00bfac0108c1d18f85758c57cce.png" src="../../_images/9d62b3b4564cfd9469dc316e58737f39119bd00bfac0108c1d18f85758c57cce.png" />
</div>
</div>
</section>
Expand Down
4 changes: 2 additions & 2 deletions Tutorials/1. Geometry/domain_creation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -564,8 +564,8 @@ <h2>Domain Operations<a class="headerlink" href="#domain-operations" title="Perm
</pre></div>
</div>
<img alt="../../_images/dbaaa2226b964ac550c4483e9dc30306598be90c284a2d2cc3b879deb2a3a2bc.png" src="../../_images/dbaaa2226b964ac550c4483e9dc30306598be90c284a2d2cc3b879deb2a3a2bc.png" />
<img alt="../../_images/3122f7d123e18c672d230c9727aceec58d6624f824e1591bcd2759ac84cf02e5.png" src="../../_images/3122f7d123e18c672d230c9727aceec58d6624f824e1591bcd2759ac84cf02e5.png" />
<img alt="../../_images/76eeb3cf9c17149b13865df55e0876aae1d38939c1c3a4080bd08e4cc61e9cb5.png" src="../../_images/76eeb3cf9c17149b13865df55e0876aae1d38939c1c3a4080bd08e4cc61e9cb5.png" />
<img alt="../../_images/d638fdefdc31a715c0736af3a69e2984cc19498f0744fa72035ca1276980109f.png" src="../../_images/d638fdefdc31a715c0736af3a69e2984cc19498f0744fa72035ca1276980109f.png" />
<img alt="../../_images/0a06622b671c8b5e50303d4c9b29cd32d551b529d628342019eb0c13cfe032a6.png" src="../../_images/0a06622b671c8b5e50303d4c9b29cd32d551b529d628342019eb0c13cfe032a6.png" />
</div>
</div>
<p>For the product, we create the Cartesian product of an interval and circle to get a cylinder:</p>
Expand Down
6 changes: 3 additions & 3 deletions Tutorials/1. Geometry/polygons_external_objects.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ <h2>Polygons<a class="headerlink" href="#polygons" title="Permalink to this head
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/6fde207a9e2caf0ee852f6be736660c2b797d365fdbe33f2ecf9d05c57d78130.png" src="../../_images/6fde207a9e2caf0ee852f6be736660c2b797d365fdbe33f2ecf9d05c57d78130.png" />
<img alt="../../_images/324bfdcfd022c0e9c0847467df13ed58d51b64122237775fd41e485645047ed6.png" src="../../_images/324bfdcfd022c0e9c0847467df13ed58d51b64122237775fd41e485645047ed6.png" />
</div>
</div>
</section>
Expand Down Expand Up @@ -525,7 +525,7 @@ <h2>External Objects<a class="headerlink" href="#external-objects" title="Permal
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/3582bc5030668b282192277d95c884d26bfbd24f12c055ebe0787f12e81ca384.png" src="../../_images/3582bc5030668b282192277d95c884d26bfbd24f12c055ebe0787f12e81ca384.png" />
<img alt="../../_images/b382f8bbb4a42301cf68ad36856db55beecc4650c7e50ab6281b44b8051fb6c2.png" src="../../_images/b382f8bbb4a42301cf68ad36856db55beecc4650c7e50ab6281b44b8051fb6c2.png" />
</div>
</div>
<p>The last point of this tutorial is the possibility to transform a <em>TrimeshPolyhedron</em> to a <em>ShapelyPolygon</em>, by either projecting or slicing with a plane. This is also a functionality implemented in Trimesh.</p>
Expand All @@ -549,7 +549,7 @@ <h2>External Objects<a class="headerlink" href="#external-objects" title="Permal
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/4ead004f39114bc069ac55edd20ad8ea2b7f2becf12fbebae70a7bd320e3b47d.png" src="../../_images/4ead004f39114bc069ac55edd20ad8ea2b7f2becf12fbebae70a7bd320e3b47d.png" />
<img alt="../../_images/b03b242bb9538396d4819370d7050bf896bb4f9e9db3b337e2b3445a886c0efb.png" src="../../_images/b03b242bb9538396d4819370d7050bf896bb4f9e9db3b337e2b3445a886c0efb.png" />
</div>
</div>
</section>
Expand Down
14 changes: 7 additions & 7 deletions Tutorials/2. BC/1. dirichlet.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ <h1>Dirichlet BC<a class="headerlink" href="#dirichlet-bc" title="Permalink to t
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/0f3785692d9ac06db2e7b19bd5718dfb476edcfa6df46003ab71958a1893ac0e.png" src="../../_images/0f3785692d9ac06db2e7b19bd5718dfb476edcfa6df46003ab71958a1893ac0e.png" />
<img alt="../../_images/850b3d0fbf32a20268903ea5ce6a28e5fbca5371c58af8e9516db698403f2ad0.png" src="../../_images/850b3d0fbf32a20268903ea5ce6a28e5fbca5371c58af8e9516db698403f2ad0.png" />
</div>
</div>
<div class="cell docutils container">
Expand Down Expand Up @@ -463,8 +463,8 @@ <h1>Dirichlet BC<a class="headerlink" href="#dirichlet-bc" title="Permalink to t
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/6b223242707968920830e60a0719c79e7c05d36b279959bfceb8ae11605e81f6.png" src="../../_images/6b223242707968920830e60a0719c79e7c05d36b279959bfceb8ae11605e81f6.png" />
<img alt="../../_images/474d3d14b31d3503001c360919d2283d88d63935e5c6fe31590b6149d529c0a9.png" src="../../_images/474d3d14b31d3503001c360919d2283d88d63935e5c6fe31590b6149d529c0a9.png" />
<img alt="../../_images/52dd05dd615c7d5ac9211e10b8012910a099e7f30de47e12d3b22307f5bc996e.png" src="../../_images/52dd05dd615c7d5ac9211e10b8012910a099e7f30de47e12d3b22307f5bc996e.png" />
<img alt="../../_images/0373ecb8c85f8c857f7f8b44d6edbf9a7627a8a0efc40d54687a0aa3cdc784d4.png" src="../../_images/0373ecb8c85f8c857f7f8b44d6edbf9a7627a8a0efc40d54687a0aa3cdc784d4.png" />
</div>
</div>
<div class="cell docutils container">
Expand Down Expand Up @@ -538,10 +538,10 @@ <h1>Dirichlet BC<a class="headerlink" href="#dirichlet-bc" title="Permalink to t
</div>
</div>
<div class="cell_output docutils container">
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.colorbar.Colorbar at 0x7f2842744550&gt;
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.colorbar.Colorbar at 0x7faccca2f490&gt;
</pre></div>
</div>
<img alt="../../_images/b84242e7f4a7b7e1567543b80a86b475dc20bb342b37bdb17d1b80a2143516e1.png" src="../../_images/b84242e7f4a7b7e1567543b80a86b475dc20bb342b37bdb17d1b80a2143516e1.png" />
<img alt="../../_images/eee88df8466d13bca734e71f3ba9942f782da581e97bb3eb8c0f4476572a890b.png" src="../../_images/eee88df8466d13bca734e71f3ba9942f782da581e97bb3eb8c0f4476572a890b.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -553,10 +553,10 @@ <h1>Dirichlet BC<a class="headerlink" href="#dirichlet-bc" title="Permalink to t
</div>
</div>
<div class="cell_output docutils container">
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.colorbar.Colorbar at 0x7f28426265e0&gt;
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.colorbar.Colorbar at 0x7faccc9876d0&gt;
</pre></div>
</div>
<img alt="../../_images/6baa91f396b785a08308a321a9d9334e7237d74aaeb1fb96ffcd06c1d5a3d472.png" src="../../_images/6baa91f396b785a08308a321a9d9334e7237d74aaeb1fb96ffcd06c1d5a3d472.png" />
<img alt="../../_images/e49dd950a1db799a6dd1d8380d6db5b86c293409d1601a773c12fd9846290e4b.png" src="../../_images/e49dd950a1db799a6dd1d8380d6db5b86c293409d1601a773c12fd9846290e4b.png" />
</div>
</div>
</section>
Expand Down
6 changes: 3 additions & 3 deletions Tutorials/2. BC/2. pde.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ <h1>PDE constraint<a class="headerlink" href="#pde-constraint" title="Permalink
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/df98a88954b555aee1ffd1b4ea97438766eb77e39d019490a9e655b676d2d37d.png" src="../../_images/df98a88954b555aee1ffd1b4ea97438766eb77e39d019490a9e655b676d2d37d.png" />
<img alt="../../_images/f93ca5ea5b1240b211c3d50659c52adf3fcdc4bdf03df280b26a5a0614666b76.png" src="../../_images/f93ca5ea5b1240b211c3d50659c52adf3fcdc4bdf03df280b26a5a0614666b76.png" />
</div>
</div>
<div class="cell docutils container">
Expand Down Expand Up @@ -488,10 +488,10 @@ <h1>PDE constraint<a class="headerlink" href="#pde-constraint" title="Permalink
</div>
</div>
<div class="cell_output docutils container">
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.colorbar.Colorbar at 0x7f9d4925e790&gt;
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.colorbar.Colorbar at 0x7f1471d93790&gt;
</pre></div>
</div>
<img alt="../../_images/0d706a607802fb77d3daa8e5a0ad17d32a23715613c0f59694bd53dad1a2b267.png" src="../../_images/0d706a607802fb77d3daa8e5a0ad17d32a23715613c0f59694bd53dad1a2b267.png" />
<img alt="../../_images/a794964afc4f3301ba4b94b847bb1f3fba8f1a756cd27342ca7e6d7d6e7e7365.png" src="../../_images/a794964afc4f3301ba4b94b847bb1f3fba8f1a756cd27342ca7e6d7d6e7e7365.png" />
</div>
</div>
</section>
Expand Down
Loading

0 comments on commit c1a194c

Please sign in to comment.