How to get FALL3D
FALL3D is maintained in a public git repository, which contains the stable releases and the current working code. Stable version releases of the FALL3D source code are available as a tarball or zip file and can be downloaded from the Releases section.
However, we strongly recommend to clone the git repository especially if you want to update the source code or select different versions in case of problems. In order to obtain the software from the gitlab repository, you must first download and install the git software.
Then clone the repository using the following command line:
> git clone git@gitlab.com:fall3d-suite/fall3d.git
After cloning, a directory fall3d should have been created.
Code changes are made fairly frequently in the gitlab repository. It is recommended to update the code periodically so that you have the latest version of FALL3D available on your computer. In order to update your local version of the source code, enter the FALL3D directory and pull all changes from a remote repository:
> cd fall3d
> git pull
Notes:
- Every time the source code is updated with
git pull, the compilation process detailed below must be repeated.
Verify that installation program prerequisites are present on your system before proceeding. See section Installation requirements for further details.
Basic installation
There are two different options to configure and install FALL3D.
The basic installation uses the configure script and this option
is intended for users that need a single configuration of the code.
In constrast, the second option can be useful when multiple
installations are required. The basic installation is described in
this section. See section Multiple installations
for a description of the second installation procedure.
For the basic installation, simply type the following commands from the installation folder:
> ./configure
> make
> make install
in order to configure, compile and place the executable file in
the bin folder. The configure script admits the following options:
| Option | Comments |
|---|---|
| --with-r4 | compiles using single precision |
| --enable-parallel | enables parallel option |
| --disable-parallel | disables parallel option |
| --prefix= | installation folder |
| FCFLAGS= | FORTRAN compiler flags |
| NETCDF= | path of the netCDF library base folder |
| NETCDF_INC= | path of the netCDF include folder |
| NETCDF_LIB= | path of the netCDF lib folder |
If no arguments are provided, configure is run by default as:
> .\configure --enable-parallel --prefix=. FCFLAGS='-g -O2'
and the configure script automatically searches for the correct
netCDF paths.
Multiple installations
Alternatively, FALL3D can be installed using the build script
in order to allow multiple installations with different configurations
(e.g. serial and parallel, single and double precision, different
compilation flag options). In addition, with this approach it is
possible to have installations for different High Performance Computing
(HPC) architectures sharing a common file system.
For each installation based on the build script, use the command:
> build [-h] [par|ser] [r4|r8] [build-dir]
where the arguments in brackets are optional and take the following default values:
| Argument | Default | Comments |
|---|---|---|
| -h | none | prints the buildoptions |
| par or ser | par | builds with parallel/serial code options |
| r4 or r8 | r8 | builds with single/double code options |
| build-dir | binary | build directory name |
For example,
> ./build r4 machine1-r4-par
> ./build ser machine2-r8-ser
will build (i.e. configure, compile and install) two FALL3D instances:
in the machine1-r4-par folder a parallel with single precision installation
and another serial with double precision installation in the machine2-r8-ser
folder. Different installations are completely independent and can be
reconfigured and recompiled at any time within the respective folder
following the Basic installation procedure.
Uninstalling
To uninstall FALL3D use the command
> make uninstall
in the installation folder to get rid of all the installed files.