Getting Started

warpt is EarthFrame's open-source command line package for system discovery, stress testing, and power monitoring. warpt gives users extensive insights into their system's configuration in a structured manner. warpt's structured reports can then be used to debug, benchmark, and optimize workloads.

Note: This is an alpha release (v0.1.0). Some features are still in development. Please review the Support Matrix for system requirements and known limitations before getting started.

Prerequisites

Before installing warpt, ensure your system meets the following requirements:

• Python 3.10 or higher (3.11+ recommended)
• Operating System: Linux, macOS, or Windows
  • Linux: Full feature support
  • macOS: Full support (power monitoring requires sudo)
  • Windows: Limited support (see Known Limitations)
• For GPU features: NVIDIA GPU with drivers installed
• For stress tests: Additional dependencies installed via warpt[stress]

See the Support Matrix for detailed hardware and platform compatibility.

Installation

pip install warpt

For stress testing capabilities (requires NumPy and PyTorch):

pip install warpt[stress]

Note: Stress tests will not work without their additional dependencies.

Verify Installation

warpt version

Discover Your Hardware

Run warpt list to see what hardware and software warpt detects on your system:

warpt list

This displays:

• CPU information (model, cores, frequencies)
• GPU information (if NVIDIA GPU available)
• Memory (total, free, type)
• Storage devices
• Installed ML frameworks (PyTorch, TensorFlow, JAX, etc.)
• Core libraries (MKL, OpenBLAS, CUDA, cuDNN, etc.)

Export to JSON:

warpt list --export

Run Your First Stress Test

List available stress tests:

Note: Stress tests require additional dependencies, which may be installed with pip install warpt[stress].

warpt stress --list

Run all CPU stress tests for 30 seconds each:

warpt stress -c cpu -d 30

Run all available tests:

warpt stress -c all

Save results to a file:

warpt stress -c cpu -o results.json

Monitor Your System

Watch real-time system metrics:

Note: on Mac OS X, power monitoring may require sudo.

warpt monitor

Next Steps

• See the CLI Reference for all commands and options
• See the Support Matrix for hardware/platform compatibility
• Run warpt <command> --help for detailed help on any command

Available Commands