Merge pull request #16 from t4d-gmbh/basic-structure-setup

j-i-l · web-flow · commit 3c78256bcb73 · 2026-02-08T17:02:52.000+01:00
Basic structure setup
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 docs/
 *.nix
 venv/
+venvPSC/
+build.sh
diff --git a/README.md b/README.md
@@ -1,10 +1,22 @@
 # Practical Scientific Computing
 
-A <img src="./source/_static/T4D_logo_bw.svg" alt="T4D" width="25" height="25"> seminar providing the required essentials — and more — to leverage shared resources efficiently.
+A <img src="./_static/T4D_logo.svg" alt="**T4D**" width="35" height="35"> seminar providing the required essentials — and more — to leverage shared resources efficiently.
+
+ <!-- readme-include -->
 
 ---
 
-### Part 1: Utilization of shared resources
+_If you find this course useful, please share it with others! Show your support by giving it a 🌟 using the ⭐-button at the top right of the page._
+
+_By starring the repository, you help increase its visibility, making it easier for others to 🔍 discover and 👩‍🎓 learn how to use Git and its remote services with confidence!_
+
+---
+
+## Content
+
+ <!-- syllabus-include -->
+
+### 1. Part: [Utilizing Shared Resources](https://github.com/t4d-gmbh/utilizingSharedResources)
 
 _For an detailed overveiw see [contentOverview/Part1.md](./contentOverview/Part1.md)_
 
