From e0bee781722ac10be0bb1415a87b3e5df1058d63 Mon Sep 17 00:00:00 2001 From: Jacob Moore Date: Wed, 11 Sep 2024 11:31:21 -0500 Subject: [PATCH] ENH: Updating docs with new conda distribution names --- gui-guide.html | 4 ++-- installation.html | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/gui-guide.html b/gui-guide.html index 92875a486..4fffb80b5 100644 --- a/gui-guide.html +++ b/gui-guide.html @@ -55,11 +55,11 @@

GUI Guide

Fierro GUI

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, + use the gui is through the anaconda package "fierro-gui" available on our package repository. For more detailed installation instructions, see our installation guide.

- Once the Fierro GUI is installed, it can be launched by running the fierro_gui command. The instructions that follow will + Once the Fierro GUI is installed, it can be launched by running the fierro-gui command. The instructions that follow will guide a user through the steps to run the EVPFFT solver from the GUI.

1. Importing a Part

diff --git a/installation.html b/installation.html index 83ff1f38e..6d56832be 100644 --- a/installation.html +++ b/installation.html @@ -63,15 +63,15 @@

Installation

To install the finite element physics solvers in Fierro, please type, while within the activated Anaconda environment: - 

 conda install -c conda-forge -c fierromechanics fierro-cpu
+ 
 conda install -c conda-forge -c fierromechanics fierro-fe-cpu

The EVPFFT physics solver in Fierro can be installed by typing: - 

 conda install -c conda-forge -c fierromechanics evpfft
+ 
 conda install -c conda-forge -c fierromechanics fierro-evpfft-cpu

A GUI is offered, it can be installed by typing: - 

 conda install -c conda-forge -c fierromechanics fierro_gui
+ 
 conda install -c conda-forge -c fierromechanics fierro-gui

After installing the finite element solvers, it gives you access to fierro-mesh-builder, @@ -161,7 +161,7 @@

FIERRO-GUI

Our standalone FIERRO-GUI software can be installed with:

- 
conda install -c conda-forge -c fierromechanics fierro_gui
+ 
conda install -c conda-forge -c fierromechanics fierro-gui

This will give you access to both the evpfft and fierro-gui commands to launch the comamnd line EVPFFT backend or the associated graphical user interface, respectively.

@@ -177,7 +177,7 @@

Backend Applications

EVPFFT

- The elasto-viscoplastic fast fourier transform program simulates the response of polycrystalline microstructures under multiple types of load. It is available from the fierro-evpfft and fierro-evpfft-cuda Anaconda packages. Installing these directly will pull in all necessary dependencies and give you access to the software through the evpfft command. Example input files for this application can be found under Fierro/src/EVPFFT/example_input_files. + The elasto-viscoplastic fast fourier transform program simulates the response of polycrystalline microstructures under multiple types of load. It is available from the fierro-evpfft-cpu Anaconda package. Installing this directly will pull in all necessary dependencies and give you access to the software through the evpfft command. Example input files for this application can be found under Fierro/src/EVPFFT/example_input_files.

If you wish to build this application from source, there is a comprehensive build script available to configure the environment and build all of the necessary dependencies. To invoke the script, run: @@ -188,7 +188,7 @@

EVPFFT

Implicit Solver

- The implicit solver for solving static equations can be acquired through the fierro-cpu, fierro-cuda (coming soon), and fierro-hip (coming soon) Anaconda packages. Installing these directly will pull in all necessary dependencies and give you access to the software through the fierro command. Example input files for this application can be found under Fierro/src/Parallel-Solvers/Implicit-Lagrange/example_*.yaml. + The implicit solver for solving static equations can be acquired through the fierro-fe-cpu, fierro-fe-cuda (coming soon), and fierro-fe-hip (coming soon) Anaconda packages. Installing these directly will pull in all necessary dependencies and give you access to the software through the fierro command. Example input files for this application can be found under Fierro/src/Parallel-Solvers/Implicit-Lagrange/example_*.yaml.

If you wish to build this application from source, there is a comprehensive build script available to configure the environment and build all of the necessary dependencies. To invoke the script, run: @@ -200,7 +200,7 @@

Implicit Solver

Explicit Solver

- The explicit solver for simulating dynamic time evolution can be acquired through the fierro-cpu, fierro-cuda (coming soon), and fierro-hip (coming soon) Anaconda packages. Installing these directly will pull in all necessary dependencies and give you access to the software through the fierro command. Example input files for this application can be found under Fierro/src/Parallel-Solvers/Parallel-Explicit/example_*.yaml. + The explicit solver for simulating dynamic time evolution can be acquired through the fierro-fe-cpu, fierro-fe-cuda (coming soon), and fierro-fe-hip (coming soon) Anaconda packages. Installing these directly will pull in all necessary dependencies and give you access to the software through the fierro command. Example input files for this application can be found under Fierro/src/Parallel-Solvers/Parallel-Explicit/example_*.yaml.

If you wish to build this application from source, there is a comprehensive build script available to configure the environment and build all of the necessary dependencies. To invoke the script, run: