Problems with IM Model

Open
#533 11 comments 0 reactions 1 assignee View on GitHub

@mufernando is already working on this.

Since Aug 13, 2024.

Assessment

This issue has not been assessed yet.

Description

The IM model has a few issues:

  1. Currently the parameters are stdpopsim.IsolationWithMigration(NA, N1, N2, T, M12, M21), but the actual populations are 0 == pop1, 1 == pop2, 2 = ancestral pop. It would be less confusing if we had stdpopsim.IsolationWithMigration(N0, N1, NA, T, M01, M10), and the populations then at least matched their indexes in the final tree sequence.
  2. The population indexes aren't documented in the output
  3. What direction of time is the migration rate M01/M10 going in?
  4. There's a redundant sentence at the start of the docstring (same for PiecewiseConstantSize).

In general, I think these models would be better off defined in msprime -- see https://github.com/tskit-dev/msprime/pull/1025/ for a proposal.

It's probably still good to have an interface to them here in stdpopsim though.

Dominant language
Python
Stars
144
Forks
100
Avg merge
2h 44m
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from popsim-consortium/stdpopsim

All issues in popsim-consortium/stdpopsim

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.