Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: SE-UP
  • License: other
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 31.6 MB
Statistics
  • Stars: 5
  • Watchers: 2
  • Forks: 1
  • Open Issues: 9
  • Releases: 0
Created over 2 years ago · Last pushed 8 months ago
Metadata Files
Readme License Code of conduct Citation

README.md

Research Software Engineering - University of Potsdam

Welcome to our interactive online course on Research Software Engineering. This course was created by the Software Engineering Group at the University of Potsdam, Germany. The contents of the course was assembled from different sources. As inspiration and main source material the Research Software Engineering with Python by Irving et al. was used.

We have incorporated all the material from the Merely Useful book adjusted or expanded them when needed and added additional topics. These include the chapters and sections on:

  • Licensing and FAIR
  • Requirements, Architectures and Software Design
  • Workflows
  • Workflows - Snakemake
  • Workflows - CI/CD

Some of the tutorials used were taken from the Carpentries and adjusted. While the material will always remain a work in progress, we hope that using this course students and researchers will have a great experience getting into research software engineering!

The course is taught in person every summer term at the University of Potsdam by Prof. Anna-Lena Lamprecht, and this online, publicly available course material will be used by the students as reference material.

Project assignment and course Schedule of 2024 term can be found on our University of Potsdam Gitlab instance right here.

The course itself concists of lectures and 2 project assignments, one individual and one group project.

PLEASE NOTE currently still a WIP!

[ ] CICD SECTION -> problems with RUNNER on University Instance

The source material for our iteration of the work can be cited as: bib @book{rse-py, author = {Damien Irving and Kate Hertweck and Luke Johnston and Joel Ostblom and Charlotte Wickham and Greg Wilson}, title = {Research Software Engineering with Python: Building Software that Makes Research Possible}, publisher = {CRC Press/Taylor and Francis}, year = {2021}, isbn = {978-0367698348}, link = {https://merely-useful.tech/py-rse/} }

Course Work

  1. Small Indiviual Project (2-3 weeks)
  2. Larger Group Project (~4 People) (6 weeks)

Other helpful referencens

License

This work has been licenced under the Creative Commons Attribution 4.0 International license (CC-BY-4.0) found here.

Software has been licensed under the MIT License found here

Contributor Covenant

Owner

  • Name: University of Potsdam, Software Engineering Group
  • Login: SE-UP
  • Kind: organization
  • Email: anna-lena.lamprecht@uni-potsdam.de
  • Location: Germany

Software Engineering Group. (chair: Prof. Dr. Anna-Lena Lamprecht), Institute of Computer Science and Informatics, University of Potsdam.

GitHub Events

Total
  • Issues event: 9
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 109
  • Pull request event: 4
  • Fork event: 2
  • Create event: 1
Last Year
  • Issues event: 9
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 109
  • Pull request event: 4
  • Fork event: 2
  • Create event: 1

Dependencies

.github/workflows/deploy.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • peaceiris/actions-gh-pages v3 composite
requirements.txt pypi
  • datascience *
  • jupyter-book *
  • numpy *
  • sphinx-multitoc-numbering *
zipf/requirements.txt pypi
  • matplotlib *
  • numpy *
  • pandas *
  • pytest *
  • pyyaml *
  • scipy *
zipf/setup.py pypi
  • matplotlib *
  • pandas *
  • pytest *
  • pyyaml *
  • scipy *
zipf/snakemake/requirements.txt pypi
  • matplotlib *
  • numpy *
  • snakemake *
environment.yml conda
  • numpy
  • pip
  • python
zipf/environment.yml conda