Skip to content

Commit 79349b1

Browse files
authored
Merge branch 'main' into fix/image_replacements
2 parents f332e5b + 0d2b907 commit 79349b1

13 files changed

+133
-23
lines changed

.github/workflows/announce-release.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,7 @@ jobs:
2323
message: |
2424
Beep, Beep - I am your friendly #Snakemake release announcement bot.
2525
26-
There is a new release of the Snakemake executor for #SLURM on #HPC systems. Its version now is {{ version }}!
27-
28-
Give us some time, and you will automatically find the plugin on #Bioconda and #Pypi.
26+
There is a new release of the #HPC Teaching Material for Snakemake. Its version now is {{ version }}!
2927
3028
If you want to discuss the release, you will find the maintainers here on Mastodon!
3129
@rupdecat and @[email protected]

.github/workflows/build.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ jobs:
2828

2929
- name: LaTeX compile
3030
run: |
31-
./render --master-tex Snakemake_HPC_Users.tex --configfile config/config_for_github.yaml ;
32-
./render --master-tex Snakemake_HPC_Creators.tex --configfile config/config_for_github.yaml
33-
./render --master-tex Snakemake_HPC_User_Creator_Combi.tex --configfile config/config_for_github.yaml
34-
./render --master-tex Snakemake_HPC_Admins.tex --configfile config/config_for_github.yaml ;
31+
./render --master-tex Snakemake_HPC_Users.tex --configfile config/config_for_github.yaml --handout --sample-directory=_;
32+
./render --master-tex Snakemake_HPC_Creators.tex --configfile config/config_for_github.yaml --handout --sample-directory=_;
33+
./render --master-tex Snakemake_HPC_User_Creator_Combi.tex --configfile config/config_for_github.yaml --handout --sample-directory=_;
34+
./render --master-tex Snakemake_HPC_Admins.tex --configfile config/config_for_github.yaml --handout --sample-directory=_;
3535
3636
- name: Certificate compile
3737
run: |

CHANGELOG.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,56 @@
11
# Changelog
22

