Skip to content

Commit

Permalink
ENH: Removing all references to CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-moore22 committed Apr 3, 2024
1 parent db331ad commit faede60
Show file tree
Hide file tree
Showing 6 changed files with 2 additions and 288 deletions.
14 changes: 0 additions & 14 deletions assets/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -1150,20 +1150,6 @@ About Us Page
}


/*
---------------------------------------------
CLI Guide
---------------------------------------------
*/

.field-description thead th {
text-align: center;
}

.uml-diagram {
width: 100%;
}

/*
---------------------------------------------
Installation
Expand Down
Binary file removed assets/images/cli.png
Binary file not shown.
248 changes: 0 additions & 248 deletions cli-guide.html

This file was deleted.

1 change: 0 additions & 1 deletion developer-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ <h2>Folder Structure</h2>
- src
- meshes // Suite of example meshes
- src
- CLI // Command Line Interface for parallel solvers
- Parallel-Solvers
- Simulation_Parameters.h // Comprehensive example of Yaml input parsing
- User-Material-Interface // Contains placeholders for implementing custom material models
Expand Down
18 changes: 0 additions & 18 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,24 +184,6 @@ <h4>Graphical Interface</h4>
</div>
</div>
</div>
<div class="col-lg-4">
<div class="user-guide">
<div class="thumb">
<img src="assets/images/cli.png" alt="">
</div>
<div class="down-content">
<div class="left-content">
<div class="main-button">
<a href="cli-guide.html">Explore</a>
</div>
</div>
<div class="right-content">
<h4>Command Line Interface</h4>
<p>The Fierro command line interface offers a modular interface into each piece of functionality.</p>
</div>
</div>
</div>
</div>
<div class="col-lg-4">
<div class="user-guide">
<div class="thumb">
Expand Down
9 changes: 2 additions & 7 deletions installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ <h5><a id="evpfft-gui-anchor">EVPFFT-GUI</a></h5>

<h2>Backend Applications</h2>
<p>
To drive the different simulation software in <em>Fierro</em>, we have several backend applications. In general, the collection of backend applications provides a superset of the graphical user interface functionality and it may be necessary to use these applications directly depending on your workflows. Typically, these are bundled together and made available via the <em>Fierro</em> command line interface.
To drive the different simulation software in <em>Fierro</em>, we have several backend applications. In general, the collection of backend applications provides a superset of the graphical user interface functionality and it may be necessary to use these applications directly depending on your workflows.
</p>
<h5><a id="evpfft-anchor">EVPFFT</a></h5>
<p>
Expand Down Expand Up @@ -164,18 +164,13 @@ <h5>Explicit Solver</h5>
<p>Which will provide you with instructions on how to select which hardware you would like to compile <em>Fierro</em> for.</p>
<h2>Tools</h2>
<p>
In addition to the end to end tooling provided in the main backend application, some miscellaneous tools are available should you want to use them directly for your applications. All standalone tools listed here are available under the Fierro command line interface. While these tools do not depend on <a href="https://github.com/trilinos/Trilinos">Trilinos</a>, like some of the solvers, they do depend on <a href="https://github.com/lanl/ELEMENTS">Elements</a>. So to build them from source, ensure that the Elements submodule under <code>Fierro/lib</code> is checked out recursively.
</p>
<p>
To build just the fierro command line interface and the extra tools, run (from the Fierro root):
In addition to the end to end tooling provided in the main backend application, some miscellaneous tools are available should you want to use them directly for your applications. While these tools do not depend on <a href="https://github.com/trilinos/Trilinos">Trilinos</a>, like some of the solvers, they do depend on <a href="https://github.com/lanl/ELEMENTS">Elements</a>. So to build them from source, ensure that the Elements submodule under <code>Fierro/lib</code> is checked out recursively.
</p>
<pre><code>mkdir build
cd build
cmake .. -DBUILD_PARALLEL_EXPLICIT_SOLVER=OFF -DBUILD_IMPLICIT_SOLVER=OFF
make
</code></pre>
<p>
This will make the command line interface and extra tools available under <code>.../Fierro/build/bin</code>.
</p>
<h5>Mesh Generator</h5>
<p>
Expand Down

0 comments on commit faede60

Please sign in to comment.