patkit

PATKIT Documentation

Until the 1.0 release none of the documentation is final nor necessarily correct. Corrections and but reports are always welcome.

Installation and basic use

• Installing
• Running

GUI user guide

[Being slowly written, please contribute if you want to hasten this up.]

Currently we only have:

• Automated exercises
• Keyboard shortcuts

Commandline user guide

[To be written] but already available in a rudimentary form by running patkit --help which also works on the subcommands (open, ).

PATKIT Runtime data structures

PATKIT’s class structure aims for efficiency without sacrificing clarity. Clarity of code brings easy maintainability and that is more important in the long run than gains in execution speed.

• Introduction to PATKIT Data Structures
  • Core Data Structures
  • Modalities for Recorded Data
  • Modalities for Derived Data
  • Modalities in Practice including notes on specific Modalities
    • Splines in PATKIT
  • Database Classes
• Extending PATKIT
  • Before starting, please read Coding conventions in PATKIT development guide.
  • Implementing a New Datasource
  • Writing a New Modality

PATKIT API

API Documentation

PATKIT Files

• Data files
  • Guidelines for Data Directory Structure
  • Importing and Exporting
  • Saving and Loading
• Configuration files
  • Command history
  • Global configuration
    • General parameters
    • GUI parameters
    • Data processing parameters
  • Local configuration

Just for reference

• Screenshots of the GUI in different versions

This site is open source. Improve this page.