FlowSieve
3.4.0
FlowSieve Coarse-Graining Documentation
|
A guide to installing and compiling FlowSieve.
system.mk
file)The following, while not required to run FlowSieve itself, are required to run the tutorial. These requirements are outline in Tutorials/environment.yml
to facility create an anaconda environment. Note that these exact package versions may not be required, but they are sufficient. That is, other package versions may work, but have not been tested.
First, you will need to copy the FlowSieve source files onto your HPC system. The source files are available through git (https://github.com/husseinaluie/FlowSieve), allowing you to directly copy/fork the repository, or download a zipped version.
Next, you will need to create a system.mk
file in the main code directory that specifies the compilers and provides the compiler flags needed to link to the appropriate libraries.
Some system files are already provided in the Systems
directory for a few computing environments, and may be a helpful reference. Where appropraite, they specify which modules are needed to compile and run the code (note: these modules need to be loaded both when you compile the code and also when you run the code).
If you create a system file for a computing environment that was not previously included, please consider submitting it to the repository so that others can benefit from it.
The Systems
directory contains a few sample system files. To prepare a system file for your machine, there are a few steps.
Systems
to system.mk
into the main directory.-fopenmp
to -qopenmp
for intel compilers)-ip -ipo
for intel compilers.LIB_DIRS
and INC_DIRS
If you are unsure of how to make an appropriate system.mk
file, please feel free to contact the FlowSieve developers for support.
A makefile is included to simplify compiling. As a first test of your install, try make clean; make Case_Files/coarse_grain.x
. If the executable compiles successfully, then a good next step is to check out the tutorials that are provided to familiarize yourself with the code usage.
make clean
make hardclean
clean
removals, also removes the executables, symbol table (dSYM)make Case_Files/<filename>.x
Case_Files
contains the main files that can be compiled into executables.make docs
doxygen
and dot
must be installed and on the pathmake cleandocs
Some of the executables (such as interpolator.x and helmholtz_projection.x) require the use of a third-party library, ALGLIB. To compile this library, simply call make ALGLIB
(should only need to be done once, unless you call make hardclean
, change system libraries, etc.).