The ESIO Library

Overview

The ExaScale IO (ESIO) library provides simple, high throughput input and output of structured data sets using parallel HDF5. ESIO is designed to support reading and writing turbulence simulation restart files but it may be useful in other contexts. The library is written in C99 and may be used by C89 or C++ applications. A Fortran API built atop the F2003 standard ISO_C_BINDING is also available.

The project is hosted at https://github.com/RhysU/ESIO.

Features

The ESIO library provides:

• Distributed IO of 1D lines, 2D planes, and 3D fields of data
• Support for scalar-, complex-, and vector-valued data
• Single and double precision floating point storage
• A mechanism for storing both string and numeric metadata
• Support for contiguous and strided in-memory data
• Support to simplify writing restart file sequences
• Storage within the widely-used HDF5 file format

Manual

ESIO's manual consists of the following topics:

• Installation
• Linking applications
• Basic concepts
• Writing restart files
• C/C++ API
• C/C++ error handling API
• Fortran API
• Benchmarking

Reporting Bugs

Report bugs in the code or errors/omissions in the documentation via https://github.com/RhysU/ESIO/issues. All bug reports should include:

• the version number of the ESIO library,
• the version number of the HDF5 library,
• the vendor and version number of the MPI stack,
• the hardware and operating system,
• the local compiler version number,
• a description of the bug behavior, and ideally,
• a short program which reproduces the bug.

Feature requests are welcome. Contributions, especially as pull requests, are doubly welcome.

License

ESIO is free software; you can redistribute it and/or modify it under the terms of the Version 3.0 GNU Lesser General Public License as published by the Free Software Foundation, or (at your option) any later version.

ESIO 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 Lesser General Public License for more details.

Acknowledgments

This material is based in part upon work supported by the Department of Energy National Nuclear Security Administration under Award Number DE-FC52-08NA28615.

More Information about PECOS

The Center for Predictive Engineering and Computational Sciences (PECOS) is one of five US centers sponsored under the Predictive Science Academic Alliance Program (PSAAP) of the National Nuclear Security Administration's Advanced Simulation and Computing Program. The PECOS center is housed within the Institute for Computational Engineering and Sciences (ICES) at the University of Texas at Austin. For additional information or questions regarding the PECOS center, please contact info@pecos.ices.utexas.edu.