ReproNim / reproman

ReproMan (AKA NICEMAN, AKA ReproNim TRD3)
https://reproman.readthedocs.io
Other
24 stars 14 forks source link

DOC: provide a complete example walk-though for a typical bids-app case (e.g. on mriqc) #548

Open yarikoptic opened 3 years ago

yarikoptic commented 3 years ago

We have a nice doc for run already: https://reproman.readthedocs.io/en/latest/execute.html (sources for docs are in the repo)

Based on the successful testing of "run on AWS" (following the #438 prototypical usecase), documentation should be extended with a section on a use case which would go though all stages to run a BIDS-app using reproman on a condor cluster in AWS. Building upon the https://github.com/ReproNim/containers/#a-typical-workflow it should start from a new installation of reproman (from pypi) and go through

yarikoptic commented 3 years ago

as of b9bb1a26fb4da49671e9647f71077828dbe69ea3 (in 0.4.0) README.md contains a prototypical example. The only things missing from above are reproman jobs since uses --follow. I think that example should be expanded within documentation to provide a more thorough presentation