@@ -55,7 +67,7 @@ _For an detailed overveiw see [contentOverview/Part1.md](./contentOverview/Part1
 
 ---
 
-### Part 2: Cloud/Cluster‑ready projects
+### 2. Part: [Research Software Engineering](https://github.com/t4d-gmbh/researchSoftwareEngineering)
 
 _For an detailed overveiw see [contentOverview/Part2.md](./contentOverview/Part2.md)_
 
@@ -89,7 +101,7 @@ _For an detailed overveiw see [contentOverview/Part2.md](./contentOverview/Part2
 
 ---
 
-### Part 3: Clustered computing
+### 3. Part: [Efficient Cluster Computation](https://github.com/t4d-gmbh/efficientClusterComputation)
 
 _For an detailed overveiw see [contentOverview/Part4.md](./contentOverview/Part4.md)_
 
@@ -122,7 +134,7 @@ _For an detailed overveiw see [contentOverview/Part4.md](./contentOverview/Part4
 ---
 
 
-### Part 4: In the Clouds
+### 4. Part: [Efficient Cloud Usage](https://github.com/t4d-gmbh/efficientCloudUsage)
 
 _For an detailed overveiw see [contentOverview/Part3.md](./contentOverview/Part3.md)_
 
@@ -150,4 +162,15 @@ _For an detailed overveiw see [contentOverview/Part3.md](./contentOverview/Part3
 - Learn the pattern of attaching VM/container lifecycles to computational workloads (ephemeral compute).  
 
 
----
+<!-- syllabus-exclude-->
+
+
+## Contributing 🤝🎉
+
+We welcome contributions and suggestions to this material!
+Whether you're fixing bugs 🐛 or typos, adding new features ✨, or improving readability 📚, your help is greatly appreciated!
+
+Before you start, please take a moment to read our [CONTRIBUTING.md](CONTRIBUTING.md) file.
+It contains some details and guidelines 📋 on how to structure new content and best practices to help you get started and ensure that your contributions aligned with the project's goals. 🚀
+
+Thank you for considering contributing to this course! You're awesome! 🌟
diff --git a/source/_static/jonas_github.png b/source/_static/jonas_github.png
diff --git a/source/_static/matteo_github.png b/source/_static/matteo_github.png
diff --git a/source/conf.py b/source/conf.py
@@ -3,7 +3,7 @@
 
 # -- Configuration parameter -------------------------------------------------
 # ----------------------------------------------------------------------------
-repository_owner = "t4d-gmbh"
+repository_owner = "T4D-GmbH"
 repository_name = "PracticalScientificComputing"
 repository_branch = "main"
 # -- optionally adat these
diff --git a/source/content/about/config.md b/source/content/about/config.md
@@ -0,0 +1,5 @@
+## Setup
+
+- Have your laptop ready.
+- Have an account on <i class="fab fa-github"></i> **GitHub** and any <i class="fab fa-gitlab"></i> **GitLab** instance.
+- Configure your <i class="fab fa-github"></i> **GitHub** account so you can use `ssh` (i.e. add an `ssh`-key to your account).
diff --git a/source/content/about/index.md b/source/content/about/index.md
@@ -0,0 +1,29 @@
+# About this Seminar
+
+{% if slide %}
+
+```{card} 🔓 Open Source on Practical Scientific Computing
+:class: tip
+:link: https://github.com/t4d-gmbh/PracticalScientificComputing
+:link-type: url
+
+:::{image} ./qr_psc.png
+:align: center
+:width: 180px
+:alt: QR GitHub Repo.
+:::
+
+**<https://github.com/t4d-gmbh/PracticalScientificComputing>**
+```
+{% endif %}
+
+```{toctree}
+:maxdepth: {% if build == "slides" %}1{% else %}2{% endif %}
+
+./syllabus
+{% if slide %}
+./requirements
+./presenters
+{% endif %}
+```
+_If you like this type of presentation format checkout the [t4d-gmbh/web-course-template](https://github.com/t4d-gmbh/web-course-template)_
diff --git a/source/content/about/knowledge.md b/source/content/about/knowledge.md
@@ -0,0 +1,3 @@
+## Prior knowledge
+
+TODO.
diff --git a/source/content/about/presenters.md b/source/content/about/presenters.md
@@ -0,0 +1,10 @@
+# Presenters
+
+::::{grid}
+:::{grid-item-card} [@j-i-l](https://github.com/j-i-l/)
+![Jonas](./../../\_static/jonas\_github.png)
+:::
+:::{grid-item-card} [@matteodelucchi](https://github.com/matteodelucchi/)
+![Matteo](./../../\_static/matteo\_github.png)
+:::
+::::
diff --git a/source/content/about/qr_psc.png b/source/content/about/qr_psc.png
diff --git a/source/content/about/requirements.md b/source/content/about/requirements.md
@@ -0,0 +1,8 @@
+# Requirements
+
+```{include} ./knowledge.md
+```
+```{include} ./config.md
+```
+
+
diff --git a/source/content/about/syllabus.md b/source/content/about/syllabus.md
@@ -0,0 +1,34 @@
+{% if page %}
+# Syllabus
+{% else %}
+# Schedule
+{% endif %}
+
+{% if page %}
+```{include} ../../../README.md
+:start-after: <!-- syllabus-include -->
+:end-before: <!-- syllabus-exclude-->
+```
+{% else %}
+:::{card} Day 1
+1. Part: **[Utilizing Shared Resources](https://github.com/t4d-gmbh/utilizingSharedResources)**
+
+---
+Lunch (12:30-13:30). 
+
+---
+2. Part: **[Research Software Engineering](https://github.com/t4d-gmbh/researchSoftwareEngineering)**
+
+:::
+:::{card} Day 2
+3. Part: **[Efficient Cluster Computation](https://github.com/t4d-gmbh/efficientClusterComputation)**
+
+---
+Lunch (12:30-13:30). 
+
+---
+
+4. Part: **[Efficient Cloud Usage](https://github.com/t4d-gmbh/efficientCloudUsage)**
+:::
+{% endif %}
+
diff --git a/source/content/index.md b/source/content/index.md
@@ -1,7 +1,7 @@
 ```{toctree}
 :maxdepth: {% if build == "slides" %}1{% else %}2{% endif %}
 
-howto/index
+about/index
 ```
 ```{toctree}
 :maxdepth: {% if build == "slides" %}1{% else %}2{% endif %}
diff --git a/source/content/outro/about.md b/source/content/outro/about.md
@@ -0,0 +1,44 @@
+## About
+:::::{grid} 12
+:gutter: 3
+
+::::{grid-item-card}
+:columns: 4
+:class-header: sd-bg-warning sd-text-white
+:link: https://github.com/t4d-gmbh
+:link-type: url
+
+:::{image} ./logo_v3_with_text.png
+:align: center
+:width: 100%
+:alt: GitHub Org page
+:::
+::::
+
+::::{grid-item-card} {octicon}`info;1em` We:
+:columns: 8
+:class-header: sd-bg-warning sd-text-white
+
+- {octicon}`mortar-board;1em` give courses about **good computational practices**
+- {octicon}`comment-discussion;1em` consult & support in **data science** and **machine learning**
+- {octicon}`heart;1em` love to write **open source software**
+
+**{octicon}`search;1em` Find us:**
+
+- **<https://github.com/t4d-gmbh>**
+- <i class="fa-brands fa-linkedin"></i> [linkedin.com/company/t4d-gmbh](https://www.linkedin.com/company/t4d-gmbh/)
+- {octicon}`globe;1em` [t4d.ch](https://t4d.ch)
+- {octicon}`location;1em` Zurich (CH) & Lisba (PT)
+::::
+:::::
+
+:::::{grid} 1 1 1 1
+:gutter: 3
+
+::::{grid-item-card} {octicon}`code-of-conduct;1em` Please reply!
+:columns: 12
+:class-header: sd-bg-warning sd-text-white
+
+You will {octicon}`mail;1em` receive an invitation to fill out a course questionnaire, please **take the {octicon}`history;1em` 10' and help us to improve this course**!
+::::
+:::::
diff --git a/source/content/outro/content.md b/source/content/outro/content.md
@@ -0,0 +1,25 @@
+## Content
+
+::::{grid} 2 2 2 2
+:gutter: 3
+
+:::{grid-item-card} {octicon}`globe;1em` Resources
+:class-header: sd-bg-warning sd-text-white
+
+**<https://github.com/t4d-gmbh/using-git-in-academia>**  
+**<https://github.com/t4d-gmbh/weekend-out>**  
+**<https://gitlab.com/t4d-gmbh/teaching/gitws/latex-article>**  
+**<https://gitlab.com/t4d-gmbh/teaching/exemplaryanalysis>**  
+
+:::
+
+:::{grid-item-card} {octicon}`gift;1em` Goodies
+:class-header: sd-bg-warning sd-text-white
+
+**<https://github.com/t4d-gmbh/web-course-template>**   
+**<https://github.com/matteodelucchi/latex-article-template>**  
+**<https://gitlab.com/t4d-gmbh/templates/latex-article-template>**  
+**<https://gitlab.com/t4d-gmbh/templates/python-project>**  
+
+:::
+::::
diff --git a/source/content/outro/index.md b/source/content/outro/index.md
@@ -0,0 +1,23 @@
+# Outro
+
+{% if slide %}
+
+```{toctree}
+:maxdepth: {% if build == "slides" %}1{% else %}2{% endif %}
+
+./content
+./instructors
+./about
+```
+{% else %}
+```{include} ./content.md
+```
+```{include} ./instructors.md
+```
+```{include} ./about.md
+```
+{% endif %}
+
+
+
+
diff --git a/source/content/outro/instructors.md b/source/content/outro/instructors.md
@@ -0,0 +1,32 @@
+## Instructors
+
+:::::{grid} 2 2 2 2
+:gutter: 3
+
+::::{grid-item-card} {octicon}`person;1em` Matteo Delucchi
+:class-header: sd-bg-warning sd-text-white
+:link: https://github.com/matteodelucchi
+:link-type: url
+
+:::{image} ./../../\_static/matteo\_github.png
+:align: center
+:width: 80%
+:alt: Screenshot Matteo
+:::
+
+::::
+
+::::{grid-item-card} {octicon}`person;1em` Jonas Liechti
+:class-header: sd-bg-warning sd-text-white
+:link: https://github.com/j-i-l
+:link-type: url
+
+:::{image} ./../../\_static/jonas\_github.png
+:align: center
+:width: 80%
+:alt: Screenshot Jonas
+:::
+
+::::
+:::::
+
diff --git a/source/content/outro/logo_v3_with_text.png b/source/content/outro/logo_v3_with_text.png
diff --git a/source/index.md b/source/index.md
