Installation

Prerequisites

A Fortran 2003+ compliant compiler is required. The following compilers are known to work:

Compiler	Minimum version
GNU gfortran	≥ 5.3.0
Intel Fortran (ifort / ifx)	≥ 16.x

FOSSIL is developed on GNU/Linux. Windows should work but is not officially tested.

Download

FOSSIL uses git submodules for its third-party dependencies. Clone recursively:

git clone https://github.com/szaghi/FOSSIL --recursive
cd FOSSIL

If you already have a non-recursive clone:

git submodule update --init

Third-Party Dependencies

The submodules live under src/third_party/:

Library	Purpose
PENF	Portable numeric kind parameters (I4P, R8P, etc.)
VecFor	3D vector type and operations (vector_R8P, unit vectors, rotation/mirror matrices)
FLAP	Fortran command-line argument parser (used by fossilizer)
FACE	ANSI terminal color/style support
BeFoR64	Base64 encoding
FoXy	XML/XDMF support
StringiFor	String utilities
VTKFortran	VTK file I/O

Build with FoBiS.py

FoBiS.py is the primary build system. Install it once with pip:

pip install FoBiS.py

List all build modes

FoBiS.py build -lmodes

Available modes:

Mode	Description
static-gnu	Static library with gfortran (release)
shared-gnu	Shared library with gfortran (release)
static-gnu-debug	Static library with gfortran (debug + checks)
shared-gnu-debug	Shared library with gfortran (debug)
tests-gnu	Build all tests with gfortran (release)
tests-gnu-debug	Build all tests with gfortran (debug)
static-intel	Static library with ifort (release)
shared-intel	Shared library with ifort (release)
tests-intel	Build all tests with ifort (release)
tests-intel-debug	Build all tests with ifort (debug)

Build the library

# Static library (GNU gfortran)
FoBiS.py build -mode static-gnu

# Shared library (GNU gfortran)
FoBiS.py build -mode shared-gnu

# Static library (Intel Fortran)
FoBiS.py build -mode static-intel

The library is placed in ./static/ or ./shared/ respectively. Module files go to ./mod/.

Build and run tests

FoBiS.py build -mode tests-gnu
./scripts/run_tests.sh

Compiled test executables are placed in ./exe/. Each test prints "Are all tests passed? T" on success.

To run a single test:

./exe/fossil_test_clip

Coverage and documentation

FoBiS.py rule -ex makecoverage   # build + run tests + gcov report
FoBiS.py rule -ex makedoc        # build ford API docs + VitePress site

Alternative builds

The scripts/install.sh helper also supports make and cmake backends:

./scripts/install.sh --build make
./scripts/install.sh --build cmake