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

FiNeR is developed on GNU/Linux. Windows should work out of the box but is not officially tested.

Download

Clone the repository:

git clone https://github.com/szaghi/FiNeR
cd FiNeR

FiNeR does not use git submodules: a recursive clone fetches nothing more. The third-party dependencies are fetched into src/third_party/ by FoBiS.py, and they must be there before building with CMake or FoBiS.py (fpm fetches its own, see Build with fpm):

pip install FoBiS.py
fobis fetch --no-build   # clone the dependencies into src/third_party/

Without FoBiS.py, clone them by hand:

for dep in BeFoR64 FACE FLAP PENF StringiFor; do
  git clone https://github.com/szaghi/$dep src/third_party/$dep
done

Third-Party Dependencies

The dependencies live under src/third_party/:

Library	Purpose
PENF	Portable numeric kind parameters (I4P, R8P, etc.)
StringiFor	string type used throughout for string operations
FACE	ANSI terminal color/style support
FLAP	Fortran command-line argument parser
BeFoR64	Base64 encoding

Build with CMake (preferred)

CMake is the recommended build system for library use and integration into other projects. It builds the dependencies from src/third_party/, so fetch them first (see Download).

mkdir build && cd build
cmake ..
make

Run the test suite

ctest          # run all tests
ctest -R <test_name>   # run a single named test
ctest -V       # verbose output

Each test prints "Are all tests passed? T" on success.

CMake subdirectory integration

To embed FiNeR in an existing CMake project, place a clone of FiNeR alongside your sources, fetch its dependencies into FiNeR/src/third_party/ (see Download), and add to your CMakeLists.txt:

add_subdirectory(FiNeR)

target_link_libraries(your_target FiNeR::FiNeR)

FetchContent alone is not enough, because it downloads FiNeR without its dependencies: the configure step fails on the missing src/third_party/ directories.

Build with fpm

fpm fetches the dependencies itself from fpm.toml (PENF and StringiFor, which brings BeFoR64 and FACE), so src/third_party/ is not needed. To use FiNeR in an fpm project, add to its fpm.toml:

[dependencies]
FiNeR = { git = "https://github.com/szaghi/FiNeR" }   # or pin a release: tag = "vX.Y.Z"

To build and test FiNeR itself:

fpm build
fpm test                       # run all tests
fpm test finer_test_get        # run a single test

fpm test runs the tests from the project root, where they find their data files (src/tests/*.ini).

git color.diff = always

fpm reads the commit of each dependency from the git log header. With color.diff = always (or color.ui = always) in your git configuration the commit carries an ANSI escape, and the next fpm run fails parsing build/cache.toml ("unexpected invalid sequence"). Use auto, or run fpm with GIT_CONFIG_PARAMETERS="'color.ui=auto' 'color.diff=auto'", then remove build/.

Build with FoBiS.py

FoBiS.py is used by the CI pipeline for coverage analysis and documentation generation.

pip install FoBiS.py

List all build modes

fobis build --lmodes

Available modes:

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

Build and run tests

fobis fetch
fobis build --mode tests-gnu
./scripts/run_tests.sh

Compiled test executables are placed in ./exe/.

Build the library

# Static library (GNU gfortran)
fobis build --mode finer-static-gnu

# Shared library (GNU gfortran)
fobis build --mode finer-shared-gnu

# Static library (Intel Fortran)
fobis build --mode finer-static-intel

The library is placed in ./static/ or ./shared/ respectively.

Coverage and documentation

fobis rule --ex makecoverage   # build + run tests + gcov report
fobis rule --ex makedoc        # build API documentation