RP Scripts’ documentation

RP Scripts is an open-source command-line program designed to extract rhythmic partitioning information from given digital music scores files, plot partitiogram and indexogram, and create annotated digital music scores files. RP Scripts is multiplatform. It works on Linux, MacOS, and Windows.

This program reads MusicXML (compressed or not), and Kern files generating rhythmic partitioning data in JSON files and partitioning charts. It uses the Music21 library for score parsing and Matplotlib for chart plotting.

Some published papers describe RP Scripts’ features (See Section Bibliography). The software is available at https://github.com/msampaio/rpScripts.

This program is an HMB Project outcome.

Contents:

• 1. Installation
  • 1.1. Python 3
  • 1.2. Auxiliary package manager
  • 1.3. PIPX
  • 1.4. GIT
  • 1.5. RP Scripts
  • 1.6. Graphviz
  • 1.7. Install checking
• 2. Usage
  • 2.1. Components
  • 2.2. Command Line Interface
  • 2.3. Package usage
• 3. Programs
  • 3.1. Calculator
  • 3.2. Plotter
  • 3.3. Annotator
  • 3.4. Labeler
  • 3.5. Info
  • 3.6. Stats
  • 3.7. Utils
  • 3.8. Converter
  • 3.9. TContour
  • 3.10. TClass
  • 3.11. Trimmer
  • 3.12. Finder
• 4. Modules
  • 4.1. rpscripts package
• 5. Bibliography
  • 5.1. How to cite
• 6. Authors
  • 6.1. Developer
  • 6.2. Contributors
• 7. Changelog
  • 7.1. Release 2.3.2 (released Jan 3, 2025)
  • 7.2. Release 2.3.1 (released Nov 15, 2024)
  • 7.3. Release 2.3 (released Nov 14, 2024)
  • 7.4. Release 2.2 (released Feb 15, 2024)
  • 7.5. Release 2.1 (released Dec 8, 2023)
  • 7.6. Release 2.0.1 (released May 19, 2023)
  • 7.7. Release 2.0 (released May 13, 2023)
  • 7.8. Release 1.1 (released Mar 1, 2023)
  • 7.9. Release 1.0 (released Dec 29, 2022)

Indices and tables

• Index

• Module Index

• Search Page