Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@praksharma
praksharma committed Mar 14, 2024
1 parent f4bb869 commit ababd1d
Show file tree
Hide file tree
Showing 122 changed files with 428 additions and 341 deletions.
6 changes: 5 additions & 1 deletion Tutorials/1. Geometry/Basic_domains.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,11 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/1.%20basic.html">Basics of network design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/2.%20test.html">Forward pass</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">FCNN training</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">1D Laplace Equation</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">2D heat conduction</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../6.%202D%20heat%20conduction/1.%20model.html">2D Laplace Equation</a></li>
</ul>

</div>
Expand Down
18 changes: 11 additions & 7 deletions Tutorials/1. Geometry/UKAEA SUT.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,11 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/1.%20basic.html">Basics of network design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/2.%20test.html">Forward pass</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">FCNN training</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">1D Laplace Equation</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">2D heat conduction</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../6.%202D%20heat%20conduction/1.%20model.html">2D Laplace Equation</a></li>
</ul>

</div>
Expand Down Expand Up @@ -462,7 +466,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Link to this heading
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/32403780c9e54ac8e025643cb84ff86b1a61e80c7b12e57e6e2005dfc8df5616.png" src="../../_images/32403780c9e54ac8e025643cb84ff86b1a61e80c7b12e57e6e2005dfc8df5616.png" />
<img alt="../../_images/e4f0d751caa1199f8da7221078efc2e9554fcb8eeaf64d14f510b9940f6665c7.png" src="../../_images/e4f0d751caa1199f8da7221078efc2e9554fcb8eeaf64d14f510b9940f6665c7.png" />
</div>
</div>
<div class="cell docutils container">
Expand Down Expand Up @@ -493,7 +497,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Link to this heading
<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/5ba651f47cc0e1daf3e2be179d1b5be91cb40885c0a25b18d14e9b1fa5513098.png" src="../../_images/5ba651f47cc0e1daf3e2be179d1b5be91cb40885c0a25b18d14e9b1fa5513098.png" />
<img alt="../../_images/0cc15baf8ec960bc6f1fa767669c82aca0149ba35da22dece2f616afddc753ff.png" src="../../_images/0cc15baf8ec960bc6f1fa767669c82aca0149ba35da22dece2f616afddc753ff.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 @@ -511,7 +515,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Link to this heading
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/7f934a02c8968aef054e3b04022a627b69b2b806668fcc0cbf3fd7592602623f.png" src="../../_images/7f934a02c8968aef054e3b04022a627b69b2b806668fcc0cbf3fd7592602623f.png" />
<img alt="../../_images/1d8be8ed03de359eb50e5f89d3f57b0a2014f5d9cded4e66d40c869ad20beb0b.png" src="../../_images/1d8be8ed03de359eb50e5f89d3f57b0a2014f5d9cded4e66d40c869ad20beb0b.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -527,7 +531,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Link to this heading
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/b543061ae01454ea015b0ffc45b3d680ef2108d14dd845b1f7468c0779c7b173.png" src="../../_images/b543061ae01454ea015b0ffc45b3d680ef2108d14dd845b1f7468c0779c7b173.png" />
<img alt="../../_images/148e52340e86d09c22942aa4d96d53570b5767051b883431a9de8f4c09a551bc.png" src="../../_images/148e52340e86d09c22942aa4d96d53570b5767051b883431a9de8f4c09a551bc.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -543,7 +547,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Link to this heading
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/f60b3402d6ff38d6c2b9ea1d5d04042d576e064fba211ffe14ab55e921d03106.png" src="../../_images/f60b3402d6ff38d6c2b9ea1d5d04042d576e064fba211ffe14ab55e921d03106.png" />
<img alt="../../_images/43ccff2a5b0f4ca65b4dcfa0a2bbf45148a6e0f00ed77a76f78b47c3b7c176e8.png" src="../../_images/43ccff2a5b0f4ca65b4dcfa0a2bbf45148a6e0f00ed77a76f78b47c3b7c176e8.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -559,7 +563,7 @@ <h1>UKAEA SUT<a class="headerlink" href="#ukaea-sut" title="Link to this heading
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/ce3734c4f6ca0b9dd42f0c077b612fdcd492f9b0b9196891808d017f8dca1ed5.png" src="../../_images/ce3734c4f6ca0b9dd42f0c077b612fdcd492f9b0b9196891808d017f8dca1ed5.png" />
<img alt="../../_images/5e3cb04b902f5983d1da76a6099f3de6fe9c4d5a5118e5d7c586c009aa7c623d.png" src="../../_images/5e3cb04b902f5983d1da76a6099f3de6fe9c4d5a5118e5d7c586c009aa7c623d.png" />
</div>
</div>
</section>
Expand Down
18 changes: 11 additions & 7 deletions Tutorials/1. Geometry/different sampling.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,11 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/1.%20basic.html">Basics of network design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/2.%20test.html">Forward pass</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">FCNN training</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">1D Laplace Equation</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">2D heat conduction</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../6.%202D%20heat%20conduction/1.%20model.html">2D Laplace Equation</a></li>
</ul>

