Skip to main content

User Guide

Welcome to the PIQUE Lite User Guide!

This section walks you through how to use PIQUE Lite, from uploading input files to understanding software quality metrics.

What are Projects and Versions?​

In PIQUE Lite, a project represents a software system or repository being analyzed. Each project consists of multiple versions, which are snapshots of the software at different points in time. This allows you to track changes in quality, compare versions, and observe trends over time.

What's in this guide?​

  • File Upload: Instructions for uploading files
  • Input Schema: Learn about the required JSON format and how to prepare your data for analysis
  • Handling Input Errors: Common issues with input files and how to fix them
  • Core Features: Key features like quality change over time, project comparison, and dive into investigating a specific version of a selected project.
  • Advanced Features: Customizing analysis with hierarchical views, adjusting category weights, and fine-tuning metrics for a specific version of the selected project.

Each section provides step-by-step instructions to help you get the most out of PIQUE Lite. If you're new, start with Input Schema to ensure your files are set up correctly.