Skip to content

Commit

Permalink
updated documenation to emphasis using WSL-2 with Windows machines
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathaniel Morgan committed Apr 17, 2024
1 parent 47d9e4c commit e28a468
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,15 @@
<!-- main content area -->
<div class="col-sm-9 text-content">
<h1>Installation</h1>
<p><em>Fierro</em> backend is designed to run on almost all hardware that you might want to use for a simulation. We support three CPU architectures (x86_64, arm64, ppc64le), as well as CUDA GPUs through nvcc and AMD GPUs through HIP. Additionally, we support both Linux and MacOS. To run <em>Fierro</em> on Windows we recommend making use of the
<a href="https://learn.microsoft.com/en-us/windows/wsl/install">Windows Subsystem for Linux</a>.
<p><em>Fierro</em> backend is designed to run on almost all hardware that you might want to use for a simulation. We support three CPU architectures (x86_64, arm64, ppc64le),
as well as CUDA GPUs through nvcc and AMD GPUs through HIP. Additionally, we support both Linux and MacOS. To run <em>Fierro</em> on Windows please use
<a href="https://learn.microsoft.com/en-us/windows/wsl/install">Windows Subsystem for Linux (WSL)</a>.
</p>
<p>
To make the installation process as simple as possible, we offer several pre-compiled binaries through <a href="https://www.anaconda.com/">Anaconda</a>
for the backend software. The builds for <em>Fierro</em>, as well as its primary dependencies, can be found <a href="https://anaconda.org/fierromechanics">here</a> for all supported platforms.
Anaconda will automatically select the right build for your OS and CPU architecture, however, you must select the correct build based on which GPU hardware is present.
This can be seen in the package prefix (-cpu, -cuda, -hip).
Anaconda will automatically select the right build for your OS and CPU architecture, however, you must select the correct build based on which GPU hardware is present.
This can be seen in the package prefix (-cpu, -cuda, -hip). At this time, <u>the Anaconda <em>Fierro</em> executables for the Windows OS are restricted to running inside WSL-2</u>.
</p>
<p>
To use Anaconda, follow the steps for your platform to install
Expand All @@ -56,7 +57,8 @@ <h1>Installation</h1>
<pre><code> conda create -n FierroCode </code></pre>
<pre><code> conda activate FierroCode </code></pre>

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.
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.

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

Expand Down

0 comments on commit e28a468

Please sign in to comment.