{{indexmenu_n>20}} ====== Supplementary Resources ====== This page contains useful supplementary resources and tools useful for research and training. Note that this list is not intended to be complete but rather a best practise that we found useful. However, for tools we provide references to alternatives as every person has its own style. Suggestions are welcome, too. ===== Templates ===== Georg-August-Universität Göttingen LaTeX templates for reports, presentations and theses available under CC-BY-SA 4.0 can be found here:\\ Version 1.2.2 (2026-04-23) - {{ :teaching:templates:template_hps_report.zip |Report Template}}\\ Version 2.3.4 (2024-07-12) - {{ :teaching:templates:template_hps_presentation.zip |Presentation Template}}\\ Version 1.5.2 (2026-04-23) - {{ :teaching:templates:template_thesis.zip |Thesis Template}} The templates are provided as ZIP files. Uni Göttingen students can use [[https://cocalc.gwdg.de/|CoCalc]]. On the CoCalc website, create a new project and select "customize the software environment", then select "TeXLive" from the dropdown menu. Wait for the project to be ready and the drag and drop the zip files into the webpage to upload them. From there you can click on them to get to a screen for unpacking each zip file. Navigate the explorer and click on the respective main tex file to start editing. Older templates for presentations, reports, theses, and letters can be found on our [[https://git.hps.vi4io.org/julian.kunkel/reading-templates|repository]]. They also contain some supplementary information on how to use and structure accordingly. ===== Training of Concepts ===== The following contains principles and concepts we found useful, tools are described separately. ==== The role of supervisor and student ==== * [[https://www.reading.ac.uk/essentials/The-Important-Stuff/Student-charter|The student charter from Reading]] ==== Communication ==== * [[https://www.helpguide.org/articles/relationships-communication/effective-communication.htm|Effective communication]] ==== Stress ==== * [[https://www.helpguide.org/articles/stress/stress-symptoms-signs-and-causes.htm|Stress symptoms]] * [[https://www.helpguide.org/articles/stress/stress-in-the-workplace.htm|Stress at the workplace]] * [[https://www.helpguide.org/articles/stress/stress-management.htm|Stress management]] * [[https://student.reading.ac.uk/essentials/_support-and-wellbeing.aspx|Wellbeing help at the University of Reading]] * [[https://web.archive.org/web/20221002233831/https://onlinelearning.ucl.ac.uk/resources/managing-workplace-stress-anxiety/|How to tackle mental health in the workplace as a manager and colleague]]: provides also further links for mental health * [[https://counseling.northwestern.edu/blog/sleep-hygiene-mental-health/|Understanding Sleep Hygiene and Mental Health]] * [[https://sleepopolis.com/education/stress/|How to Manage Stress for Better Sleep]] * [[https://www.helpguide.org/articles/sleep/getting-better-sleep.htm|How to Sleep Better]] * [[https://greator.com/resilienz/|Resilienz to stress]] * [[https://www.comparethemarket.com/mortgages/content/achieve-a-work-life-balance-working-from-home/#adjusting-to-working-at-home|Adjusting to working from home]] ==== Soft Skills ==== * [[https://novoresume.com/career-blog/interpersonal-skills|28+ Top Interpersonal Skills in 2022]] ==== Life Style ==== * [[https://sites.reading.ac.uk/sustainability/travel/cycling/|Cycling to the university]] * [[https://sites.reading.ac.uk/sustainability/|Sustainability]] ==== Review ==== * [[https://www.nature.com/natcomputsci/for-reviewers|Paper review criteria from Nature]] ==== Academic writing ==== === General === * [[https://gipplab.org/teaching/scientific_writing/|Video Guides on Literature Search, Management and Thesis Writing]] * [[https://www.uni-goettingen.de/de/223832.html|Gute wissenschaftliche Praxis]] * [[https://pbs.twimg.com/media/D3x7RDzX4AAEEiw.jpg|How to write a paper in 10 steps]] * See the support guides form the [[https://web.archive.org/web/20210416110528/https://www.reading.ac.uk/library/study-advice/guides/lib-sa-guides.aspx|University of Reading Study Advice]] * Record your experiments and summarize early all your effort as writing helps to learn [[https://writingcooperative.com/write-to-learn-not-just-to-communicate-b881fe51acba|further reading]]. * Be open and allow reproducible research. See [[http://www.reading.ac.uk/research/research-environment/open-research/open-research-12-tips.aspx|12 Things you can do to be open]]. * Use version control (Git, see below) to record your development and push the repository to have a backup * [[https://en.wikipedia.org/wiki/Academic_integrity|Academic Ethics]] * [[https://www.editage.com/insights/the-secret-to-using-tenses-in-scientific-writing|Tenses]] * [[https://iupac.org/cms/wp-content/uploads/2016/01/ICTNS-On-the-use-of-italic-and-roman-fonts-for-symbols-in-scientific-text.pdf|Math / Symbols in text]] * [[https://web.archive.org/web/20230128040148/https://www.cbs.umn.edu/sites/default/files/public/downloads/Annotated_Nature_abstract.pdf|(Relatively strict) instructions for writing an introduction]] * [[https://www.science.org/content/page/instructions-preparing-initial-manuscript|Example instructions for preparing a paper (for science.org)]] === Content === * [[https://www.research-integrity.admin.cam.ac.uk/research-integrity/guidelines/guidelines-authorship|Authorship]] * [[https://elc.polyu.edu.hk/fyp/html/ack.htm|Acknowledgement]], [[http://www.apa.org/science/leadership/students/authorship-paper.pdf|Authorship longer]] * [[https://www.libraries.rutgers.edu/sites/default/files/copyright/Guidelines-on-Using-Previously-Published-Work-in-Theses-and-Dissertations.pdf|Using previously published work in theses and dissertations (Rutgers School of Graduate Studies)]] * [[https://www.editage.com/insights/manuscript-structure-how-to-convey-your-most-important-ideas-through-your-paper|Structure]] * [[https://wordvice.com/journal-article-author-order/|Author ordering; prefer contribution order]] === Style === * [[https://web.archive.org/web/20220622015418/http://web.cn.edu/kwheeler/documents/Lit_Citation_Problems.pdf|Citations]] * Which pronouns to use in the thesis (Use 'We' even in single author works when talking about contributions, use I when expressing personal opinion, avoid passive generally): [[https://archive.org/details/springer_10.1007-978-0-85729-422-7/page/n25/mode/2up?q=we|Justin Zobel Writing for Computer Science p14]] ==== Literature research ==== * Check [[https://link.springer.com/search?facet-content-type=%22Book%22&package=openaccess&facet-discipline=%22Computer+Science%22|Open Access Books]] ==== Presentations ==== * [[https://www.youtube.com/watch?v=NrahVjkUFls|Jonathan Decker - Scientific Presentation]] * [[https://www.skillsyouneed.com/present/presentation-tips.html|Tips]] * There exist various [[https://24slides.com/presentbetter/6-presentation-styles-famous-presenters/|styles]]; depending on the aim of the presentation few are effective * [[https://youtu.be/Unzc731iCUY|Prof. Winston Lecture "How to Speak"]] ==== Data visualization ==== ==== Self esteem ==== * [[https://www.becomingminimalist.com/a-thoughtful-guide-to-gaining-self-confidence/|Gaining self confidence]] * [[https://www.gov.uk/government/publications/the-7-principles-of-public-life/the-7-principles-of-public-life--2|The 7 principles of public life]] * [[https://zenhabits.net/the-ultimate-guide-to-motivation-how-to-achieve-any-goal/|Motivation: How to achieve any goal]] ==== Project management ==== * See Julian's {{ :teaching:project-management.pdf |own primer}} to lightweight project management, which contains an honest reflection of his experience and the way he handles projects (created using Pandoc). ==== Time management ==== The success of any non-trivial endeavours depend on proper time and project management. * See also Julian's {{ :teaching:project-management.pdf |primer to project management}} which contains an honest reflection of his experience. * [[https://www.findaphd.com/advice/doing/average-phd-week.aspx|An average PhD week]] ==== Coding ==== * [[https://en.wikipedia.org/wiki/Agile_software_development|Agile development]] * [[https://en.wikipedia.org/wiki/Test-driven_development|Test-driven development]] * [[https://nvie.com/posts/a-successful-git-branching-model/|Git-Flow for collaboration]] * [[https://open.kattis.com/problems/|Coding problems for gaining practice]] ==== HPC ==== * [[https://web.archive.org/web/20210705015727/https://pages.tacc.utexas.edu/~eijkhout/Articles/EijkhoutIntroToHPC.pdf|Introduction to HPC]] ===== Tools ===== The following is a list of tools we use. We welcome suggestions to improve this list. ==== Notebook ==== Recording your progress and experiments is key to success and reproducibility. * [[https://docs.google.com|Google Doc]] for the joint recording of meetings and progress * [[http://jupyter.org/|Jupyter notebook]] allows embedding description, experiment (data analysis), result and conclusion into one notebook. ==== Report ==== * [[https://www.overleaf.com/learn/latex/Creating_a_document_in_LaTeX|LaTeX]] (see also the template) * Shared editing of documents with [[https://www.overleaf.com/|Overleaf]] === LaTeX === * [[https://github.com/guanyingc/latex_paper_writing_tips|Tips and examples for images and tables in LaTeX]] * [[https://web.archive.org/web/20230715035828/https://camo.githubusercontent.com/90f9e5e90f9fa41b5234849da7866ece1cb6f68bd9fa56013d3642a7a165a2cb/687474703a2f2f6461726b686f727365616e616c79746963732e636f6d2f626c6f672f77702d636f6e74656e742f75706c6f6164732f323031342f30332f436c6561724f66665468655461626c654d642e676966|Tables; Less is More]] * [[https://github.com/Wookai/paper-tips-and-tricks|Best Practices for Papers in LaTeX]] * [[https://capitalizemytitle.com/|Capitalization Styles for Titles]] * [[https://www.tablesgenerator.com/|LaTeX tables from CSV and Google Sheets]] ==== Presentation ==== * [[https://www.overleaf.com/learn/latex/Beamer|LaTeX Beamer]] (see also the UoR template) * To present a PDF: [[https://pdfpc.github.io/|pdfpc]] ==== Graphics ==== * Inkscape (vectors in SVG or PDF) * Gimp (pixel/bitmap data, e.g., png) * Graphviz (for quickly drawing trees) * PlantUML (Graphviz extension) [[http://en.plantuml.com/|drawing software design documents]] ==== Plots ==== * R with the [[https://ggplot2.tidyverse.org/|ggplot2 package]] [[http://r-statistics.co/Top50-Ggplot2-Visualizations-MasterList-R-Code.html|Gallery with examples]] * Python with Matplotlib [[https://matplotlib.org/2.0.2/gallery.html|Gallery with examples]] * Plots in LaTeX with TikZ [[http://www.texample.net/tikz/examples/tag/plots/|Gallery with examples]]; use TikZ with care, though as it is annoying to just produce a single graphics for later modification with e.g. Inkscape. ==== Technical Documentation ==== * [[https://diataxis.fr/|Diataxis Framework]] ==== Coding ==== * [[https://atom.io/|Atom text editor]] for code editing * [[http://www.doxygen.nl/|Doxygen]] for documentation embedded in the code * [[http://www.sphinx-doc.org/|Sphinx]] for documentation in Python code * [[http://en.plantuml.com/|PlantUML]] for embedding UML software design documents in the source code (powered by Doxygen). * [[https://www.docker.com/|Docker]] for test-driven development / testing on different environments * [[http://travis-ci.org/|Travis]] for continous integration (ensuring build process works) * [[https://cmake.org/|CMake]] for building complex projects in C/C++ * [[https://cmake.org/cmake/help/latest/manual/ctest.1.html|ctest (part of CMake)]] to run test harnesses * Ant or Maven for Java (see the discussion [[https://devopscube.com/list-of-popular-open-source-java-build-tools/|here]]). * [[https://www.learnpython.org|Python training]] [[https://codecombat.com/|Learning coding / fun game for beginners]] * [[https://jobtensor.com/Python-Introduction|Interactive Introduction]] ==== Other ==== * Mindmaps with [[https://www.freeplane.org/|Freeplane]] * Version control with [[https://try.github.io/|Git]], e.g., using [[http://www.github.com|GitHub]]