DeepCycle
DeepCycle copied to clipboard
chore: minor dirtree modifications
I would suggest a few changes to the repo structure to conform with what is usually available:
- create a top lvl dir
resourcesand put go_annotations inside - create a top lvl dir
test- add a simple bash script under
scripts; the script would download theh5adfiles from zenodo automatically and put them undertest/data. - is
theta_annotationa resource or an example input? It should be put either underresourcesor undertest. Should this go together with the go annotations(?)
- add a simple bash script under
-
DeepCycle.pyis a script so it should go underscriptstoo. - a standard name for a conda env is
environment.yml(instead ofDeepCycle_env.yml). Then you can just runconda env createand the package manager automatically looks forenvironment.ymlfile. The env will still retain the name specified within the YAML file.
Also: people generally include their colorful GH shields on top of the README file, they are very attractive ;)
I would suggest to move the zenodo example data shield to the top and later in the text just use a link with a URL. Also, it would be nice to upload the repo itself to zenodo! Nothing wrong with having two zenodo shields on top.