Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@praksharma
praksharma committed Nov 10, 2023
1 parent c1a194c commit 9393eda
Show file tree
Hide file tree
Showing 42 changed files with 464 additions and 277 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/baabcd891a803afc733555a6312f91b5f970222a371f4e02d91b536bc34a35fd.png" src="../../_images/baabcd891a803afc733555a6312f91b5f970222a371f4e02d91b536bc34a35fd.png" />
<img alt="../../_images/d755237a2f43dda0b5ec84b4d99ddddb01bf7a85d2140a59dcc698b4b7ae7d0c.png" src="../../_images/d755237a2f43dda0b5ec84b4d99ddddb01bf7a85d2140a59dcc698b4b7ae7d0c.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/d4167ef51fc06b4e65aa4d5abde586d7ad63bc6897e5a7d62b9d479e3dd7138e.png" src="../../_images/d4167ef51fc06b4e65aa4d5abde586d7ad63bc6897e5a7d62b9d479e3dd7138e.png" />
<img alt="../../_images/74c5684dea4d155266a1cf6a12cb813f372640716b02d8a7bc7d41a4fde1cfe3.png" src="../../_images/74c5684dea4d155266a1cf6a12cb813f372640716b02d8a7bc7d41a4fde1cfe3.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/49d4333b827bb4e25464c004161287b97fb3950e87a6b7264f939f5d56b54a2e.png" src="../../_images/49d4333b827bb4e25464c004161287b97fb3950e87a6b7264f939f5d56b54a2e.png" />
<img alt="../../_images/6c556f5958c67d5f384cc75adcf2de994da13ea8fd819177a9f36a573fdf8eb3.png" src="../../_images/6c556f5958c67d5f384cc75adcf2de994da13ea8fd819177a9f36a573fdf8eb3.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/1aabb562ac41bb59d27852e239b49a0d802181ca5c992d6654bd6c309f0a5d34.png" src="../../_images/1aabb562ac41bb59d27852e239b49a0d802181ca5c992d6654bd6c309f0a5d34.png" />
<img alt="../../_images/1046d2346d8c94ad62430e839ac1072a3c0ccfcb21af9015aa0bc37a26e3154b.png" src="../../_images/1046d2346d8c94ad62430e839ac1072a3c0ccfcb21af9015aa0bc37a26e3154b.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/3ba7264d7307ce668f47db873ff339666c2b118941ff46fb28f31d5460fc493b.png" src="../../_images/3ba7264d7307ce668f47db873ff339666c2b118941ff46fb28f31d5460fc493b.png" />
<img alt="../../_images/890287c06825088f5be55d9b3b5316a2e1729784c32a1528a82d266c8cc687fa.png" src="../../_images/890287c06825088f5be55d9b3b5316a2e1729784c32a1528a82d266c8cc687fa.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/589abd4dd426ff47376ec19a60c69afb15a76737cc72f12a206cbca8d7967d74.png" src="../../_images/589abd4dd426ff47376ec19a60c69afb15a76737cc72f12a206cbca8d7967d74.png" />
<img alt="../../_images/cc9a232f3f5a831bef8fb5c27e5c3ed0bde745c43062af50c51e684c29aaa6ab.png" src="../../_images/cc9a232f3f5a831bef8fb5c27e5c3ed0bde745c43062af50c51e684c29aaa6ab.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/45a65315ec1de6c5be12e90872ddc4f206c794c99bc77480038cf3e54403bba9.png" src="../../_images/45a65315ec1de6c5be12e90872ddc4f206c794c99bc77480038cf3e54403bba9.png" />
<img alt="../../_images/1cfb7d4d99bac336650787e9298af7eaecea10053159fc448bdef61a25aaec05.png" src="../../_images/1cfb7d4d99bac336650787e9298af7eaecea10053159fc448bdef61a25aaec05.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/2bd3e5c449ac01e82ddc423fb6be6cafdfffeac7ca60f243978b5fe5caae4712.png" src="../../_images/2bd3e5c449ac01e82ddc423fb6be6cafdfffeac7ca60f243978b5fe5caae4712.png" />
<img alt="../../_images/21049b004d80165cb867792fe951ba19531dc52267b840a437dd331b88ee9df6.png" src="../../_images/21049b004d80165cb867792fe951ba19531dc52267b840a437dd331b88ee9df6.png" />
<img alt="../../_images/7d16d0d68a6e2970fc5a311758c458bb27d777b532ab312fc309e91d17e1350d.png" src="../../_images/7d16d0d68a6e2970fc5a311758c458bb27d777b532ab312fc309e91d17e1350d.png" />
<img alt="../../_images/f880423cb04828d28f2222f36db142e4bf8710e4d6e408d1ada84413772fd40b.png" src="../../_images/f880423cb04828d28f2222f36db142e4bf8710e4d6e408d1ada84413772fd40b.png" />
<img alt="../../_images/72c35b72f801382dd1ed828c7d316897d8214843131075870e1afd0914b60f12.png" src="../../_images/72c35b72f801382dd1ed828c7d316897d8214843131075870e1afd0914b60f12.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/1d09c6f58ebbe9d2c857fa511e9feae3940708b4e126c5c44fa9eedc254d283d.png" src="../../_images/1d09c6f58ebbe9d2c857fa511e9feae3940708b4e126c5c44fa9eedc254d283d.png" />
<img alt="../../_images/473819e15e75cbda5215fdcc2ce9602cc9359837e3a21f6a9e5d6e04b09116f1.png" src="../../_images/473819e15e75cbda5215fdcc2ce9602cc9359837e3a21f6a9e5d6e04b09116f1.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/d7fe42e8d6ac87d9597e127ddf493fef93c0b01d8f7dce1ad83e956274bf5481.png" src="../../_images/d7fe42e8d6ac87d9597e127ddf493fef93c0b01d8f7dce1ad83e956274bf5481.png" />
<img alt="../../_images/56ecf1ebf84089c020dd8d09eefb8723562ef1a0e8dddcd8615922d9a6fcc012.png" src="../../_images/56ecf1ebf84089c020dd8d09eefb8723562ef1a0e8dddcd8615922d9a6fcc012.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/9d62b3b4564cfd9469dc316e58737f39119bd00bfac0108c1d18f85758c57cce.png" src="../../_images/9d62b3b4564cfd9469dc316e58737f39119bd00bfac0108c1d18f85758c57cce.png" />
<img alt="../../_images/93763f412b5440ca63ba8de57aeb9dbb3daa929efc445cac90983b7f51336d9c.png" src="../../_images/93763f412b5440ca63ba8de57aeb9dbb3daa929efc445cac90983b7f51336d9c.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/d638fdefdc31a715c0736af3a69e2984cc19498f0744fa72035ca1276980109f.png" src="../../_images/d638fdefdc31a715c0736af3a69e2984cc19498f0744fa72035ca1276980109f.png" />
<img alt="../../_images/0a06622b671c8b5e50303d4c9b29cd32d551b529d628342019eb0c13cfe032a6.png" src="../../_images/0a06622b671c8b5e50303d4c9b29cd32d551b529d628342019eb0c13cfe032a6.png" />
<img alt="../../_images/1cf7e3862a5017d09a57649fd47acda0e08182ff8e42561b8ede1751b12e9bcd.png" src="../../_images/1cf7e3862a5017d09a57649fd47acda0e08182ff8e42561b8ede1751b12e9bcd.png" />
<img alt="../../_images/014a5985644b6aaa9ab29c0218bcc3fcf01bd9772cac328074dd134eb45fc643.png" src="../../_images/014a5985644b6aaa9ab29c0218bcc3fcf01bd9772cac328074dd134eb45fc643.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/324bfdcfd022c0e9c0847467df13ed58d51b64122237775fd41e485645047ed6.png" src="../../_images/324bfdcfd022c0e9c0847467df13ed58d51b64122237775fd41e485645047ed6.png" />
<img alt="../../_images/19a1d1df0afb2b9454a9152bbbba6fea0e74b41d0fa64b84194df4b3eb465fb2.png" src="../../_images/19a1d1df0afb2b9454a9152bbbba6fea0e74b41d0fa64b84194df4b3eb465fb2.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/b382f8bbb4a42301cf68ad36856db55beecc4650c7e50ab6281b44b8051fb6c2.png" src="../../_images/b382f8bbb4a42301cf68ad36856db55beecc4650c7e50ab6281b44b8051fb6c2.png" />
<img alt="../../_images/ddafbff6bc4ee9cb0fbaddaf2bb77907623179954660441538bcf392de9c7e50.png" src="../../_images/ddafbff6bc4ee9cb0fbaddaf2bb77907623179954660441538bcf392de9c7e50.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/b03b242bb9538396d4819370d7050bf896bb4f9e9db3b337e2b3445a886c0efb.png" src="../../_images/b03b242bb9538396d4819370d7050bf896bb4f9e9db3b337e2b3445a886c0efb.png" />
<img alt="../../_images/12af92d4393122508f88cfc61b14ff0f7e19cddce09e5055e3690fbb3c71d42c.png" src="../../_images/12af92d4393122508f88cfc61b14ff0f7e19cddce09e5055e3690fbb3c71d42c.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/850b3d0fbf32a20268903ea5ce6a28e5fbca5371c58af8e9516db698403f2ad0.png" src="../../_images/850b3d0fbf32a20268903ea5ce6a28e5fbca5371c58af8e9516db698403f2ad0.png" />
<img alt="../../_images/686a023de6b4a9597898f6f0e3844d4aef28f85c172c5fc61bc2a8a2244d098b.png" src="../../_images/686a023de6b4a9597898f6f0e3844d4aef28f85c172c5fc61bc2a8a2244d098b.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/52dd05dd615c7d5ac9211e10b8012910a099e7f30de47e12d3b22307f5bc996e.png" src="../../_images/52dd05dd615c7d5ac9211e10b8012910a099e7f30de47e12d3b22307f5bc996e.png" />
<img alt="../../_images/0373ecb8c85f8c857f7f8b44d6edbf9a7627a8a0efc40d54687a0aa3cdc784d4.png" src="../../_images/0373ecb8c85f8c857f7f8b44d6edbf9a7627a8a0efc40d54687a0aa3cdc784d4.png" />
<img alt="../../_images/37618b8ef43db7a9e23dcd65036bf2788d8d33a1c09e4454a728f4210d876f38.png" src="../../_images/37618b8ef43db7a9e23dcd65036bf2788d8d33a1c09e4454a728f4210d876f38.png" />
<img alt="../../_images/f2fc2eff15a5fcab577db7e510131dc01cc2e3386f3dd418d2b9870000121eb5.png" src="../../_images/f2fc2eff15a5fcab577db7e510131dc01cc2e3386f3dd418d2b9870000121eb5.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 0x7faccca2f490&gt;
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.colorbar.Colorbar at 0x7fe83cdc2670&gt;
</pre></div>
</div>
<img alt="../../_images/eee88df8466d13bca734e71f3ba9942f782da581e97bb3eb8c0f4476572a890b.png" src="../../_images/eee88df8466d13bca734e71f3ba9942f782da581e97bb3eb8c0f4476572a890b.png" />
<img alt="../../_images/141defc6b49d37a3331600e920e4269665509364ef723ff709dc969de1440b1d.png" src="../../_images/141defc6b49d37a3331600e920e4269665509364ef723ff709dc969de1440b1d.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 0x7faccc9876d0&gt;
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.colorbar.Colorbar at 0x7fe83cca6700&gt;
</pre></div>
</div>
<img alt="../../_images/e49dd950a1db799a6dd1d8380d6db5b86c293409d1601a773c12fd9846290e4b.png" src="../../_images/e49dd950a1db799a6dd1d8380d6db5b86c293409d1601a773c12fd9846290e4b.png" />
<img alt="../../_images/520c85557eb386deb01eb0fc44b8288e67843244eb45af81751f3071846d291a.png" src="../../_images/520c85557eb386deb01eb0fc44b8288e67843244eb45af81751f3071846d291a.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/f93ca5ea5b1240b211c3d50659c52adf3fcdc4bdf03df280b26a5a0614666b76.png" src="../../_images/f93ca5ea5b1240b211c3d50659c52adf3fcdc4bdf03df280b26a5a0614666b76.png" />
<img alt="../../_images/d2d1dc7aed2f395f8f5472e9eca216f0ba4e9491ed130b939e5bbe2a071d24b7.png" src="../../_images/d2d1dc7aed2f395f8f5472e9eca216f0ba4e9491ed130b939e5bbe2a071d24b7.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 0x7f1471d93790&gt;
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.colorbar.Colorbar at 0x7f9b8b0376d0&gt;
</pre></div>
</div>
<img alt="../../_images/a794964afc4f3301ba4b94b847bb1f3fba8f1a756cd27342ca7e6d7d6e7e7365.png" src="../../_images/a794964afc4f3301ba4b94b847bb1f3fba8f1a756cd27342ca7e6d7d6e7e7365.png" />
<img alt="../../_images/873ca0fe9d56664698ad1c22aa6ddb63ee1d01f8c63889f22a32c0ab15b22378.png" src="../../_images/873ca0fe9d56664698ad1c22aa6ddb63ee1d01f8c63889f22a32c0ab15b22378.png" />
</div>
</div>
</section>
Expand Down
Loading

0 comments on commit 9393eda

Please sign in to comment.