Skip to main content

Version History

This page documents all notable changes to HeartMAP, including new features, bug fixes, and breaking changes.
HeartMAP follows Semantic Versioning: MAJOR.MINOR.PATCH
  • MAJOR: Incompatible API changes
  • MINOR: New functionality (backwards-compatible)
  • PATCH: Bug fixes (backwards-compatible)

[2.0.2] - 2025-11-08

Changes

  • Merged updates from master branch
  • Synchronized repository state
  • Minor documentation updates

Technical Details

  • Branch: Merged master branch updates
  • Type: Maintenance release

[2.0.1] - 2025-11-08

Fixed

  • Pipeline fixes: Resolved issues in analysis pipelines
  • Improved pipeline stability and error handling
  • Enhanced pipeline execution flow

Changes

  • Internal pipeline improvements
  • Code quality enhancements
  • Better error messages for pipeline failures

[2.0.0] - 2025 (Initial Publication Release)

This is the initial production release of HeartMAP, published alongside the paper in Computational and Structural Biotechnology Journal.

Major Features

Core Functionality

  • Multi-chamber analysis: Complete support for all four cardiac chambers (RA, RV, LA, LV)
  • Cell-cell communication: Integrated LIANA for ligand-receptor interaction analysis
  • Multiple interfaces: CLI, Python API, REST API, and Gradio web interface
  • Production-ready: Fully tested and deployed on PyPI

Analysis Pipelines

  • Quality control and filtering
  • Data normalization and scaling
  • Cell type annotation
  • Clustering (Leiden/Louvain)
  • Basic visualizations (UMAP, t-SNE)
  • Ligand-receptor interaction analysis
  • Communication hub identification
  • Pathway enrichment analysis
  • Network topology analysis
  • Communication network visualization
  • Chamber-specific marker identification
  • Cross-chamber correlation analysis
  • Comparative chamber analysis
  • Chamber distribution analysis
  • Chamber-specific visualizations
  • Integrated analysis of all components
  • Advanced multi-panel visualizations
  • Automated comprehensive reports
  • Model persistence and reuse

Configuration System

  • YAML-based configuration files
  • Memory optimization settings
  • Customizable analysis parameters
  • Environment-aware defaults

Data Management

  • AnnData (.h5ad) format support
  • SHA-256 checksums for data integrity
  • Fixed random seeds for reproducibility
  • Configurable data subsetting

Deployment Options

  • PyPI package: pip install heartmap
  • Docker containers: Single and multi-service
  • Cloud platforms: AWS, GCP, Azure support
  • Hugging Face Spaces: Public web interface

Scientific Validation

Validated Dataset

  • Total cells: 287,269 from human hearts
  • Donors: 7 healthy individuals
  • Source: Single Cell Portal SCP498
  • Chambers: Complete coverage of RA, RV, LA, LV

Key Findings

  • Identified chamber-specific cell populations
  • Discovered chamber-specific communication networks
  • Found therapeutic targets for chamber-specific interventions
  • Established cross-chamber correlation patterns

Performance

ConfigurationDataset SizeMemoryRuntimeStatus
Minimal10K cells8GB5-10 min✓ Tested
Recommended30K cells16GB15-20 min✓ Tested
Optimal50K cells32GB25-30 min✓ Tested
Production100K+ cells64GB+45-60 min✓ Tested

Documentation

  • Complete user guide
  • API documentation
  • Tutorial notebooks
  • Example scripts
  • Deployment guides

Testing

  • Comprehensive test suite
  • Validation scripts
  • Mock data generation
  • Performance benchmarks

Pre-release Development

Beta Phase (2024-2025)

  • Internal testing and validation
  • Method development and optimization
  • Scientific validation on SCP498 dataset
  • Performance optimization
  • Documentation development

Alpha Phase (2023-2024)

  • Initial implementation
  • Core algorithm development
  • Pipeline architecture design
  • Proof of concept validation

Future Roadmap

Planned Features

v2.1.0

Next Minor Release
  • Enhanced visualization options
  • Additional cell type markers
  • Performance improvements
  • Extended species support

v2.2.0

Future Enhancements
  • Spatial transcriptomics integration
  • Trajectory analysis
  • Batch effect correction
  • Interactive visualizations

v3.0.0

Major Update (Future)
  • Multi-modal data integration
  • Deep learning models
  • Real-time analysis
  • Cloud-native architecture

Community

Ongoing
  • Community contributions
  • Bug fixes
  • Documentation improvements
  • Tutorial expansion

Research Integration

  • Integration with emerging single-cell technologies
  • Support for new interaction databases
  • Advanced statistical methods
  • Machine learning enhancements

Release Notes Format

Each release includes:
  • Added: New features and capabilities
  • Changed: Changes to existing functionality
  • Deprecated: Features to be removed in future versions
  • Removed: Removed features
  • Fixed: Bug fixes
  • Security: Security patches and improvements

Getting Updates

Check Current Version

pip show heartmap

Update to Latest Version

# Update from PyPI
pip install --upgrade heartmap

# Or with all features
pip install --upgrade heartmap[all]

Check for Updates

import heartmap
print(f"Current version: {heartmap.__version__}")

Development Version

# Install latest from GitHub
pip install git+https://github.com/Tumo505/HeartMap.git

Version Support

Support Policy
  • Latest version receives active support and updates
  • Previous minor versions receive security fixes for 6 months
  • Major versions receive security fixes for 1 year after next major release

Contributing to Releases

Help shape future releases:
  1. Report bugs: Open issues on GitHub
  2. Request features: Start a discussion
  3. Submit patches: Create pull requests
  4. Test pre-releases: Try beta versions and provide feedback
See the Contributing guide for details.

Release Notifications

Stay informed about new releases:
  • GitHub Releases: Watch the repository for notifications
  • GitHub Discussions: Announcements posted in discussions
  • PyPI: Check the HeartMAP PyPI page
Star the GitHub repository to receive notifications about new releases!

Build docs developers (and LLMs) love