https://github.com/christopher-wild/fair4rs-packaging

https://github.com/christopher-wild/fair4rs-packaging

english fair lesson packaging pre-alpha

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/christopher-wild/fair4rs-packaging
• Owner: christopher-wild
• License: other
• Created: 2024-04-02T08:21:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-10T01:47:06.000Z (over 1 year ago)
• Last Synced: 2025-01-20T01:26:42.506Z (over 1 year ago)
• Topics: english, fair, lesson, packaging, pre-alpha
• Homepage: https://christopher-wild.github.io/FAIR4RS-Packaging/
• Size: 4.82 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
[![pages-build-deployment](https://github.com/christopher-wild/FAIR4RS-Packaging/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/christopher-wild/FAIR4RS-Packaging/actions/workflows/pages/pages-build-deployment)

# Research Software Documentation

This repository contains a course on documenting research software that is part of the [training provision for research computing](https://sites.google.com/sheffield.ac.uk/research-training/) at the University of Sheffield.

## Course description

Research software is increasingly becoming a key and fundamental part of research. There is a growing recognition that research software would benefit from adhering to the FAIR principles, which is the main motivation behind the FAIR4RS (Findable, Accessible, Interoperable, Reusable for Research Software) principles. This is an extension of the FAIR principles, which acknowledges the applicability of the FAIR approach to research software. Software packaging has many benefits, such as enabling your research software to be discovered, installed, and utilised with ease.  This course will explore the fundamental concepts of FAIR4RS, how it applies to packaging, its execution within Python, and the adoption of best practices in this domain.

## Course overview

This course introduces the importance of packaging in the context of research software reproducibility. In particular, the course outline is:

1. Overview FAIR4RS and Software Packaging

2. History of Python Packaging

3. Accessing Packages

4. Versioning

5. Publishing Python Packages

## Prerequisites

- Basic understanding of Python

- Version control/GitHub

# Contact us

Please contact [Research & Innovation IT](https://sheffield.ac.uk/it-services/research) or [Research Software Engineering](https://rse.shef.ac.uk/) at the University of Sheffield.