Closed jbarnoud closed 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.
@jbarnoud OK for the reference papers. How exactly do you want us to cite the references? In the doc string? In a separate file?
Implement my comment in issue #97
This pull request
pbxplore.demo
, except the files that are indemo_paper
pbxplore.demo
module with aDEMO_DATA_PATH
constant pointing to the demo filespbxplore.DEMO_DATA_PATH
shortcutPBdata
program that prints the path to the data files, or list all data filesThe help message for
PBdata
is copied bellow:TODO:
This PR is based on #96. I will rebase the branch when #96 will actually be merged.