playNano Documentation

Welcome to playNano - a Python toolkit for loading, processing, analysing and exporting high-speed AFM (HS-AFM) time-series data (.h5-jpk, .jpk, .spm, .asd). This documentation covers installation, command-line usage, the PySide6 GUI, processing filters, analysis pipelines, and the API reference.

Quick links

• Installation - how to install playNano (pip / conda)

• Quickstart - 1-minute example: open a file, apply a filter, export GIF

• Command Line Interface (CLI) - full command-line reference and examples

• GUI: Interactive Playback - GUI walkthrough, keyboard shortcuts and export workflow

• Processing - filters, masks and pipeline behaviour

• Analysis - running analysis modules and provenance

  • Custom Analysis Modules - creating and registering custom analysis modules

• What’s New in playNano 0.1.0 - highlights of the latest release

• Changelog - release notes and history

Quickstart (example)

# show a file in the interactive GUI
playnano play ./test/resources/sample_0.h5-jpk

Note

See Quickstart for step-by-step instructions.

Contents

User Guide

User Guide

• Installation
  • System requirements
  • Installation Guide
  • Notes & troubleshooting
  • Developer / contributor install
• Quickstart
  • 1. Create a conda environment (recommended)
  • 2. Install playNano (editable)
  • 3. Quick verification
  • 4. Most common actions (one-liners)
  • 5. Where to go next
• Command Line Interface (CLI)
  • General usage
  • Batch mode operations
  • Wizard mode (interactive)
  • Play (GUI) mode
  • Help & usage
  • Tips & troubleshooting
  • Links
• GUI: Interactive Playback
  • Overview
  • Command-line access
  • Main window
  • Export behaviour & filenames
  • Troubleshooting & tips
  • Notes & links
• Processing
  • Quick start
  • Concepts & behaviour
  • Built-in filters and masks
  • Plugins
  • CLI / GUI Usage
  • Programmatic usage
  • Advanced / Implementation details
  • Tips & troubleshooting
  • See also
• Analysis
  • Quick start
  • Overview & behaviour
  • CLI usage
  • Programmatic usage
  • Outputs & exports
  • Inspecting results
  • Advanced / Implementation details
  • Troubleshooting & tips
  • Extending with Custom Modules
  • See also
• Custom Analysis Modules
  • Stucture and Requirements
  • Registering the Module
  • Best Practices
  • Usage in a Pipeline
  • Debugging & Troubleshooting
• Notebooks
  • Overview
  • Running Notebooks
• Changelog
  • Changelog

API Reference

API Reference

• playNano
  • playNano package

What’s New

What's New

• What’s New

Information and Support

• Changelog

• GitHub: https://github.com/derollins/playNano

• Issues: https://github.com/derollins/playNano/issues

• Email: d.e.rollins@leeds.ac.uk