Developer Guide#

Welcome to the MolSysMT Developer Guide. This portal provides comprehensive architectural documentation, setup guides, testing standards, and best practices for contributors.


Sections#

Getting Started

Essential setup instructions, Git workflow, devcontainers, environment bootstrap, and issue reporting.

Getting Started
Core Architecture

Core design principles, lazy loading via DepDigest, boundary ArgDigest, unit safety, and form adapters.

Core Architecture
Performance and Scalability

Out-of-core trajectory streaming, chunked processing, memory efficiency, and benchmarking suites.

Performance and Scalability
Diagnostics and Telemetry

Centralized error handling, SMonitor diagnostic integration, warning catalogs, and structured logging.

Diagnostics and Telemetry
Testing and Quality Assurance

Unit testing workflows with Pytest, local and CI coverage measurement, and validation matrices.

Testing and Quality Assurance
Documentation Standards

NumPy docstring guidelines, editorial templates, executable doctests, and MyST web cross-linking.

Documentation Standards