TODO before NetSci'19 talk on 5/29
leotrs opened this issue · 14 comments
- link to @dsaffo's stuff somewhere in the README maybe?
- test installation on different systems and versions of python. We can use Travis for this. I'm assigning this to @sdmccabe
- add a short example notebook. @jkbren do you want to do this?
- MAYBE setup read the docs? @leotrs
- mention readthedocs in CONTRIBUTING and README
- add "docs passing" "test passing" badges
- remove "pre-alpha" from README and change version to 0.1
We should add some language to CONTRIBUTING about readthedocs.
To add: debug the absence of utilities in RTD
I doubt we'll get to it before NetSci but we should also be more consistent in whether the class definition or the method definition is getting the bulk of the documentation.
Also, along with the example notebooks it would be nice to have the readthedocs have some sort of short tutorial so it's not just the API reference.
Also also, do we want to allow CLI usage of netrd?
$ netrd --dist NBD edgelist1.txt edgelist2.txt
$ netrd --recons qJSD timeseries.csv
$ netrd --simulate SIR edgelist.txt
CLI usage is a nice thought for something down the road, definitely not pre-NetSci. I would actually imagine that being a separate package, e.g, netsiphd/netrd-cli, that depended on this library.
Can you open a separate issue for that and tag as enhancement?
Agree on the tutorial; my thought would be to take a netrd notebook and then just port it to RST for readthedocs to have something up quickly, then flesh it out later.
Should CONTRIBUTING include/mention a code of conduct?
What kind of code of conduct?
https://help.github.com/en/articles/adding-a-code-of-conduct-to-your-project
Something like this I guess?
One more for the list: add a repository description.
You have to be on netsiphd to do it.
First pass:
Description: A library for network {reconstruction, distances, dynamics}
URL: https://netrd.readthedocs.io/en/latest/
What's missing are mentions of python and networkx, since we should probably emphasize that the purpose is to build on networkx (since people already use it).