Write documentation for publication

flo-schu / pymob

Python model building platform

MIT License

0 stars 0 forks source link

Write documentation for publication #28

Closed flo-schu closed 2 months ago

flo-schu commented 3 months ago

[x] High level documentation
[x] README.md (currently timepath)
[x] Link to project

flo-schu commented 3 months ago

Top level README was added although it is very slim. Next step is to work on the docs. Here I already have a starting point. Unfortunately this is already outdated and at the moment I have a hard time to write a documentation that will describe an API that I will stop using very soon. I should probably still do it just for the sake of wrapping up the case study and recording a status quo.

flo-schu commented 2 months ago

Finalized in commits https://github.com/flo-schu/pymob/pull/25/commits/12e158a5623cd9933a9e0cc39851c03c89ee6fcc, https://github.com/flo-schu/pymob/pull/25/commits/88b5909418ed1bed675dd9292fd3f6460ddc963f and https://github.com/flo-schu/pymob/pull/25/commits/3908db00c0100cb436fff5be3ceef91f0a0ed501