Skip to content

Documenting the SMC(K) model closes #2382#2444

Merged
jeromekelleher merged 1 commit intotskit-dev:mainfrom
hossam26644:docs/smck-2382
Dec 12, 2025
Merged

Documenting the SMC(K) model closes #2382#2444
jeromekelleher merged 1 commit intotskit-dev:mainfrom
hossam26644:docs/smck-2382

Conversation

@hossam26644
Copy link
Contributor

@hossam26644 hossam26644 commented Dec 11, 2025

Documenting the smc(k) model.

  • Added the smc(k) class description and referred to it in the docs
  • Removed and/or replaced mentions of the old smc and smc' models from docs
  • Added lines in the old smc and smc' class description referring to them as legacy, and recommended using the smc(k) model
  • Added an example of using the smc(k) model to simulate under the smc' approximations
  • Added text in ancestry.md mentioning the possibility of using this model to simulate Drosophila, and recommended using the Hudson model whenever possible.

closes #2382

change smc examples in ancestry.md

update SMC text in ancestry.md

Drosophila in bold
@codecov
Copy link

codecov bot commented Dec 11, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.22%. Comparing base (819490c) to head (61b1bfd).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2444   +/-   ##
=======================================
  Coverage   91.22%   91.22%           
=======================================
  Files          20       20           
  Lines       11847    11847           
  Branches     2300     2300           
=======================================
  Hits        10807    10807           
  Misses        569      569           
  Partials      471      471           
Flag Coverage Δ
C 91.22% <ø> (ø)
python 98.63% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@jeromekelleher jeromekelleher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice 👍

@jeromekelleher jeromekelleher added this pull request to the merge queue Dec 12, 2025
Merged via the queue into tskit-dev:main with commit 1526582 Dec 12, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document smc(k)

2 participants