Potential README template

[effigies]

Starting on a template for README: https://hackmd.io/4U3YadNRSmCl2OlE1eOTdw

[jbwexler]

Looks great, do you think they are complete? Only thing I can think of to add is a line saying something like: "Standard output and error logs can be found in .reproman/jobs/local/"

Btw, is there some way autogenerate READMEs from these templates?

[effigies]

Looks great, do you think they are complete? Only thing I can think of to add is a line saying something like: "Standard output and error logs can be found in .reproman/jobs/local/"

You should be able to login with your GitHub account and edit.

Btw, is there some way autogenerate READMEs from these templates?

>>> from jinja2 import Template
>>> template = Template("""\
# {{ dataset_id }} - fMRIPrep derivatives

This dataset is a BIDS Derivatives dataset resulting from running {{ pipeline }} on {{ dataset_id }} version {{ version }}.

## Methods

For a complete description of the methods applied to these data, see [logs/CITATION.md](logs/CITATION.md).
This boilerplate text is released under [CC0](https://creativecommons.org/publicdomain/zero/1.0/), and may be used in whole or part to describe the preparation of these data in publications.

## Acknowledgements

These derivatives were generated on the [Texas Advanced Computing Center](https://www.tacc.utexas.edu/) Frontera computing system [1] through their [Pathways allocation](https://frontera-portal.tacc.utexas.edu/allocations/).

[1]: Dan Stanzione, John West, R. Todd Evans, Tommy Minyard, Omar Ghattas, and Dhabaleswar K. Panda. 2020. Frontera: The Evolution of Leadership Computing at the National Science Foundation. In Practice and Experience in Advanced Research Computing (PEARC ’20), July 26–30, 2020, Portland, OR, USA. ACM, New York, NY, USA, 11 pages. https://doi.org/10.1145/3311790.3396656
""")
>>> print(template.render(dict(dataset_id="ds000001", pipeline="fMRIPrep", version="22.0.0")))
# ds000001 - fMRIPrep derivatives

This dataset is a BIDS Derivatives dataset resulting from running fMRIPrep on ds000001 version 22.0.0.

## Methods

For a complete description of the methods applied to these data, see [logs/CITATION.md](logs/CITATION.md).
This boilerplate text is released under [CC0](https://creativecommons.org/publicdomain/zero/1.0/), and may be used in whole or part to describe the preparation of these data in publications.

## Acknowledgements

These derivatives were generated on the [Texas Advanced Computing Center](https://www.tacc.utexas.edu/) Frontera computing system [1] through their [Pathways allocation](https://frontera-portal.tacc.utexas.edu/allocations/).

[1]: Dan Stanzione, John West, R. Todd Evans, Tommy Minyard, Omar Ghattas, and Dhabaleswar K. Panda. 2020. Frontera: The Evolution of Leadership Computing at the National Science Foundation. In Practice and Experience in Advanced Research Computing (PEARC ’20), July 26–30, 2020, Portland, OR, USA. ACM, New York, NY, USA, 11 pages. https://doi.org/10.1145/3311790.3396656

[effigies]

Oh, and they're not complete. We should add something about the MRIQC methods. If it doesn't produce a self-description, we could at least link to the MRIQC docs of the version we use. Though it looks like MRIQC isn't updating docs anymore. @oesteban?

[oesteban]

Yeah, I still have to investigate what's wrong with readthedocs. It would not be crazy to add some boilerplate to MRIQC.