</div>
Expand Down Expand Up @@ -453,7 +457,7 @@ <h1>Basic sampling techniques<a class="headerlink" href="#basic-sampling-techniq
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/c0c963096e7b293346cec67b067178ec3b3d03aa7c52c3efde6d383f83108e22.png" src="../../_images/c0c963096e7b293346cec67b067178ec3b3d03aa7c52c3efde6d383f83108e22.png" />
<img alt="../../_images/4412b36c0dc39a4d6c65c9a6aad08baf8faca887dd58b21a17dd46efa1037249.png" src="../../_images/4412b36c0dc39a4d6c65c9a6aad08baf8faca887dd58b21a17dd46efa1037249.png" />
<img alt="../../_images/f6bd08357ce4e93b2b7f2147c0be430e9f2b5daae716d285580075283b2f422a.png" src="../../_images/f6bd08357ce4e93b2b7f2147c0be430e9f2b5daae716d285580075283b2f422a.png" />
</div>
</div>
Expand Down Expand Up @@ -492,9 +496,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/daed61b64374b3867150f79d2669d2f91aed482afbc10ecd174f00c7d0d141b7.png" src="../../_images/daed61b64374b3867150f79d2669d2f91aed482afbc10ecd174f00c7d0d141b7.png" />
<img alt="../../_images/206b4796802fdd775aa1b3b9a1d4f364bd3ac3d218cd5e3a45de4d94a88230a8.png" src="../../_images/206b4796802fdd775aa1b3b9a1d4f364bd3ac3d218cd5e3a45de4d94a88230a8.png" />
<img alt="../../_images/6fd2ace32477f771af6886a485c069316d1f5aa1d2c7b208781f2fec3da72a49.png" src="../../_images/6fd2ace32477f771af6886a485c069316d1f5aa1d2c7b208781f2fec3da72a49.png" />
<img alt="../../_images/7e5af8912d3d18a5d3946cab03f8b6d1d15f31934e8485c5c2257eebc3ccd8cf.png" src="../../_images/7e5af8912d3d18a5d3946cab03f8b6d1d15f31934e8485c5c2257eebc3ccd8cf.png" />
<img alt="../../_images/803c7c4e4fd945e1279b081367d874871218657940e31a56b970addb49aa8760.png" src="../../_images/803c7c4e4fd945e1279b081367d874871218657940e31a56b970addb49aa8760.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -515,7 +519,7 @@ <h1>Basic sampling techniques<a class="headerlink" href="#basic-sampling-techniq
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/82f3e0ec3eed124da24e2122a668e21c4986e850d8078b6736bca15bc6b587ea.png" src="../../_images/82f3e0ec3eed124da24e2122a668e21c4986e850d8078b6736bca15bc6b587ea.png" />
<img alt="../../_images/84ae33e8b02ff510bc2d03ff33d33dfcefbd219ff714f3c1c291e5ef2c9e975b.png" src="../../_images/84ae33e8b02ff510bc2d03ff33d33dfcefbd219ff714f3c1c291e5ef2c9e975b.png" />
</div>
</div>
<div class="cell docutils container">
Expand Down Expand Up @@ -543,7 +547,7 @@ <h1>Basic sampling techniques<a class="headerlink" href="#basic-sampling-techniq
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/c5dc96199f60ceb183007948027bc48dee39a061f9e1bc5a8164d669af0068bc.png" src="../../_images/c5dc96199f60ceb183007948027bc48dee39a061f9e1bc5a8164d669af0068bc.png" />
<img alt="../../_images/c07b835172869788e07467f333d4db96b538e6043a51f2a5a69f832c9d487052.png" src="../../_images/c07b835172869788e07467f333d4db96b538e6043a51f2a5a69f832c9d487052.png" />
</div>
</div>
<div class="cell docutils container">
Expand All @@ -564,7 +568,7 @@ <h1>Basic sampling techniques<a class="headerlink" href="#basic-sampling-techniq
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/c3062e446ec8c314bf0eb2b8f65d6cbe6e216af143b02ce566a56c08f98a6072.png" src="../../_images/c3062e446ec8c314bf0eb2b8f65d6cbe6e216af143b02ce566a56c08f98a6072.png" />
<img alt="../../_images/96430ec0f6f71b45aee44a527faf89e202a3b915666556814e270c64f373b79f.png" src="../../_images/96430ec0f6f71b45aee44a527faf89e202a3b915666556814e270c64f373b79f.png" />
</div>
</div>
</section>
Expand Down
18 changes: 11 additions & 7 deletions Tutorials/1. Geometry/domain_creation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,11 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/1.%20basic.html">Basics of network design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/2.%20test.html">Forward pass</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">FCNN training</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">1D Laplace Equation</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">2D heat conduction</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../6.%202D%20heat%20conduction/1.%20model.html">2D Laplace Equation</a></li>
</ul>

