Skip to content

Welcome to Pattern Analyzer

This site provides comprehensive documentation for the Pattern Analyzer framework, covering user guides, API references, and plugin development.

Pattern Analyzer is a powerful, plugin-based framework designed for the analysis of binary data. Whether you're a security researcher, a data scientist, or a developer, Pattern Analyzer provides the tools to dissect binary files, detect patterns, and assess randomness through a suite of statistical and analytical tools.

Quick Navigation

  • Getting Started: A quick-start guide to install Pattern Analyzer and run your first analysis.
  • User Guide: Detailed instructions on using the CLI, Web UI, and configuration files.
  • Plugin Developer Guide: Learn how to create your own tests, transforms, and visualizers.
  • API Reference: A reference for using Pattern Analyzer programmatically in your own Python scripts.
  • Test Reference: A detailed catalog of all built-in analysis plugins.
  • Configuration Examples: See examples of YAML and JSON configuration files.

Running the Documentation Locally

To browse this documentation site on your local machine, ensure you have MkDocs and the Material theme installed.

# Install required packages (preferably in a virtual environment)
pip install mkdocs mkdocs-material

# Serve the documentation site
mkdocs serve

This will start a local web server, and you can view the site by navigating to http://127.0.0.1:8000 in your browser.