Compare commits
No commits in common. "3365403814ad7beb88f3784b74807db236d6df58" and "64c901d40d5027f3ec9aa19aa7afcc236a258b48" have entirely different histories.
3365403814
...
64c901d40d
1
AUTHORS
1
AUTHORS
|
@ -1 +0,0 @@
|
||||||
Lucas Frérot <lucas.frerot@sorbonne-universite.fr> Sorbonne Université, CNRS, Institut Jean Le Rond d’Alembert, F-75005 Paris, France
|
|
10
README.md
10
README.md
|
@ -7,13 +7,3 @@ management](https://git.dalembert.upmc.fr/lfrerot/good_simulation_practices/wiki
|
||||||
lists tenets that must be respected when working with simulation code and
|
lists tenets that must be respected when working with simulation code and
|
||||||
scientific data. This repository provides scripts to help automatically enfore
|
scientific data. This repository provides scripts to help automatically enfore
|
||||||
these tenets (as much as possible).
|
these tenets (as much as possible).
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
The script `rtenets` requires:
|
|
||||||
|
|
||||||
- bash
|
|
||||||
- git
|
|
||||||
- curl (optional, for web-based operations)
|
|
||||||
- jq (optional, for gitea API calls)
|
|
||||||
- python (optional, to setup dtool and snakemake)
|
|
||||||
|
|
37
rtenets
37
rtenets
|
@ -157,47 +157,14 @@ create_tenet_file_tree() {
|
||||||
# ${project_name}
|
# ${project_name}
|
||||||
|
|
||||||
${project_desc}
|
${project_desc}
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
Here are the dependencies to build and run the code:
|
|
||||||
|
|
||||||
- <dependencies_list>
|
|
||||||
|
|
||||||
## Running the code
|
|
||||||
|
|
||||||
Here is how to run the code:
|
|
||||||
|
|
||||||
\`\`\`
|
|
||||||
<make_all_figures>
|
|
||||||
\`\`\`
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Here is how to run the tests:
|
|
||||||
|
|
||||||
\`\`\`
|
|
||||||
<run_all_tests>
|
|
||||||
\`\`\`
|
|
||||||
READMEMSG
|
READMEMSG
|
||||||
|
|
||||||
info "wrote '${readme}'"
|
info "wrote '${readme}'"
|
||||||
fi
|
else
|
||||||
|
warning "found '${readme}', not touching"
|
||||||
if ! [ -f AUTHORS ]; then
|
|
||||||
printf "%s\\n" "${USER} <${EMAIL}> ${AFFILIATION}" > AUTHORS
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
local licence="COPYING"
|
local licence="COPYING"
|
||||||
|
|
||||||
if ! [ -f "${licence}" ]; then
|
|
||||||
if has_command curl; then
|
|
||||||
info "setting licence to GPL by default, see https://www.gnu.org/licenses for more options"
|
|
||||||
curl "https://www.gnu.org/licenses/gpl-3.0.txt" > "${licence}"
|
|
||||||
else
|
|
||||||
warning "please choose a free software licence, see https://www.gnu.org/licenses"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Create git repository
|
# Create git repository
|
||||||
|
|
Loading…
Reference in New Issue