Development

This section provides information for developers who want to contribute to OpenHCS.

Development Methodologies

Systematic approaches for OpenHCS development workflows.

• Systematic Refactoring Framework
• Architectural Refactoring Patterns
• OpenHCS Refactoring Principles: Mathematical Simplification Approach
• Respecting Codebase Architecture
• Python Object Reference Documentation Methodology
• Compositional Git Commit Message Generation

Development Guides

Practical guides for specific development tasks.

• UI Patterns
• Pipeline Compilation Debugging Guide
• Placeholder Inheritance Debugging Guide
• Parameter Analysis Architecture Audit
• Unified Parameter Analyzer Migration Guide
• Placeholder Refresh Threading
• Scope Hierarchy for Live Context
• Lazy Dataclass Utilities
• Pyclesperanto Simple Implementation
• Window Manager Usage Guide
• Compact Window Patterns

Testing and CI

Continuous integration and testing strategies.

• Git Worktree Testing
• OMERO Integration Testing

CPU-Only Testing: OpenHCS supports CPU-only mode for CI environments without GPU dependencies. See CPU-Only Mode for configuration details.

CI Configuration Example:

# .github/workflows/tests.yml
name: Tests
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python
        uses: actions/setup-python@v3
        with:
          python-version: '3.9'
      - name: Install dependencies
        run: |
          pip install -e .
          pip install pytest
      - name: Run tests in CPU-only mode
        env:
          OPENHCS_CPU_ONLY: 1
        run: pytest tests/

Key Benefits: - No GPU dependencies required for CI - Faster test execution in cloud environments - Consistent test results across different hardware - Full pipeline logic validation without GPU acceleration