Getting Started on IOPS

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites
Quick Installation (from PyPI)
Installation from Source
Offline Installation (Wheelhouse)
Installation with Spack (for HPC environments)
Optional Dependencies
Verifying Your Installation

Prerequisites

Before installing IOPS, ensure you have:

Python 3.10 or later
For benchmark execution: Required tools in PATH (e.g., ior, mpirun for I/O benchmarks)
For SLURM clusters: Access to a SLURM scheduler

Virtual environment (recommended)

Install IOPS into an isolated environment (venv or Conda, both work the same) so its dependencies do not conflict with other Python tools on the machine.

Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

Run your first benchmark with IOPS in a few minutes.

Step 1: Create a Configuration
Step 2: Preview Your Benchmark
Step 3: Run the Benchmark
Step 4: Explore Executions
Step 5: Analyze Results
Understanding the Output

Step 1: Create a Configuration

Generate a YAML configuration template:

iops generate my_config.yaml

# Fully-documented template with all options
iops generate my_config.yaml --full

Step 2: Preview Your Benchmark

# Dry-run to see what will be executed
iops run my_config.yaml --dry-run
iops run my_config.yaml -n

# Check configuration validity
iops check my_config.yaml

The dry-run shows how many test instances will be generated, the parameter combinations, and estimated resource usage (for SLURM).

IOPS Studio

Mon, 01 Jan 0001 00:00:00 +0000

Experimental Feature

IOPS Studio is experimental. It may contain bugs or undergo breaking changes in future releases. Please report any issues you encounter.

IOPS Studio is a local web UI for driving IOPS end to end: connect to a target (your laptop or an HPC cluster over SSH), build a benchmark config from a form, run it, and view the results, all from your browser.

Overview

Studio runs as a small local web server and does its work through one interactive shell per target, the same terminal you see on the right of the screen. Connecting to a cluster is just an ssh session inside that terminal, so everything works exactly as it would by hand, and if a command fails you are already in the right shell to fix it. Because it uses the one already-authenticated channel, Studio also works on locked-down login nodes that only accept an interactive password or 2FA.

Getting Started on IOPS

Installation

Table of Contents

Prerequisites

Virtual environment (recommended)

Quick Start

Table of Contents

Step 1: Create a Configuration

Step 2: Preview Your Benchmark

IOPS Studio

Overview