petrelharp / ftprime_ms

4 stars 2 forks source link

Refocussed the API overview section. #56

Closed jeromekelleher closed 6 years ago

jeromekelleher commented 6 years ago

I've mostly rewritten the "Overview of the API" section and recast it into a "Implementation Overview". I think it's useful to give a bird's eye view of what's going on in the implementations without getting too much into the gorey details.

I've probably got some stuff wrong here in terms of the simulator implementations, so please feel free to correct!

Also, I'm not sure if "proof-of-concept" is how we want to refer to the implementations?

ashander commented 6 years ago

Unless @petrelharp objects I will merge this in while doing the simupop-related edits