Skip to content

Commit

Permalink
Merge branch 'main' into patch-3
Browse files Browse the repository at this point in the history
  • Loading branch information
CaptainSifff authored Mar 26, 2024
2 parents 6fec2ef + cb11c32 commit d061e00
Show file tree
Hide file tree
Showing 24 changed files with 571 additions and 67 deletions.
2 changes: 2 additions & 0 deletions .github/spellignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Center
CHAOSS
citable
codebase
codebases
CodeMeta
CodeRefinery
comp-lvls-se
Expand Down Expand Up @@ -142,6 +143,7 @@ RSE
RSE's
rse-specialisations
RTPs
scalable
scipy
SeniorCC
SRU
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/compile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ jobs:
- name: Install pandoc
run: |
sudo apt-get update && sudo apt-get install -y --no-install-recommends \
inkscape \
texlive texlive-latex-extra pandoc latexmk \
texlive-bibtex-extra biber \
texlive-fonts-recommended texlive-fonts-extra lmodern fonts-linuxlibertine \
Expand Down
395 changes: 395 additions & 0 deletions LICENSE.md

Large diffs are not rendered by default.

8 changes: 5 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

MAKE_PDFA := true

objects := intro.pdf competencies.pdf institutionalised_education.pdf survey.pdf call_to_action.pdf
objects := competencies.pdf institutionalised_education.pdf survey.pdf call_to_action.pdf

all: $(objects)

%.pdf: %.md bibliography.bib contributors.yml preamble.sty build/template.tex glossary.tex filter.py
@mkdir -p build
@mkdir -p build/svg-inkscape
@rm -f build/pdfa.xmpi
cp --update preamble.sty build/
cp --update bibliography.bib build/
Expand All @@ -21,6 +22,7 @@ all: $(objects)
--biblatex \
--toc \
--template="build/template.tex" \
-f markdown-latex_macros \
-M pdfa-$(MAKE_PDFA)=1 \
-M date="`date "+%B %e, %Y"`" \
-M datexmp="`date "+%F"`" \
Expand All @@ -33,11 +35,11 @@ all: $(objects)
@sed -i '/\\author{}/d' "build/${@:.pdf=}.tex"
if grep -q "\\makeglossaries" "${<}"; then \
cd build; \
pdflatex --jobname="${@:.pdf=}" "${@:.pdf=}.tex"; \
pdflatex -shell-escape --jobname="${@:.pdf=}" "${@:.pdf=}.tex"; \
makeglossaries "${@:.pdf=}"; \
fi
latexmk \
-pdflatex -bibtex -halt-on-error \
-pdflatex -shell-escape -bibtex -halt-on-error \
-jobname="${@:.pdf=}" -cd "build/${@:.pdf=}.tex"
@mv "build/${@}" "${@}"

Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Paper: Teaching and Learning Research Software Engineering
# The teachingRSE project: "Teaching and Learning Research Software Engineering"

Output of the de-RSE 2023 Conference Workshop on "Teaching and Learning Research Software Engineering".
It started all at a workshop at deRSE23 in Paderborn where the community came together to discuss what to teach to future RSEs
and in which institutions to bring up the next generation of RSEs.

Since the original idea grew in size and scope we had to split the paper in different subpapers highlighting different aspects
As we discovered, the scope of this task is so big that
we had to split the paper in different subpapers highlighting different aspects

Get the latest version of the respective PDF files here:

* "Foundational competencies and responsibilities of an RSE" ([competencies.pdf](https://github.com/CaptainSifff/paper_teaching-learning-RSE/blob/build/competencies.pdf))
* "Institutionalized Organisation of RSE Education" ([institutionalised_education.pdf](https://github.com/CaptainSifff/paper_teaching-learning-RSE/blob/build/institutionalised_education.pdf))
* A separate web project on surveying and curating existing resources, the [learn-and-teach project](https://github.com/DE-RSE/learn-and-teach) [website](https://de-rse.org/learn-and-teach/)
* "A Survey of Initiatives Providing Educative Material in the RSE Space" ([survey.pdf](https://github.com/CaptainSifff/paper_teaching-learning-RSE/blob/build/survey.pdf))
* "Educating RSEs in Germany - What Needs to Be Done" ([call_to_action.pdf](https://github.com/CaptainSifff/paper_teaching-learning-RSE/blob/build/call_to_action.pdf))

Older:
* "Teaching and Learning Research Software Engineering" ([intro.pdf](https://github.com/CaptainSifff/paper_teaching-learning-RSE/blob/build/intro.pdf))

## How to contribute - Some of our rules

This paper is intended as a collaborative effort and we are looking for input from you.
Expand All @@ -24,7 +24,9 @@ This paper is intended as a collaborative effort and we are looking for input fr

**We use British English**

**We have regular meetings, out meeting notes can be found here: https://pad.gwdg.de/s/pVBQ3Sh7Z# **
**We have regular meetings, out meeting notes can be found here: https://pad.gwdg.de/s/pVBQ3Sh7Z#**

**If you want to get notified of our calls, and participate in the discussion by E-Mail, we have a Mailing-List: https://lists.uni-wuerzburg.de/mailman/listinfo/teachingrse**

- competencies.md will be published on arxiv. LaTeX tags/code is fine in here.
- survey.md will move to a website, hence this file has to be Markdown
Expand Down
34 changes: 27 additions & 7 deletions bibliography.bib
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,13 @@ @Online{BioinformaticsCertification
urldate = {2023-07-20},
}

@Online{learnandteach,
author = {{The teachingRSE project}},
title = {Learning and teaching RSE},
url = {https://de-rse.org/learn-and-teach/},
urldate = {2024-02-22},
}

@Article{Bird2016,
title = {Using Metadata Actively},
volume = {11},
Expand Down Expand Up @@ -1409,13 +1416,15 @@ @Misc{DFG_50_01
urldate = {2023-11-14},
}

@misc{dfg_gsp,
author = {Deutsche Forschungsgemeinschaft},
title = {Guidelines for Safeguarding Good Research Practice. Code of Conduct},
month = apr,
year = 2022,
publisher = {Deutsche Forschungsgemeinschaft},
doi = {10.5281/zenodo.6472827},
@TechReport{dfg_gsp,
author = {Deutsche Forschungsgemeinschaft},
title = {Guidelines for Safeguarding Good Research Practice},
year = {2022},
type = {Code of Conduct},
number = {version~1.1},
month = apr,
doi = {10.5281/zenodo.6472827},
publisher = {Deutsche Forschungsgemeinschaft},
}

@InCollection{Diamond2016,
Expand Down Expand Up @@ -5587,3 +5596,14 @@ @article{turing_way_2022
urldate = {2023-06-07},
keywords = {collaboration,community,data science,ethics,handbook,reproducibility,research practices}
}

@article{smith_SoftwareCitationPrinciples2016,
title = {Software Citation Principles},
author = {Smith, Arfon M. and Katz, Daniel S. and Niemeyer, Kyle E. and {FORCE11 Software Citation Working Group}},
year = {2016},
journal = {PeerJ Computer Science},
volume = {2},
number = {e86},
issn = {2376-5992},
doi = {10.7717/peerj-cs.86}
}
Loading

0 comments on commit d061e00

Please sign in to comment.