Matrix Butler (wsp-matrix-butler)

A SQLite-based mini-file system for organizing matrix files for MTO's Greater Golden Horseshoe Model

Installation

Matrix Butler can be installed with conda by running:

conda install -c wsp_sap wsp-matrix-butler

Usage

Important

As of v2.0, this package is imported using wsp_matrix_butler instead of matrix_butler

from wsp_matrix_butler import MatrixButler

# Connect to an existing GGHM cache folder
butler = MatrixButler.connect("path/to/cache")

# List the contents (matrices) available in the MatrixButler instance
butler.list_matrices()

Development

Development of the MatrixButler uses pixi for Python package management and rattler-build for package building.