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

Vignettes as "tutorials" on tskit.dev/tutorials? #212

Open
hyanwong opened this issue Dec 7, 2021 · 1 comment
Open

Vignettes as "tutorials" on tskit.dev/tutorials? #212

hyanwong opened this issue Dec 7, 2021 · 1 comment

Comments

@hyanwong
Copy link
Member

hyanwong commented Dec 7, 2021

I can't remember if we were going to move the pyslim "vignettes" to the tskit tutorials site. There's a section labelled "forward simulation" there, which is currently aimed at showing people how they can record table info forward in time (i.e. build their own simple forward simulator). But there's no reason why we can't have a separate subsection (like in "Backward Time Simulation -> Advanced msprime topics") called "Advanced SLiM topics" that contains a few tutorials showing how to do the tree sequence manipulation stuff using a smile tree sequence: recapitation, location of ancestors, etc.

As long as the vignettes / tutorials are focussed on tree sequence methods needs to get the most out of the SLiM-tree-sequence, this seems like a good home to me. But perhaps we are happy leaving them in the pyslim repo instead?

@hyanwong
Copy link
Member Author

hyanwong commented Dec 8, 2021

I've mocked up what it might look like in a PR at tskit-dev/tutorials#142 which also incorporates the idea in #137 (comment). I'm quite happy with this idea, but if so, we'll need to figure out how to install SLiM on the tutorials repo: shifting it to a conda-based install seems the easiest, although might be a little bit of a hassle (perhaps not too bad though, as we can simply duplicate the setup e.g. in the msprime repo).

I think having the SLiM script auto-executed by CI is a big win for reproducibility.

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

No branches or pull requests

1 participant