{"id":42926742,"url":"https://github.com/coderefinery/research-software-engineering","last_synced_at":"2026-01-30T18:10:39.337Z","repository":{"id":187063733,"uuid":"673056471","full_name":"coderefinery/research-software-engineering","owner":"coderefinery","description":"\"CodeRefinery in 1 hour\" - What are good tools and practices in research software engineering?","archived":false,"fork":false,"pushed_at":"2025-07-11T15:54:17.000Z","size":7716,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-10T04:44:27.466Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://coderefinery.github.io/research-software-engineering/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coderefinery.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-07-31T19:12:40.000Z","updated_at":"2024-10-04T08:51:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"e0ce5ebc-4e31-4d51-aecf-67ef05827cf8","html_url":"https://github.com/coderefinery/research-software-engineering","commit_stats":null,"previous_names":["coderefinery/research-software-engineering"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/coderefinery/research-software-engineering","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fresearch-software-engineering","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fresearch-software-engineering/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fresearch-software-engineering/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fresearch-software-engineering/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coderefinery","download_url":"https://codeload.github.com/coderefinery/research-software-engineering/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fresearch-software-engineering/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28917035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T16:37:38.804Z","status":"ssl_error","status_checked_at":"2026-01-30T16:37:37.878Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-30T18:10:38.631Z","updated_at":"2026-01-30T18:10:39.330Z","avatar_url":"https://github.com/coderefinery.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8242054.svg)](https://doi.org/10.5281/zenodo.8242054)\n\n# Research software engineering (\"CodeRefinery in 1 hour\")\n\n\"CodeRefinery in 1 hour\" - What are good tools and practices in research software engineering?\n\n- [Latest presentation slides](https://cicero.xyz/v3/remark/0.14.0/github.com/coderefinery/research-software-engineering/main/presentation.md/)\n- [Published presentation slides](https://doi.org/10.5281/zenodo.8242054)\n- [Exercise repository](https://coderefinery.github.io/research-software-engineering/)\n\n---\n\n## Overview\n\n- What is \"research software\"?\n- CodeRefinery\n- 6 most important topics? (in the HPC context)\n- Exercises (separate webpage)\n\n\n## Version control\n\n- Motivation for version control\n- Commits: keeping track of changes\n- Features: roll-back, branching, merging, collaboration\n- Reproducibility\n- Talking about code\n- Collaboration through branches or forks\n- Code review\n- Where to start?\n\n\n## Documentation\n\n- Why?\n- Checklist\n- In-code documentation\n- Often a README is enough\n- When projects grow out of a README\n\n\n## Reproducibility and containers\n\n- 6 helpful steps\n- It all starts with a good directory structure ...\n- Recording dependencies\n- Containers\n- Recording computational steps\n\n\n## Building code with CMake\n\n- Why is Make not enough?\n- CMake is not a build system\n- How do CMakeLists.txt files look?\n- Why CMake?\n\n\n## Automated testing\n\n- Technical possibilities\n- Motivation\n- Where to start\n\n\n## Sharing and reusing\n\n- Why software licenses matter\n- When should I add a license?\n- Is your work derivative work or not?\n- How do I add a license to my work?\n- Make it persistent and citable\n- Great resources\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderefinery%2Fresearch-software-engineering","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderefinery%2Fresearch-software-engineering","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderefinery%2Fresearch-software-engineering/lists"}