tskit-dev / pyslim

Tools for dealing with tree sequences coming to and from SLiM.
MIT License
27 stars 23 forks source link

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

Open hyanwong opened 2 years ago

hyanwong commented 2 years ago

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 commented 2 years ago

I've mocked up what it might look like in a PR at https://github.com/tskit-dev/tutorials/pull/142 which also incorporates the idea in https://github.com/tskit-dev/pyslim/issues/137#issuecomment-988076069. 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.