F90GIO

F90GIO Release v2.2

Online community:

Author: Da,Cheng Email: [email protected]

Fortran 90 General I/O Interface (F90GIO) provides I/O interface for NetCDF, HDF4, HDF5 reading/writing with Fortran 90 languages. It is developed in the hope of allieviating researchers’ burden in atmospheric and oceanic science to deal with either re-analysis, forecast, or remote sensed data. Instead of wasting time learning these techniques, researchers may prefer to focus on the scientific problems. With this thought in mind, I decide to deliever this package to the public. Most of the routines have been tested both on Mac Pro and Linux clusters.

This README file contains information about: I. what compiler flags should be included when compiling NetCDF, HDF4, HDF5 libraries; II. how to compile F90IO library, III. how to use F90IO library.

If you find this package helpful, and you are using it in your papers, please acknowledge it in your acknowledgement section in your papers if possible. Thanks!

Quick start: Install F90GIO library

1. If there a predefined env is found under config, then simply run

   ./install.bsh config/<predefined_env_file_name>
   

   For example, ./install.bsh config/env.gnu.derecho.sh

Step-by-step installation

1. Running the command

   source config/env.[compiler].[machine].sh
   

   to set the environmental variables required by F90GIO, essentially variables for netcdf, hdf4, and hdf5 (only set the vars for the library that you will use). There are several templates under the dir config to create your own config/env.sh.

2. Go to the top directory of this repo, run the following commands

   mkdir build && cd build
   cmake .. -DCMAKE_INSTALL_PREFIX=<your_installation_path> 
   make -j1 
   #make -j1 VERBOSE=1, if you want to see the detailed building info
   make test
   make install
   

3. The libs and includes will be generated under <your_installation_path>/lib and <your_installation_path>/include, which you can use for building your own excutables with F90GIO.

4. See the usage of F90GIO by checking examples under test-fast, test, and test-nolib.

Build your own executables with F90GIO

1. check the step build your own executable using the F90GIO lib in the file .github/workflows/build_gfortran.yml.

Customized installation

1. To turn off specific lib, you can modify Makefile at the current directory as:

   • turn off hdf4

     mkdir build
     . config/env.sh; cd build; cmake -DBUILD_H4=off ..; make; make test
     

   • turn off netcdf

     mkdir build
     . config/env.sh; cd build; cmake -DBUILD_NC=off ..; make; make test
     

   • turn off hdf5 by

     mkdir build
     . config/env.sh; cd build; cmake -DBUILD_H5=off ..; make; make test
     

2. for hdf5 libs, if you are using hdf5 libs with major version <= 1.8 add the H5_VERSION_1_8=ON when running cmake

   mkdir build
   . config/env.sh; cd build; cmake -DBUILD_H5=on -DH5_VERSION_1_8=ON ..; make; make test
   

3. install Fast I/O libs (currently support NC and HDF5)

   mkdir build
   . config/env.sh; cd build
   cmake .. -DBUILD_NC=ON -DBUILD_H5=on -DH5_VERSION_1_8=ON -DBUILD_FAST_IO=ON
   make; make test
   

4. Most common combination for Mac ARM using Homebrew (enable hdf5 (version>1.8) & nc, disable hdf4)

   . ../config/env.gnu.mac-arm.sh  &&  cmake .. -DBUILD_NC=ON -DBUILD_H4=OFF -DBUILD_H5=ON -DH5_VERSION_1_8=OFF -DBUILD_FAST_IO=ON && make && make test
   

Install NetCDF/HDF4/HDF5 library

1. For installing HDF4, if you’d like to use my netcdf & hdf4 module simultenously, you need to disable the netcdf-I/O capability:

       --disable-netcdf
   

   when runnning configure. Other important flags for F90GIO includes:

       --enable-fortran F77=YOUR_COMPILER (e.g., F77=ifort)
   

   The general flags when you configure HDF4 library can be found in the file named INSTALL in the directory ~/release_notes of the official source code pakage or see this file online (https://www.hdfgroup.org/ftp/HDF/HDF_Current/src/unpacked/release_notes/INSTALL).

2. For HDF5 compilation, you need to add flag:

       --enable-fortran --enable-fotran2003
   

   other general flags when configuring the HDF5 can be found in the directory of ~/release_docs of the official source code package or see this file online (http://www.hdfgroup.org/ftp/HDF5/current/src/unpacked/release_docs/INSTALL)