Installation

To install FLATiron, you must have Python 3.8 or higher installed on your system. It is recommended to use a virtual environment to manage dependencies.

Quick Installation Guide

Install the following required libraries before installing FLATiron:

1. dolfinx version 0.9.0: (recommended intallation method: conda)

   You can find instructions for installing dolfinx on the FEniCS project website.

2. ADIOS4DOLFINx version 0.9.4: (recommended intallation method: conda)

   You can find instructions for installing adios4dolfinx on their GitHub repository.

3. GMSH: (recommended intallation method: pip)*

   You can find instructions for installing GMSH on the GMSH website.

Once you have installed the required libraries, you can install FLATiron using pip. Download the source code for FLATiron, navigate into the FLATiron directory and run:

pip install .

Detailed Installation Walkthrough

FLATiron is intended to be installed within an environment manager like Anaconda on UNIX-like systems (macOS, Linux, Ubuntu, etc.). Windows users should install a Linux subsystem. These instructions assume you are using Anaconda on a UNIX-like system. Here, we install FLATiron into the home directory. You may install FLATiron into any directory on your UNIX-like system.

Starting from the home directory:

1. Create a new conda environment to install FLATiron into:

   conda create -n FLATiron-env
   

2. Activate the new Anaconda environment and confirm that the environment name appears next to your prompt:

   conda activate FLATiron-env
   

3. Install the libmamba solver for faster installation:

   conda install conda-libmamba-solver
   

4. Install FEniCSx-dolfinx, mpich, and pyvista. Notice we are installing dolfinx v0.9.0 — you must specify the DOLFINx version number during installation. We set the solver to libmamba.

   conda install -c conda-forge fenics-dolfinx=0.9.0 mpich pyvista --solver=libmamba
   

5. Install ADIOS4DOLFINx using conda. ADIOS4DOLFINx is available on its GitHub page.

   conda install -c conda-forge adios4dolfinx=0.9.4
   

6. Install GMSH using pip:

   pip install gmsh
   

7. Navigate to the FLATiron GitHub page. Clone the repository using git (recommended), or download and extract the source archive. Clone the source code from GitHub:

   git clone git@github.com:flowlabcu/FLATiron.git
   

8. Navigate to the top level of the FLATiron source directory:

   cd FLATiron
   

9. Install FLATiron using pip:

   pip install .
   

Congratulations! You have successfully installed FLATiron.