</div>
Expand Down Expand Up @@ -570,10 +574,6 @@ <h2>Domain Operations<a class="headerlink" href="#domain-operations" title="Link
If you need the exact volume for sampling,
use domain.set_volume()
warnings.warn(&quot;&quot;&quot;Exact volume of this union is not known, will use the
/home/hell/Desktop/repos/DeepINN/Tutorials/1. Geometry/../../DeepINN/geometry/domains/domainoperations/sampler_helper.py:50: UserWarning: Will sample random points in the created domain operation, with
a for loop over all input parameters, in total: 1
This may slow down the training.
warnings.warn(f&quot;&quot;&quot;Will sample random points in the created domain operation, with
/home/hell/Desktop/repos/DeepINN/Tutorials/1. Geometry/../../DeepINN/geometry/domains/domainoperations/sampler_helper.py:163: UserWarning: Will sample random points in the created domain operation, with
a for loop over all input parameters, in total: 1
This may slow down the training.
Expand All @@ -583,11 +583,15 @@ <h2>Domain Operations<a class="headerlink" href="#domain-operations" title="Link
If you need the exact volume for sampling,
use domain.set_volume()
warnings.warn(&quot;&quot;&quot;Exact volume of this intersection-boundary is not known,
/home/hell/Desktop/repos/DeepINN/Tutorials/1. Geometry/../../DeepINN/geometry/domains/domainoperations/sampler_helper.py:50: UserWarning: Will sample random points in the created domain operation, with
a for loop over all input parameters, in total: 1
This may slow down the training.
warnings.warn(f&quot;&quot;&quot;Will sample random points in the created domain operation, with
</pre></div>
</div>
<img alt="../../_images/39095da4e3681b4f883f05aa877e4258a41d3ad8118b76c49435e0a8d4765351.png" src="../../_images/39095da4e3681b4f883f05aa877e4258a41d3ad8118b76c49435e0a8d4765351.png" />
<img alt="../../_images/601ea68e24e42916aa6a7b94030fdf2a4b96fbbd2f71c4fd41fd65e22f15e63b.png" src="../../_images/601ea68e24e42916aa6a7b94030fdf2a4b96fbbd2f71c4fd41fd65e22f15e63b.png" />
<img alt="../../_images/c4b10e252b4a42b63b7f8ba3ffe9dcf0a37f09dfb9b5015ffea44f3b92154f09.png" src="../../_images/c4b10e252b4a42b63b7f8ba3ffe9dcf0a37f09dfb9b5015ffea44f3b92154f09.png" />
<img alt="../../_images/ae1d790f90877cf596b916473acbdce58b4c552893ed07782878212cc3a267a6.png" src="../../_images/ae1d790f90877cf596b916473acbdce58b4c552893ed07782878212cc3a267a6.png" />
<img alt="../../_images/0b65fb81935d9b536bac49b9ce552789a856696698c60790203554ddf2b235dc.png" src="../../_images/0b65fb81935d9b536bac49b9ce552789a856696698c60790203554ddf2b235dc.png" />
</div>
</div>
<p>For the product, we create the Cartesian product of an interval and circle to get a cylinder:</p>
Expand Down
12 changes: 8 additions & 4 deletions Tutorials/1. Geometry/polygons_external_objects.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,11 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/1.%20basic.html">Basics of network design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/2.%20test.html">Forward pass</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">FCNN training</a></li>
<li class="toctree-l1"><a class="reference internal" href="../5.%20FCNN/3.%20model.html">1D Laplace Equation</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">2D heat conduction</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../6.%202D%20heat%20conduction/1.%20model.html">2D Laplace Equation</a></li>
</ul>

</div>
Expand Down Expand Up @@ -518,7 +522,7 @@ <h2>Polygons<a class="headerlink" href="#polygons" title="Link to this heading">
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/9d910c59b979351580bad7b9326f56df23f0daf068ee071783c357b1d4e68195.png" src="../../_images/9d910c59b979351580bad7b9326f56df23f0daf068ee071783c357b1d4e68195.png" />
<img alt="../../_images/91f6b7848fce08ea52b2001f2a0cef281609e98f5ca01895fd8a98558480308d.png" src="../../_images/91f6b7848fce08ea52b2001f2a0cef281609e98f5ca01895fd8a98558480308d.png" />
</div>
</div>
</section>
Expand Down Expand Up @@ -547,7 +551,7 @@ <h2>External Objects<a class="headerlink" href="#external-objects" title="Link t
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/92f74df55b4a0f1b62f1025f5f1fe8b6dcff79a2f3bd957874940b437dce8415.png" src="../../_images/92f74df55b4a0f1b62f1025f5f1fe8b6dcff79a2f3bd957874940b437dce8415.png" />
<img alt="../../_images/47b4b341773de9f6d693a5307d953a244c698eb425b184360da2fea718480472.png" src="../../_images/47b4b341773de9f6d693a5307d953a244c698eb425b184360da2fea718480472.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 @@ -571,7 +575,7 @@ <h2>External Objects<a class="headerlink" href="#external-objects" title="Link t
</div>
</div>
<div class="cell_output docutils container">
<img alt="../../_images/44c5413b0f3a3c74d2a24014a43e6b1d8de981c8ba61240fdcfbe2c96aaf1160.png" src="../../_images/44c5413b0f3a3c74d2a24014a43e6b1d8de981c8ba61240fdcfbe2c96aaf1160.png" />
<img alt="../../_images/7ebbc278b003591cf284a4aa06811025a7863bf2774eded0b519e12e91dabae8.png" src="../../_images/7ebbc278b003591cf284a4aa06811025a7863bf2774eded0b519e12e91dabae8.png" />
</div>
</div>
</section>
Expand Down
Loading

0 comments on commit ababd1d

Please sign in to comment.