MatchY is a powerful pedigree-based tool designed to estimate match probabilities for Y-STR haplotypes. Its mathematical framework leverages marker mutation rates, pedigree structure, and the known haplotypes of individuals within the family tree. By combining this data, the tool accurately estimates match probabilities with a person of interest using a Monte Carlo simulation with importance sampling to model mutations.
MatchY supports any number of Y-STR markers, including multi-copy markers and intermediate alleles.
The preferred way to run MatchY is using the provided Docker image. This ensures that all dependencies are correctly installed and configured.
- Install Docker (Desktop) from https://www.docker.com/get-started
- Pull the Docker image:
docker pull dionzand/matchy:latest - Run the Docker container:
docker run -p 8501:8501 dionzand/matchy:latest - Access the Streamlit dashboard at
http://localhost:8501
If you prefer to run MatchY locally, follow these steps:
- Install python
- Clone the repository:
git clone https://github.com/genid/MatchY.git - Install dependencies:
pip install -r requirements.txt - Run the application
- CLI interface:
python main.py - Streamlit Dashboard:
streamlit run streamlit_app.py
- CLI interface: