pybmc: A General Bayesian Model Combination Package

pybmc is a Python package for performing Bayesian Model Combination (BMC) on various predictive models. It provides tools for data handling, orthogonalization, Gibbs sampling, and prediction with uncertainty quantification. The model combination methodology follows this paper by Giuliani et al.

Features

• Data Management: Load and preprocess nuclear mass data from HDF5 and CSV files
• Orthogonalization: Transform model predictions using Singular Value Decomposition (SVD)
• Bayesian Inference: Perform Gibbs sampling for model combination
• Uncertainty Quantification: Generate predictions with credible intervals
• Model Evaluation: Calculate coverage statistics for model validation

Installation

pip install pybmc

Quick Start

For a detailed walkthrough of how to use the package, please see the Usage Guide.

Development and Testing

This project uses Poetry for dependency management and packaging. Poetry is not required for regular users who install via pip install pybmc, but is needed for development and testing.

Running Tests

If you want to run the test suite:

Option 1: Using Poetry (recommended for development)

# Install Poetry if you don't have it
pip install poetry

# Install the package with dev dependencies
poetry install

# Run tests
poetry run pytest

# Run tests with coverage
poetry run pytest --cov=pybmc

Option 2: Using pytest directly

# Install pytest and other test dependencies
pip install pytest pytest-cov

# Run tests
pytest

# Run tests with coverage
pytest --cov=pybmc

For more information on contributing and development workflows, see our Contribution Guidelines.

Documentation

Comprehensive documentation is available at https://ascsn.github.io/pybmc/, including:

• Usage Guide
• API Reference
• Theory Background
• Contribution Guidelines

Contributing

We welcome contributions! Please see our Contribution Guidelines for details on how to contribute to the project.

License

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

Citation

If you use pybmc in your research, please cite:

@software{pybmc,
  title = {pybmc: Bayesian Model Combination},
  author = {Kyle Godbey and Troy Dasher and Pablo Giuliani and An Le},
  year = {2025},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/ascsn/pybmc}}
}

Support

For questions or support, please open an issue on our GitHub repository.