Categories

All (89)

4TU (2)

Apache (1)

Architecture (1)

Archive (4)

Automation (5)

Bastion Host (1)

Branches (2)

C4 (1)

Changelog (1)

Checklist (1)

CI/CD (5)

Citation (1)

Code comments (1)

Code Coverage (1)

Code of Conduct (1)

Code Quality (4)

Code Style (2)

Collaboration (4)

Collection (1)

conda (2)

Contributing Guidelines (1)

CRAN (2)

Cybersecurity (2)

Data (21)

Data Access (2)

Data Backup (2)

Data Conventions (2)

Data Processing (1)

Data Reuse (2)

Data Security (2)

Data Sharing (2)

Dead Code (1)

Deep Nesting (1)

Dependencies (4)

Design (1)

devtools (1)

DMP (1)

Docker (1)

Docstrings (1)

Documentation (12)

Duplicated Code (1)

eLabJournal (2)

ELN (1)

Environments (4)

FAIR (3)

Forks (1)

Getting Started (3)

Git Submodules (1)

Git Subtree (1)

Gitflow (1)

GitHub (3)

GitHub Flow (2)

GitHub Pages (1)

GitLab (4)

Hard-coding (1)

Hosting (1)

Infrastructure (7)

Issues (1)

JupyterBook (1)

Large Classes (1)

Licenses (3)

Long Methods (1)

Management (1)

Many Arguments (1)

MATLAB (6)

MkDocs (1)

Network Drives (1)

Nginx (1)

Offboarding (2)

Ownership (2)

Package (7)

pkgdown (1)

Planning (1)

Privacy (2)

Project Board (1)

Project Data Storage (3)

Project Management (1)

Project Organization (5)

Publish (2)

Pull Requests (1)

PyPI (2)

pyproject.toml (2)

Python (9)

Quarto (1)

R (9)

Read the Docs (1)

README (1)

Refactoring (12)

Release (6)

renv (1)

Repository Structure (2)

roxygen2 (2)

RSpace (2)

SCP (2)

SemVer (1)

Servers (6)

Side Effects (1)

SMP (1)

Snakemake (1)

Software (62)

Sphinx (1)

SSH Keys (1)

SSH Tunneling (1)

Storage (7)

Templates (1)

Testing (7)

TestPyPI (1)

Tight Coupling (1)

usethis (1)

uv (2)

venv (1)

Version Control (5)

Vignettes (1)

virtualenv (1)

VPS (5)

Workflow Management (1)

Zenodo (2)

Catalogue

While the search functionality (top right corner) provides easy access to a particular guide searching by keywords, you can also use this listings page (catalogue) to explore all available guides across all topics.

Each guide has keywords at the top, and these are clickable. Clicking on a category will bring you back to this page filtered to relevant guides. You can either browse by category using the filters on the right, sort by title or date, or use the search box to find specific topics of interest.

Access and reuse

Access and reuse of your data

Accessing and requesting Project Data Storage space

Project Data Storage

Instructions for accessing and requesting Project Data Storage space at TU Delft

Archiving

Archiving research software for long-term preservation

Archiving and publishing data

Overview of end-of-cycle data archiving and publishing practices

Automation for software development

Automating software development with CI/CD pipelines

Branch management

Version Control

Branching strategies for Git-based development workflows

CI with GitLab

Setting up a GitLab runner in a Docker container on a TU Delft VPS

CITATION.cff

How to cite software

Code documentation

Documenting your code for users and developers

Code of conduct

Code of Conduct

A code of conduct establishes expectations for behavior within your project’s community

Code quality

Overview of code quality tools and services

Code smells

Overview of common code smells and how to address them

Code style and tools

Overview of code style guides, static analysis tools, and formatters

Collaboration

Version Control

Software collaboration practices and version control concepts

Configure SSL/TLS certificates

Requesting and configuring SSL certificates on TU Delft VPS

Connecting to remote servers

Secure connection to TU Delft virtual servers using SSH (Linux) or RDP (Windows)

Contributing guidelines

Contributing Guidelines

Guidelines for contributing to a software project

Creating a Python package

Creating and configuring a Python package using pyproject.toml

Creating an R package

Creating an R package

Data backup

Guidelines for backing up research data

Data collection

Data Conventions

Overview of data collection practices, conventions, access/reuse, and TU Delft tools like eLabJournal and RSpace

Data conventions

Data Conventions

