Skip to content

Commit

Permalink
updated formating and text on webpage
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathaniel Morgan committed May 10, 2024
1 parent 3d473d7 commit d4a9c5d
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 22 deletions.
28 changes: 18 additions & 10 deletions gui-guide.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,28 @@
<h1>GUI Guide</h1>
<p>
<em>Fierro</em> comes with two separate user interfaces for different workflows.
<li>The EVPFFT-GUI can be used to run the standalone EVPFFT program</li>
<li>The Fierro-GUI can be used to run the EVPFFT and explicit finite element material dynamics solver </li>
<li>The Fierro-GUI (Coming Soon) allows you to configure dynamic simulation or topology optimization problems.</li>
<b>Note:</b> if you are running any of the graphical user interfaces through WSL on windows, you may need to install and run an "X Server" on your Windows side to connect the WSL applications to the display. For testing, we use <a href="https://sourceforge.net/projects/vcxsrv/">VcXsrv</a>. Once the X server is running on Windows, you can connect your WSL terminal application to the display by setting the DISPLAY environment variable:
The GUI can run on <b>Linux, Mac, and Windows (inside WSL-2) machines</b>.
<u>Note:</u> if you are running any of the graphical user interfaces through WSL on windows,
you may need to install and run an "X Server" on your Windows side to connect the WSL applications to the display.
For testing, we use <a href="https://sourceforge.net/projects/vcxsrv/">VcXsrv</a>. Once the X server is running on Windows,
you can connect your WSL terminal application to the display by setting the DISPLAY environment variable:
<pre><code>export DISPLAY=localhost:0.0</code></pre>
</p>
<h2>EVPFFT-GUI</h2>
<h2>Fierro-GUI</h2>
<p>
The EVPFTT-GUI is a Python based user interface that integrates with paraview to render initial conditions and results. The recommended way to
use the gui is through the anaconda package "evpfft_gui" available on our package repository. For more detailed installation instructions,
The Fierro-GUI is a Python based user interface that integrates with paraview to render initial conditions and results. The recommended way to
use the gui is through the anaconda package "fierro_gui" available on our package repository. For more detailed installation instructions,
see <a href=installation.html>our installation guide</a>.
</p>
<p>
Once the EVPFFT-GUI is installed, it can be launched by running the <code>evpfft-gui</code> command.
Once the Fierro-GUI is installed, it can be launched by running the <code>fierro_gui</code> command. The instructions that follow will
guide a user through the steps to run the EVPFFT solver from the GUI.
</p>
<h3>1. Importing a Part</h3>
<p>
The first step to running EVPFFT is importing a part geometry for analysis. EVPFFT operates on a voxelized grid, however the EVPFFT-GUI requires a triangle mesh in a binary STL format and will do the necessary voxelization automatically. To import a part, click the "Import Part" button followed by the "Upload Geometry File" button and select the input STL file.
The first step to running EVPFFT is importing a part geometry for analysis. EVPFFT operates on a voxelized grid, however the GUI requires a triangle mesh in a binary STL format and will do the necessary voxelization automatically. To import a part, click the "Import Part" button followed by the "Upload Geometry File" button and select the input STL file.
</p>
<img src="assets/images/EVPFFT-GUI-Import.png"/>
<h2>2. Voxelization</h2>
Expand Down Expand Up @@ -93,13 +98,16 @@ <h4>Running</h4>
<h4>Results</h4>
<div style="display: flex;">
<p>
Once the process is complete, you can view some results the results directly in the EVPFFT-GUI, or open them in ParaView for more detailed analysis. Within this application, you can view the stress strain curves or examine a 3D render of your voxelized mesh with strain or stress color coding.
Once the process is complete, you can view some results the results directly in the GUI, or open them in ParaView for more detailed analysis. Within this application, you can view the stress strain curves or examine a 3D render of your voxelized mesh with strain or stress color coding.
</p>
<img src="assets/images/EVPFFT-GUI-ResultsOptions.png" />
</div>
<img src="assets/images/EVPFFT-GUI-MonkeyResults.png" />
<h2>Fierro GUI</h2>
Coming soon...

<p>
<br>
More features coming soon...
</p>
</div>
</div>
</div>
Expand Down
32 changes: 20 additions & 12 deletions installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,32 +54,40 @@ <h1>Installation</h1>
<a href="https://mamba.readthedocs.io/en/latest/installation.html">mamba</a>.

Next, open a terminal on your machine and go to a folder where you want to run the <em>Fierro</em> code. Then create and activate an Anaconda environment by typing:
<pre><code> conda create -n FierroCode </code></pre>
<pre><code> conda activate FierroCode </code></pre>

<pre style="margin-bottom: -1.50em;"><code> conda create -n FierroCode </code></pre>
<pre style="margin-top: -1.50em;";><code> conda activate FierroCode </code></pre>
</p>
<p style="margin : 0; padding-top:0;">
In this example, the enviroment is called FierroCode, but any name can be used. In some cases, the text to activate an enviroment is <code>source activate FierroCode</code>.
Likewise, if an enviroment already exists, then just activate the desired environment.

</p>
<p>
To install the finite element physics solvers in <em>Fierro</em>, please type, while within the activated Anaconda environment:

<pre><code> conda install -c conda-forge -c fierromechanics fierro-cpu </code></pre>

</p>
<p style="margin : 0; padding-top:0;">
The EVPFFT physics solver in <em>Fierro</em> can be installed by typing:

<pre><code> conda install -c conda-forge -c fierromechanics evpfft </code></pre>

</p>
<p>
A GUI is offered, it can be installed by typing:

<pre><code> conda install -c conda-forge -c fierromechanics fierro_gui </code></pre>
</p>
<p>
After installing the finite element solvers, it gives you access to <code>fierro-mesh-builder</code>,
<code>fierro-parallel-explicit</code>, <code>fierro-parallel-implicit</code>, and the
<code>fierro-voxelizer</code> executables. These can be run by calling the appropriate executable with the
desired input. For example, to call the parallel explicit hydrodynamics solver, use the following command:

After installing the finite element solvers, it gives you access to <code>fierro-mesh-builder</code>, <code>fierro-parallel-explicit</code>, <code>fierro-parallel-implicit</code>, and the <code>fierro-voxelizer</code> executables. These can be run by calling the appropriate executable with the desired input. For example, to call the parallel explicit hydrodynamics solver, use the following command:

<pre><code> fierro-parallel-explicit input.yaml </code></pre>

</p>
<p style="margin : 0; padding-top:0;">
A sample input file for the explicit finite element solver is in the
<a href="https://github.com/lanl/Fierro/tree/main/src/Parallel-Solvers/Parallel-Explicit">Fierro GitHub code respository</a> at:
<pre><code>./src/Parallel-Solvers/Parallel-Explicit/example_simple.yaml</code></pre>

</p>
<p style="margin : 0; padding-top:0;">
The GUI can be run in the anaconda enviroment by typing:
<pre><code>fierro-gui </code></pre>

Expand Down

0 comments on commit d4a9c5d

Please sign in to comment.