This is a unitary collection of fortran modules and procedures for scientific calculations. The library aims to provide a simple and generic environment for any scientific or mathematic computations. The project is largely inspired by SciPy for Python and tries to closely follow its guidelines and naming convention.

There are large areas that are still not covered.
Anyone is welcome to contribute or to test the software.

• GNU Fortran (gfortran) > 5.0 OR Intel Fortran Compiler Classic (ifort) > 13.0
• CMake ≥ 3.0 [> 3.16 for ninja support]
• Make OR Ninja ≥ 1.10
• LAPACK / BLAS [if not present in your system unoptimized¹ versions will be compiled]
• MPI [optional, recommended]
• ScaLAPACK [optional, recommended]

If any of the required libraries is not available in your system, or the version requirement is not satisfied, please install/upgrade them. We generally advice for pre-packaged versions, as provided by either apt, pip, brew, conda or spack. The latter may provide the best options for HPC environments (trivial installation without sudo, easy management of interdependent multiple versions, automatic generation of environment modules, etc.), but choose freely according to your needs.

Our build system relies on CMake. Experimental support for linking Intel's MKL is provided, although it may fail on some systems.

Clone the SciFortran repo:

git clone https://github.com/aamaricci/SciFortran scifor

Optionally² define the fortran compiler:

export FC=mpif90 # or gfortran or ifort if you don't need MPI

From the repository directory (cd scifor) make a standard out-of-source CMake compilation:

mkdir build 
cd build  
cmake .. 
make

mkdir build    
cd build  
cmake -GNinja ..  
ninja

In both cases you can pass additional options to the cmake command, to customize the build (default values between < >):

• -DPREFIX=prefix/directory <~/opt/scifor>, to specify a custom installation directory

• -DUSE_MPI=<yes>/no, to (de)activate MPI support

• -DVERBOSE=yes/<no>, to generate verbose makefiles

• -DBUILD_TYPE=<RELEASE>/TESTING/DEBUG, to select predefined compiler options

• -DWITH_BLAS_LAPACK=yes/<no>, to skip search of preinstalled linear algebra libraries and enforce compilation from source

• -DWITH_SCALAPACK=<yes>/no, to link with preinstalled ScaLAPACK library, for parallel algebra support.

System-wide installation is completed after the build step using either:

make install

or

ninja install

To actually link the library we provide some alternatives:

• A generated pkg-config file to, installed to ~/.pkgconfig.d/scifor.pc
• A generated environment module, installed to ~/.modules.d/scifor/<PLAT>/<VERSION>
• A generated bash script at <PREFIX>/bin/configvars.sh, to be sourced for permanent loading.

which you can choose among by following the instructions printed on screen.

CMake does not officially provide uninstall procedures in the generated Make/Ninja files. Hence SciFortran supplies a homebrew method to remove the generated files by calling (from the relevant build folder): make uninstall / ninja uninstall.

The repository is configured for source-based, automated, API docs generation via FORD, so that you can build the html files for your specific local version by running

ford docs.config

at the root directory of the project. Alternatively you can examine the official docs for the latest commit on master, as generated by our continuous deployment workflow.

SciFortran has been tested with success on several Unix/Linux platforms. Support for Windows, through WSL, is still experimental, although few people reported successful installation with minimal efforts.

Some have reported issues concerning the wrong setup for the library pkg-config file, contained in $PREFIX/<PLAT>/<VERSION>/etc/scifor.pc. The variable Libs=-L${libdir} -lscifor <blas/lapack/scalapack> produced by cmake during the configuration and installation process can be not properly defined for the part corresponding to third parties libraries such as Blas/Lapack/Scalapack. This breaks compilation against scifor whenever pkg-config is used to generate the linking options.

FIX: edit the scifor.pc file manually, overwriting the definition of the variable Libs, as appropriate for your system.

If you encounter bugs or difficulties, please file an issue. For any other communication, please reach out to:
adriano DOT amaricci @ gmail DOT com

--

LICENSE
Copyright (C) Adriano Amaricci, Lorenzo Crippa, Gabriele Bellomia, Giacomo Mazza, Samuele Giuli, Massimo Capone

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (LGPL) as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU LGPL for more details.

You should have received a copy of the GNU LGPL along with this program. If not, see http://www.gnu.org/licenses/.