Data

Tools

Indexes

Applications

Experiments

Open Source Science

fair4rs-packaging

An interactive course on software packaging for researchers developed by the Research Software Engineering team and IT Services at the University of Sheffield.

https://github.com/fair2-for-research-software/fair4rs-packaging

Science Score: 52.0%

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

  • ✓
    CITATION.cff file
    Found 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
    Organization fair2-for-research-software has institutional domain (rse.shef.ac.uk)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (6.3%) to scientific vocabulary

Keywords

english fair lesson packaging pre-alpha
Last synced: 6 months ago · JSON representation ·

Repository

An interactive course on software packaging for researchers developed by the Research Software Engineering team and IT Services at the University of Sheffield.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
english fair lesson packaging pre-alpha
Created almost 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Security

README.md

pages-build-deployment

Research Software Packaging

This repository contains a course on packaging research software that is part of the training provision for research computing 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 or Research Software Engineering at the University of Sheffield.

Owner

  • Name: UoS FAIR2 for research software
  • Login: FAIR2-for-research-software
  • Kind: organization
  • Email: rse@sheffield.ac.uk

Training in FAIR (Findable, Accessible, Interoperable, Reusable) and Reproducible research software skills at the University of Sheffield

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Git Collaboration
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Chris
    family-names: Wild
    email: c.wild@sheffield.ac.uk
    affiliation: University of Sheffield
    orcid: 'https://orcid.org/0009-0009-1195-1497'
url: 'https://github.com/FAIR2-for-research-software/FAIR4RS-Packaging'
abstract: >-
  A Carpentry based, intermediate level course on packaging software
keywords:
  - packaging
  - python
  - carpentries
license: CC-BY-4.0

GitHub Events

Total
  • Issues event: 12
  • Delete event: 12
  • Issue comment event: 10
  • Push event: 74
  • Pull request review comment event: 1
  • Pull request review event: 5
  • Pull request event: 10
  • Create event: 7
Last Year
  • Issues event: 12
  • Delete event: 12
  • Issue comment event: 10
  • Push event: 74
  • Pull request review comment event: 1
  • Pull request review event: 5
  • Pull request event: 10
  • Create event: 7

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 20
  • Total pull requests: 19
  • Average time to close issues: 8 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 2.4
  • Average comments per pull request: 1.11
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 20
  • Pull requests: 19
  • Average time to close issues: 8 months
  • Average time to close pull requests: 2 months
  • Issue authors: 4
  • Pull request authors: 3
  • Average comments per issue: 2.4
  • Average comments per pull request: 1.11
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • f-allian (1)
Pull Request Authors
  • christopher-wild (4)
  • f-allian (3)
  • tdjames1 (2)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels
type: template and tools (3) enhancement (3)