pierrepo / PBxplore

A suite of tools to explore protein structures with Protein Blocks :snake:
https://pbxplore.readthedocs.org/en/latest/
MIT License
28 stars 17 forks source link

[WIP] Group demo files #99

Closed jbarnoud closed 8 years ago

jbarnoud commented 8 years ago

Implement my comment in issue #97

This pull request

The help message for PBdata is copied bellow:

$PBdata -h
usage: PBdata [-h] [--list] [--list-abs]

Print info on the demonstration files bundled with PBxplore

optional arguments:
  -h, --help        show this help message and exit
  --list, --ls, -l  List the available files instead of the directory path.
  --list-abs, -L    List the absolute path to the available files instead of
                    the directory path.

TODO:

This PR is based on #96. I will rebase the branch when #96 will actually be merged.

jbarnoud commented 8 years ago

I added a page in the doc directory about the demonstrations and the demo files. Some of these files are are related to papers, it would be nice to cite these papers in the documentation. Yet, I do not know what file comes with what paper. @pierrepo ?

Beside that, the PR is almost ready. It just requires an external eye, and #96 to be merged.

Also the name PBdata may not be the best. I ruled out PBdemo to avoid confusion with the demo scripts, and PBdemo-data-files because it is way to long. PBdata may be just fine, but maybe you have other ideas.

pierrepo commented 8 years ago

@jbarnoud OK for the reference papers. How exactly do you want us to cite the references? In the doc string? In a separate file?