Compare commits

..

3 Commits

Author SHA1 Message Date
Lucas Frérot 3365403814
added dependencies 2024-12-27 18:45:42 +01:00
Lucas Frérot 3a7e3d870f
handling missing curl 2024-12-27 18:43:08 +01:00
Lucas Frérot 09d7767a1a
adding authors file and licence creation 2024-12-27 18:41:18 +01:00
3 changed files with 46 additions and 2 deletions

1
AUTHORS Normal file
View File

@ -0,0 +1 @@
Lucas Frérot <lucas.frerot@sorbonne-universite.fr> Sorbonne Université, CNRS, Institut Jean Le Rond dAlembert, F-75005 Paris, France

View File

@ -7,3 +7,13 @@ 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
View File

@ -157,14 +157,47 @@ 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}'"
else fi
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