metapulsar 0.9.3

Multi-PTA pulsar timing data combination framework for gravitational wave detection

MetaPulsar

A framework for combining pulsar timing data from multiple PTA collaborations into unified "metapulsar" objects for gravitational wave detection analysis.

Features

• Multi-PTA Data Combination: Combine data from EPTA, PPTA, NANOGrav, MPTA, and other PTAs
• Enterprise Integration: Full compatibility with the Enterprise pulsar timing analysis package
• Dual Timing Package Support: Works with both PINT and libstempo/tempo2
• Flexible Parameter Management: Support for "consistent" and "composite" combination strategies

Quick Start

Installation

git clone https://github.com/vhaasteren/metapulsar.git
cd metapulsar
pip install -e .

# With optional dependencies
pip install -e ".[dev,libstempo]"

Basic Usage

from metapulsar import create_metapulsar

# Create MetaPulsar
metapulsar = create_metapulsar(
    file_data=pulsar_data,
    combination_strategy="consistent",
    combine_components=["astrometry", "spindown", "binary", "dispersion"],
    add_dm_derivatives=True,
)

# Access combined data
print(f"Number of TOAs: {len(metapulsar.toas)}")
print(f"PTA names: {list(metapulsar._pulsars.keys())}")

Documentation

• Interactive Tutorial - Complete usage guide with examples
• API Reference - Complete API documentation
• Method Description - Detailed description of the direct combination method

Examples

• Python Examples - Standalone Python examples

Testing

# Run all tests
pytest

# Run with coverage
pytest --cov=src/metapulsar

Troubleshooting

Debug Mode

import loguru
import sys
loguru.logger.remove()
loguru.logger.add(sys.stdout, level="DEBUG")

Dependencies

• Python 3.9+
• numpy ≥ 1.20.0
• astropy ≥ 5.0.0
• scipy ≥ 1.7.0
• pint-pulsar ≥ 0.9.0
• enterprise-pulsar ≥ 3.0.0

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Citation

If you use this software in your research, please cite:

@software{metapulsar,
  title={MetaPulsar},
  author={van Haasteren, Rutger and Yu, Wang-Wei and Wright, David},
  year={2025},
  doi={10.5281/zenodo.17626664},
  url={https://github.com/vhaasteren/metapulsar},
  license={MIT}
}

Authors

• Rutger van Haasteren - Lead Developer - [e-mail]
• Wang-Wei Yu - Co-Developer - [e-mail]
• David Wright - Co-Developer - [e-mail]

Support

• Issues: GitHub Issues
• Email: [e-mail]