Skip to content

Commit 709f2dc

Browse files
authored
Merge pull request #515 from petrelharp/imp_note
small note in treeseq implementation
2 parents acf0f08 + e0b27b9 commit 709f2dc

1 file changed

Lines changed: 11 additions & 18 deletions

File tree

treerec/implementation.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -211,21 +211,14 @@ in the tree sequence already (and the associated keys in the schema).
211211
We've not done that yet because making things exactly match seems like a pain,
212212
and no-one else is using the top-level metadata yet.
213213

214-
### Top-level metadata:
215-
216-
*Note: this is out of date.* Here's an example of the top-level metadata:
217-
```
218-
{
219-
"SLiM" : {
220-
"model_type" : "WF",
221-
"generation" : 123,
222-
"file_version" : "0.5",
223-
"spatial_dimensionality" : "xy",
224-
"spatial_periodicity" : "x",
225-
"separate_sexes" : true,
226-
"nucleotide_based" : false
227-
}
228-
}
229-
```
230-
231-
However, we're currently only using `model_type`, `generation`, and `file_version`.
214+
## Reading in tree sequences
215+
216+
In addition to the various things mentioned above,
217+
To read in a tree sequence, SLiM requires that:
218+
219+
1. the two nodes corresponding to haplosomes of a given individual are adjacent in the node table,
220+
and sorted by haplosome ID.
221+
222+
This is because of how `__TabulateSubpopulationsFromTreeSequence` works;
223+
probably it could be made more general, but it isn't.
224+

0 commit comments

Comments
 (0)