Guidelines for data naming conventions, folder structures, and file standards

Data licensing

Overview of data licenses

Data processing

Data Processing

Version Control

Overview of data processing and version control

Data security

Ensuring the security of research data at TU Delft

Data sharing

Sharing research data at TU Delft

Data storage

Overview of data storage solutions and practices at TU Delft

Dead code

Identifying and eliminating dead code and commented-out sections through refactoring

Deep Nesting

Deep nesting occurs when there are too many levels of indentation in the code, making it difficult to read and understand the code structure

Development workflow

Version Control

Project Organization

Best practices for your software development workflow

Documentation

Overview of software documentation practices and tools

Duplicated code

Duplicated Code

Fixing duplicated code in your codebase

Environment and dependency management

Project Organization

Managing environments and dependencies for reproducibility

Environment and dependency management in MATLAB

Managing environments and dependencies in MATLAB projects

Environment and dependency management in Python

Managing environments and dependencies in Python projects

Environment and dependency management in R

Managing R projects with renv

FAIR Software

Overview of FAIR principles applied to research software

FAIR checklist for research software

Checklist for ensuring FAIR principles in research software development

FAIR data

Overview of the FAIR data principles

Getting started

Getting Started

Introduction to research data management and available resources at TU Delft

Getting started

Getting Started

Introduction to research software development and best practices

Getting started

Getting Started

Introduction to computing infrastructure resources at TU Delft

GitHub Actions

GitHub Actions workflows for automating software development

GitLab pipelines

GitLab CI/CD pipelines for automating software development

Hard coding

Explanation of hard coding and how to address it

Hosting

Hosting your documentation online

Inappropriate Intimacy

Classes are too closely coupled, leading to reduced maintainability

Large Classes

Large classes that try to handle too many responsibilities are hard to understand, maintain, and test

Long Method

Refactor long methods into smaller, more focussed functions

MATLAB documentation

Documentation practices for MATLAB projects

Many arguments

Functions with too many parameters are hard to understand, maintain, and test

More testing concepts

Additional concepts for software testing

Mount Project Drive on server

Project Data Storage

Instructions for mounting a TU Delft Project Drive on a VPS

Offboarding and ownership

Procedures and best practices for offboarding and data ownership

Online services

Overview of code quality and security tools and practices

Packaging

Packaging Python and R projects for distribution

Packaging, releases and archiving

Overview of packaging, releasing, and archiving research software

Planning

Overview of data management planning at TU Delft

Privacy

Overview of privacy considerations when handling sensitive data

Project management

Version Control

Project Management

Managing your software with version control

Project structure

Project Organization

Repository Structure

Structure your software for reproducibility and maintainability

Project templates and reusability

Project Organization

Repository Structure

How to reuse existing projects and templates

Publishing data

Overview of data repositories

Python code documentation

Documentation practices for Python projects

R documentation

Documenting R code with roxygen2

README

Writing a good README

Refactoring

Overview of refactoring code practices

Release your Python package

Releasing your Python package on PyPI

Release your R package

Releasing your R package on CRAN

Releases

Software release practices and platforms

Remote Servers

Virtual and physical servers at TU Delft

Request a VPS

Requesting and configuring a TU Delft Virtual Private Server

Setting up a GitLab runner for MATLAB

Setting up a GitLab runner for MATLAB environments in TU Delft GitLab

Side effects and external state

Functions that modify external state or interact with the outside world beyond returning a value, making code harder to understand, test, and maintain

Software design principles

Designing research software

Software licenses

Licensing software developed at TU Delft

Software management plan

Creating a software management plan

Software testing

Overview of software testing practices and strategies

Storage options

Project Data Storage

Data storage options at TU Delft

Testing in MATLAB

Writing and running tests with MATLAB

Testing in Python

Writing and running tests in Python

Testing in R

Writing and running tests in R

Testing strategy

Guidelines for researchers new to testing and experienced test writers.

Tooling

Overview of software documentation tooling

Transferring data to and from remote servers

Secure data transfer to and from TU Delft virtual servers using scp (Linux) or Network Drives (Windows)

Types of tests

Different types of tests to ensure your software works as expected

Web Servers

Web servers on TU Delft infrastructure

Workflow management

Project Organization

Workflow Management

Managing computational workflows in research software

eLabJournal and RSpace

Overview of eLabJournal and RSpace electronic laboratory notebooks available at TU Delft