Data

Tools

Indexes

Applications

Experiments

Open Source Science

fair4containers

https://github.com/aleem2/fair4containers

Science Score: 67.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
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: Aleem2
  • License: bsd-2-clause
  • Language: Dockerfile
  • Default Branch: master
  • Size: 44.9 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 3
Created over 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation

README.md

FAIR for Containers: A Practical Guide

This repository serves as an example for creating a FAIR Container. The Dockerfile captures the build script of a container including the dependencies. This characteristic of a container makes it possible to reproduce the exact environment. Hence covering the R component of FAIR principals. While the rest of the FAIR principals are aligned with FAIR for Research Software.

The key things this guide addresses in making containers FAIR is as follows: 1. This guide illustrates how a researcher can get their work cited by using a Citation.cff file. 2. It shows how a license can be assigned and some suggestions are provided. 3. Furthermore, all this information can be packaged into the container and pushed to the container registry of your choice. 4. Finally, a DOI can be assigned to finalised software and shared to a wider audience or publication. 5. For further information, please contact aleem.uddin@ardc.edu.au

Note: This example container packages webscraping tool called Scrapy.

This repository specific DOI badge and dockerhub link to container image.

Owner

  • Login: Aleem2
  • Kind: user

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Aleem"
  given-names: "Uddin"
  orcid: "https://orcid.org/0000-0002-8519-5534"
title: "FAIR for Containers: A Practical Guide"
version: 1.0.0
doi: 10.5281/zenodo.10208297
date-released: 2023-11-26
url: "https://github.com/Aleem2/fair4containers"

GitHub Events

Total
Last Year

Dependencies

.github/workflows/docker-image.yml actions
  • actions/checkout v3 composite
Dockerfile docker
  • python 3.12.0 build