Contributor Guide

This section is for developers and scientific contributors who want to extend PolyzyMD, understand the codebase, or add new capabilities.

Start Here

• Set Up a Contributor Environment

• Contributing to PolyzyMD

• Packaging and Distribution Notes

• Architecture

New Analysis Contributor Path

Use the New Analysis Contributor Path if you want to add a new analysis plugin or modify an existing one. It gives new analysis contributors a recommended reading order, points to the current full extension guide, and highlights the public APIs to use before you start editing plugin code.

Start there when you need to understand how a PolyzyMD analysis moves from MDAnalysis trajectory work to replicate artifacts, condition aggregation, comparison, and artifact-only plotting.

Extension Workflows

• Extend the Analysis Framework — how to add an MDAnalysis-native analysis plugin with MDAAnalysisJob, ReplicateArtifact, default artifact aggregation, comparison, formatting, and artifact-only plotting

• Store large analysis outputs with artifact sidecars — how to persist arrays, tables, and plotting inputs through registered ArtifactStore sidecars instead of plugin-specific cache files

Contributor Mindset

Use this section when you need to understand internal design, extension points, or project maintenance patterns. For command lookup, switch to Reference.