Skip to content

Initial docs for IOR #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pearce8 merged 1 commit into from
May 4, 2026
Merged

Initial docs for IOR #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 47 additions & 13 deletions docs/80_ior/ior.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,73 @@
IOR
***

https://github.com/hpc/ior


Purpose
=======

IOR is used for testing performance of parallel file systems using various interfaces and access patterns at the POSIX and MPI-IO level.

Characteristics
===============

Problems
--------
IOR is available in the benchmarks repository.

* Github: `IOR Public <https://github.com/hpc/ior>`_

Figure of Merit
---------------
The github repo also contains mdtest.

Problem
-------

IOR measures parallel I/O performance at the POSIX and MPI-IO levels.
It writes and reads files, one per rank or shared between all ranks, on a parallel file system.
It should be run in lustre space.

Source code modifications
=========================

Please see :ref:`GlobalRunRules` for general guidance on allowed modifications.


Building
========

MPI, MPI-IO, and OpenMP are required in order to build and run the code. The
source code used for this benchmark is derived from IOR 3.0.1 and it is
included here.

Ensure that the MPI compiler wrappers (e.g., `mpicc`) are in `$PATH`. Then create a build directory and an (optional) install directory.

.. code-block:: bash

<BENCHMARK_PATH>/microbenchmarks/ior/configure --prefix=<INSTALL_DIR>
make
#make install
..

This will build both IOR with the POSIX and MPI-IO interfaces and create the
IOR executable at `src/ior`.

Running
=======

The ior tests can be run using the following command:

.. code-block:: bash

srun ...

..

Where `load_type` is `load1` for sequential loads and `load2` for random loads, `io_type` is `posix` or `mpiio`, and `access_type` is `filepertask` and `sharedfile` for per task and shared accesses respectively.
There are six input decks in the `inputs.xroads` directory; each should be run on a single node and across the full system in parallel.

"*Note: Benchmark values for random loads are not presented here.*"

Input
-----

Running IOR does not require using the input files. All arguments can be given on the command line.


Validation
==========
Expand All @@ -44,12 +82,8 @@ Memory Usage
============


Strong Scaling on El Capitan
============================


Weak Scaling on El Capitan
==========================
Scaling on El Capitan
=====================


References
Expand Down
Loading