PyNVMe3 Documents
Last Modified: September 5, 2025
Copyright © 2020-2025 GENG YUN Technology Pte. Ltd.
All Rights Reserved.
Foreword
Storage stands alongside compute and networking as a core platform pillar. NVMe SSDs now dominate this layer, yet quality, reliability, and feature maturity still vary widely across vendors and product lines. Unlike networks that can retry or CPUs that can be swapped, data loss is rarely recoverable—making rigorous SSD validation mission‑critical.
Traditional tools such as fio, nvme‑cli, or dnvme cover basic needs but hit clear limits. They struggle to reach cutting‑edge NVMe/PCIe speeds, fail to expose timing‑sensitive defects, and offer limited scripting for emerging features. When tools cap performance, tests cap stress—and critical flaws remain hidden.
PyNVMe3 changes the equation. It is a vendor‑neutral NVMe SSD validation platform built on Python with a proven user‑space NVMe engine. On standard hardware it delivers multi‑million IOPS, sub‑microsecond timing, and deterministic latency control. It pushes SSDs to their limits to surface issues legacy tools miss, while giving teams the flexibility of readable Python test scripts that integrate seamlessly with CI pipelines for exact reproducibility.
Hardened by more than five years of production use worldwide, PyNVMe3 offers a comprehensive test suite, structured logs that accelerate root‑cause analysis, and quarterly updates that track the latest NVMe/PCIe and out‑of‑band management features. This guide will help you install and configure PyNVMe3, extend it with your own workloads, compare I/O models, and apply best practices for debugging, automation, and large‑scale validation. With PyNVMe3, your SSD validation keeps pace with the industry’s fastest storage.
Table of Contents
| Section | Description |
|---|---|
| Developer’s Guide | Developer guide that explains installation, configuration, and how to write and extend test scripts (especially for Enterprise NVMe SSD testing). |
| PyNVMe3 Design | System design philosophy with explanations of architecture and core modules. |
| IO Models | Overview of supported I/O models, e.g. ioworker and metamode. |
| PyNVMe3 API | Python API reference with usage examples. |
| Test Platforms | Positioning and usage scope of the three test platforms (Laptop, Desktop, Server). |
| Features | Key features list. |
| User’s Guide | User manual covering common tasks and best practices (especially for Client NVMe SSD testing). |
| EULA | End User License Agreement. |
