Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an ancestry model "type" or similar enum/flag #1576

Open
jeromekelleher opened this issue Mar 25, 2021 · 1 comment
Open

Add an ancestry model "type" or similar enum/flag #1576

jeromekelleher opened this issue Mar 25, 2021 · 1 comment
Milestone

Comments

@jeromekelleher
Copy link
Member

In #1573 we added the idea of a "duration" to ancestry models, which determines the maximum amount of time we can run. There was also some clarification in the docs about models that will run until full coalescence (e.g. Hudson), and those that will complete before this (e.g Sweeps, Pedigree).

It is current an easily made gotcha to do something like

ts = msprime.sim_ancestry(..., model=[msprime.DiscreteTimeWrightFisher(), msprime.StandardCoalescent()])

Because we've not specified a duration value, the second model will never run. We should add a type (or something) enum to the model class, which tells us whether models are "complete" or not, so that if we see any models in the list after a "complete" model with no duration value, we know it's an error.

@jeromekelleher jeromekelleher added this to the 1.0.1 milestone Mar 25, 2021
@jeromekelleher
Copy link
Member Author

Can change the warning in the docs about this too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant