This is the JAMS Fortran library.

The JAMS Fortran library is a collection of general Fortran modules offering miscellaneous functions in the categories Computational, Date and Time, Input / Output, Math / Numerics, Screening, Sensitivity Analysis and Optimising / Fitting, and Miscellaneous.

Created November 2011 by Matthias Cuntz and Juliane Mai
while at the Department Computational Hydrosystems, Helmholtz Centre for Environmental Research - UFZ, Permoserstr. 15, 04318 Leipzig, Germany, and continued while M Cuntz is at the Institut National de Recherche pour l’Agriculture, l’Alimentation et l’Environnement (INRAE), Nancy, France, and J Mai is at the Department of Civil and Environmental Engineering of the University of Waterloo, ON, Canada.

It is distributed under the MIT License (see LICENSE file and below).

Copyright (c) 2011-2020 Matthias Cuntz and Juliane Mai

Contact Matthias Cuntz - mc (at) macu (dot) de

Installation

The library is maintained on a git repository at:

https://github.com/mcuntz/jams_fortran/

To use it, checkout the git repository

git clone https://github.com/mcuntz/jams_fortran.git

Copy the mo_*.f90 file of the chosen utility to your Fortran project. grep -i 'use' mo_*.f90 to check for dependencies. All Fortran modules use at least the kind definitions of mo_kind.f90; quite a few use also the general utilities in mo_utils.f90.

Documentation

Documentation of the functions is above each function code or above the module procedure interface at the top of the file. There is a very brief introduction to the modules at the beginning of each file.

Some but not all documentation is in doxygen format and can be formatted with the appropriate tools, e.g. using the JAMS Makefile project.

Each module has a test program in the directory test/test_mo_*/. These test programs try to test all functionalities of the modules and provide hence examples of code usage of (almost) all subroutines.

Dependencies

The library is compatible with the Fortran 2003 standard. It was tested with the GNU gfortran, Intel ifort, NAG nagfor, and PGI pgfortran compilers in various revisions.

Interoperability with C is assured by the use of the intrinsic module iso_c_binding in mo_kind.f90. The use of C functions were tested using the C-header file cfortran.h, for example with the qhull library. See the use of cfortran.h in qhull/qhull_c.c and the corresponding Fortran call in mo_qhull.f90.

The library uses C preprocessor flags to deal with special compiler behaviours, i.e. one has to compile with the -cpp or -fpp compiler flag. For example, gfortran (revisions < 5) did not include an intrinsic ieee_arithmetic module so that mo_utils has convenience funtions such as is_nan(x), which uses either the gfortran extension isnan(x) or the Fortran standard ieee_is_nan(x). The decision is made during compile time, checking if the variable __GFORTRAN__ is defined. The following preprocessor variables are currently checked:
__ABSOFT__, __GFORTRAN__, __GFORTRAN41__, __NETCDF3__, __pgiFortran__, __NAG__, __NAGf90Fortran__.

Some modules use third-party packages such as LAPack or netCDF.
The libraries MinPack, QHull, and netCDF3 are given for convenience with the JAMS library. It is always recommended to use specific installations for the computer system, for example for blas and lapack, which are highly optimised. The netcdf3 directory includes only the parts of the netCDF 3.6.3 version that are necessary for Fortran projects. Read the README in the netcdf3 directory for two system-specific configuration files. The JAMS Makefile project handles these kind of special configuration files.

The only other third-party softwares are LAPack and netCDF 4, which have to be installed independently. The latter can be installed by using, for example the installation script install_netcdf of https://github.com/mcuntz/install_netcdf.

Content

Modules are provided in the following categories:

• Computational
• Date and Time
• Input / Output
• Math / Numerics
• Screening, Sensitivity Analysis and Optimising / Fitting
• Miscellaneous

Modules ordered alphabetically

Modules per category

Computational

Date and Time

Input / Output

Math / Numerics

Screening, Sensitivity Analysis and Optimising / Fitting

Miscellaneous

License

This file is part of the JAMS Fortran library, distributed under the MIT License.

Copyright (c) 2011-2020 Matthias Cuntz, Juliane Mai, Stephan Thober - mc (at) macu (dot) de

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Note on Numerical Recipes License

Be aware that some code is under the Numerical Recipes License 3rd edition http://www.nr.com/aboutNR3license.html. You can identity it by the use of mo_nr or mo_nrutil.

The Numerical Recipes Personal Single-User License lets you personally use Numerical Recipes code ("the code") on any number of computers, but only one computer at a time. You are not permitted to allow anyone else to access or use the code. You may, under this license, transfer precompiled, executable applications incorporating the code to other, unlicensed, persons, providing that (i) the application is noncommercial (i.e., does not involve the selling or licensing of the application for a fee), and (ii) the application was first developed, compiled, and successfully run by you, and (iii) the code is bound into the application in such a manner that it cannot be accessed as individual routines and cannot practicably be unbound and used in other programs. That is, under this license, your application user must not be able to use Numerical Recipes code as part of a program library or "mix and match" workbench.

Businesses and organizations that purchase the disk or code download, and that thus acquire one or more Numerical Recipes Personal Single-User Licenses, may permanently assign those licenses, in the number acquired, to individual employees. Such an assignment must be made before the code is first used and, once made, it is irrevocable and can not be transferred.

If you do not hold a Numerical Recipes License, this code is only for informational and educational purposes but cannot be used.