3+
## [1.2.0](https://github.com/snakemake/snakemake-hpc-teaching-material/compare/v1.1.2...v1.2.0) (2025-05-25)
4+
5+
6+
### Features
7+
8+
* added announcement bot workflow ([034082c](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/034082c6d9ff378dbd886d21b300bc3655f30baa))
9+
* added announcement bot workflow ([1e95fd1](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/1e95fd1d5812cfc7046d4d51df948ec2342de558))
10+
* added current paper reference ([e83919e](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/e83919eee6edd6d2c2f2381d5d14828b0fdc92f6))
11+
* added handout watermark to all slide sets ([aece2e0](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/aece2e032a7eca0097bc2d65170a1719c26cbeb6))
12+
* added image to illustrate modularization ([8a00753](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/8a0075390a8f3d7fd04fff4a2e37f3d398709fc0))
13+
* added mastodon shield for release bot ([010a6cc](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/010a6ccd86ba3eb5ecabba3bf226193eb3e29c5a))
14+
* added section about modularization ([7fb6840](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/7fb6840497fd5d49e9ea2c9122a9205db8fb7be9))
15+
* added selecting workflows section ([6e0cfad](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/6e0cfadb78208dbf6dcda324fb6ad312a163e543))
16+
* added up-to-date image ([583df46](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/583df467af91505a3109b8578b90ae39ab0bcca1))
17+
* added using wrappers section ([35c7f7e](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/35c7f7eee0ef5dc0aa63b5c61919655b80e0577a))
18+
* added wrapper solution ([e5527d4](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/e5527d46f50755171b4a01fe574cf66c29477a5f))
19+
* better directory layout shown - added slide about logging functionality with Python ([9c46d72](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/9c46d721fccbdad3fe049118243b42ec4ebba3d1))
20+
* render script can skip packaging when rendering handouts! ([ceb081b](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/ceb081b0442dfafa59c7f9360150e928d2391b2d))
21+
* rendering release slides with handout watermark ([a4c63a5](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/a4c63a52e3e5fcfb0f812edfdfe82fac06298ee5))
22+
* update dresden yaml ([ef2b076](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/ef2b07665614f4231794eee1ac6e8f1aa900ffaf))
23+
24+
25+
### Bug Fixes
26+
27+
* accounting for updates in barnard and mamba/conda ([295f959](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/295f9597e2e48210f24f2878bcd1dce636525ffd))
28+
* added deploy_url ([f1417a2](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/f1417a263101d85d4e8d7b2e4b2dcb7b66ceb783))
29+
* added missing --sample-directory flag ([5e2e45d](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/5e2e45da667deb27137e5c9abba9a69e161e0b74))
30+
* added missing quotation marks ([13b31fa](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/13b31fabfac2ec6eb8c8ac0b6a355ce4073887eb))
31+
* added missing quotation marks! ([0c3d5b4](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/0c3d5b4c2a51b682925a536cb5e43cec63dfc0b5))
32+
* better handout watermark ([8efad6d](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/8efad6d6f3e89112e56208d8b2047c0f93a837c3))
33+
* correct directory and suffix for quals plot - on some clusters display of svg files does not work. ([6281807](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/6281807d07b8847357be943ece6400695296057e))
34+
* corrected title ([f8c6449](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/f8c644981e4ec0bbe350661089fbaa4a7744b0cf))
35+
* deleted outcommented code ([83c7b15](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/83c7b15db0bf352ef6791b6fc507869c8be5e191))
36+
* dresden ([f754fc8](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/f754fc899211d7482fa2899413ef2cff6aa2b741))
37+
* handout production ([79504f0](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/79504f0eb288a0e7f057091473f86368ce6ba3bd))
38+
* image path ([badf818](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/badf818b64f9478659a644a177c7e697549dd694))
39+
* introduced skipping producing a zip file ([88fd1ac](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/88fd1ac98849a72932c694e7ecb8e20dccca9b28))
40+
* minor ([7374ef8](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/7374ef8937f0c6b611cdfb9be17336745001023b))
41+
* moved reference to bottom in Survey slide ([80e8742](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/80e8742d1f01ff246b346857cecc454f74cadef5))
42+
* SAMPLES -> samples ([613b926](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/613b926380e6cc965414e454b78b75452cce5b1e))
43+
* SAMPLES -> samples ([ba73e79](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/ba73e79bd48de8e10eddf37325204bbe7ed3a70b))
44+
* SAMPLES -> samples ([7b855df](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/7b855df580d801c40ca9e8e50a47f174c31eeb37))
45+
* superscript without math mode ([01c031d](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/01c031dc94643b28049d3729b092cddc149eb747))
46+
* tutorial folder renamed to task folder ([46ddabc](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/46ddabcbd37ce2215f6f38668ff93c3fc47cf957))
47+
* typo ([0bd1454](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/0bd14548239b834e3804aa224e959184a24fde80))
48+
* update github config yaml ([9350d94](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/9350d941e60928aa46bd5502b95318678922ddee))
49+
* updated condarc for mogon ([4a99729](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/4a9972987e7ae97ca8c537e587866565c7fddd05))
50+
* updated plot output path ([cdbd2f6](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/cdbd2f6923520dd1e31af4c663adcf67b74d4ed4))
51+
* will end if --handout, but not --sample-diretory is given ([6ff800d](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/6ff800d4bbec87566d2ac51e2324ebd0f981ce8c))
52+
* with the introduction of libmamba in conda, we can savely use conda, too ([111ffbb](https://github.com/snakemake/snakemake-hpc-teaching-material/commit/111ffbbfcced2a71e7dfcb83bd70b8459829bfbd))
53+
354
## [1.1.2](https://github.com/snakemake/snakemake-hpc-teaching-material/compare/v1.1.1...v1.1.2) (2025-02-18)
455

556

CITATION.cff

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
cff-version: 1.2.0
2+
message: "If you use this teaching material, please cite it as below."
3+
authors:
4+
- family-names: "Petersen"
5+
given-names: "Malte"
6+
orcid: "https://orcid.org/0000-0001-7601-9873"
7+
- family-names: "Hellmann"
8+
given-names: "Sören Lukas"
9+
orcid: "https://orcid.org/0000-0003-4958-1419"
10+
- family-names: "Böker"
11+
given-names: "Florian"
12+
orcid: "https://orcid.org/0000-0002-0732-6914"
13+
- family-names: "Brand"
14+
given-names: "Fabian"
15+
orcid: "https://orcid.org/0000-0003-1885-7021"
16+
- family-names: "Sharma"
17+
given-names: "Aasish Kumar"
18+
orcid: "https://orcid.org/0000-0002-7514-2340"
19+
- family-names: "Pleico"
20+
given-names: "Martin Leandro"
21+
orcid: "https://orcid.org/0000-0002-8427-0221"
22+
- family-names: "Köster"
23+
given-names: "Johannes"
24+
orcid: "https://orcid.org/0000-0001-9818-9320"
25+
- family-names: "Meesters"
26+
given-names: "Christian"
27+
orcid: "https://orcid.org/0000-0003-2408-7588"
28+
title: "Teaching Reproducible Data Analysis for HPC Users -- The Snakemake Teaching Alliance "
29+
version: 1.0
30+
doi: https://doi.org/10.14279/eceasst.v83.2600
31+
date-released: 2025-02-21
32+
url: "https://github.com/snakemake/snakemake-hpc-teaching-material/"

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/snakemake/snakemake-hpc-teaching-material/build.yml?label=tests)](https://github.com/snakemake/snakemake-hpc-teaching-material/actions?query=branch%3Amain++)
33
[![Build LaTex sources.](https://github.com/snakemake/snakemake-hpc-teaching-material/actions/workflows/build.yml/badge.svg)](https://github.com/snakemake/snakemake-hpc-teaching-material/actions/workflows/build.yml)
44
![Mastodon Follow](https://img.shields.io/mastodon/follow/109245696038111591?domain=https%3A%2F%2Ffediscience.org&style=flat)
5+
![Mastodon Follow](https://img.shields.io/mastodon/follow/113407240116926289?domain=fediscience.org&style=flat)
56

67
# The Snakemake Teaching Alliance
78

config/config_for_github.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ layout:
1313
beamercolor_title: "fg=UniRot"
1414
beamercolor_title_head: "fg=UniRot"
1515

16+
1617
beamercolor_block_title: "bg=UniRot!20,fg=darkred"
1718
beamercolor_block_body: "fg=black, bg=plightgrey2"
1819

@@ -22,10 +23,11 @@ layout:
2223
# The configuration for github needs valid file strings!
2324

2425
course:
25-
date: "datestring" # maybe: "\today"
26+
# sets the slides aspectratio (if outcommented, the default is 43=4:3)
27+
aspectratio: 1609 # - 169 = 16:9
28+
date: "\today" # maybe: "\today"
2629
#title: "" # specifiy your title here, else a default is used.
2730
#subtitle: "" # specifiy your subtitle here, else a default is used.
28-
question: "yes"
2931
# Editors recommendations are a matter of taste and technological
3032
# setups (e.g. on-demand setups). Hence, specify an editor-slide,
3133
# here:
@@ -36,7 +38,9 @@ course:
3638
condarcfile: "common/condarc_mogon.tex"
3739
# the same for admins:
3840
condarc_admins_file: "admin/condarc_mogon.tex"
39-
# the following path will indicate a sample workflow for the user part
41+
# We provide a common software stack to avoid long
42+
# installation sessions.
43+
softwarepath: "software-stack-path"
4044
# if it is defined, the slide set will instruct participants to copy
4145
# it and adapt its configuration and profile.
4246
pathtoworkflow: "/lustre/project/nhr-workflow/workflow"

render

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,9 @@ def find_and_replace_sections(boundaries, section_estimate, fname):
183183
if minitocline:
184184
lower = max((section_estimate - 2), 1) # lower boundary not lower than 1
185185
upper = section_estimate + 2
186-
upper = upper if upper < boundaries["upper"] else boundaries["upper"] + 1 # upper boundary not higher then upper boundary ;-)
186+
upper = (
187+
upper if upper < boundaries["upper"] else boundaries["upper"] + 1
188+
) # upper boundary not higher then upper boundary ;-)
187189
sections = f"{lower}-{upper}"
188190
lines[minitocline] = (
189191
" \\tableofcontents[currentsection, sections={"
@@ -232,7 +234,7 @@ if __name__ == "__main__":
232234
)
233235
parser.add_argument(
234236
"--sample-directory",
235-
help="needed with `--handout` - should indicate directory with script file (cloze and solution)",
237+
help="needed with `--handout` - should indicate directory with script files (cloze and solution)",
236238
)
237239
args = parser.parse_args()
238240

@@ -241,6 +243,7 @@ if __name__ == "__main__":
241243
"ERROR: must indicate --sample-directory when writing handouts",
242244
file=sys.stderr,
243245
)
246+
sys.exit(1)
244247

245248
# the master tex needs to be without the 'slides' path, because
246249
# on the tempfs, the relative path work without
@@ -333,6 +336,9 @@ if __name__ == "__main__":
333336
]
334337
opj = os.path.join
335338

339+
if args.sample_directory == "_": # will skip producing a zip file
340+
sys.exit(0)
341+
336342
for root, dirs, files in os.walk(args.sample_directory):
337343
for fname in files:
338344
# restrict to sample files, no helper files

setup_creators/condarc_mogon

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
create_default_packages:
2-
- setuptools
31
channels:
42
- conda-forge
53
- bioconda

slides/Snakemake_HPC_Admins.tex

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@
2020

2121
\subtitle{<+++ if course.subtitle is defined +++><++course.subtitle++><+++else+++>Providing DataAnalytics Service<+++endif+++> - <++course.edition++>}
2222

23+
\ifdefined\ishandout
24+
\AddToHook{shipout/foreground}{
25+
\begin{tikzpicture}[remember picture,overlay]
26+
\node[red,rotate=10,scale=1,opacity=0.7] at (current page.center) {\footnotesize Handout from Snakemake Teaching Alliance by <++instructor.name++>};
27+
\end{tikzpicture}
28+
}
29+
\fi
30+
2331
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2432
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2533
\begin{document}

slides/Snakemake_HPC_Creators.tex

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@
2020

2121
\subtitle{<+++ if course.subtitle is defined +++><++course.subtitle++><+++else+++>Programming<+++endif+++> - <++course.edition++>}
2222

23+
\ifdefined\ishandout
24+
\AddToHook{shipout/foreground}{
25+
\begin{tikzpicture}[remember picture,overlay]
26+
\node[red,rotate=10,scale=1,opacity=0.7] at (current page.center) {\footnotesize Handout from Snakemake Teaching Alliance by <++instructor.name++>};
27+
\end{tikzpicture}
28+
}
29+
\fi
30+
2331

2432
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2533
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

slides/Snakemake_HPC_User_Creator_Combi.tex

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,11 @@
2121
\subtitle{<+++ if course.subtitle is defined +++><++course.subtitle++><+++else+++>Programming and Deployment<+++endif+++> - <++course.edition++>\newline by <++instructor.name++>}
2222

2323
\ifdefined\ishandout
24-
\usepackage{background}
25-
\backgroundsetup{
26-
placement=center,
27-
angle=30,
28-
scale=1,
29-
contents={\footnodesize Handout from Snakemake Teaching Alliance by <++instructor.name++>},
30-
opacity=1
24+
\AddToHook{shipout/foreground}{
25+
\begin{tikzpicture}[remember picture,overlay]
26+
\node[red,rotate=10,scale=1,opacity=0.7] at (current page.center) {\footnotesize Handout from Snakemake Teaching Alliance by <++instructor.name++>};
27+
\end{tikzpicture}
3128
}
32-
\setbeamertemplate{background}{\BgMaterial}
3329
\fi
3430

3531
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

slides/Snakemake_HPC_Users.tex

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@
2020

2121
\subtitle{<+++ if course.subtitle is defined +++><++course.subtitle++><+++else+++>Deployment<+++endif+++> - <++course.edition++>}
2222

23+
\ifdefined\ishandout
24+
\AddToHook{shipout/foreground}{
25+
\begin{tikzpicture}[remember picture,overlay]
26+
\node[red,rotate=10,scale=1,opacity=0.7] at (current page.center) {\footnotesize Handout from Snakemake Teaching Alliance by <++instructor.name++>};
27+
\end{tikzpicture}
28+
}
29+
\fi
30+
2331
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2432
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2533
\begin{document}

version.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.1.2
1+
1.2.0

0 commit comments

Comments
 (0)