https://github.com/alan-turing-institute/repro-catalogue

A tool to catalogue versions of data, code and results to check the reproducibility of your research project
https://github.com/alan-turing-institute/repro-catalogue

hut23 hut23-648 reproducibility

Last synced: 5 months ago
JSON representation

A tool to catalogue versions of data, code and results to check the reproducibility of your research project

• Host: GitHub
• URL: https://github.com/alan-turing-institute/repro-catalogue
• Owner: alan-turing-institute
• License: mit
• Created: 2020-04-06T08:05:29.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-10-15T15:29:37.000Z (over 4 years ago)
• Last Synced: 2024-04-24T21:42:53.080Z (about 1 year ago)
• Topics: hut23, hut23-648, reproducibility
• Language: Python
• Homepage:
• Size: 242 KB
• Stars: 5
• Watchers: 6
• Forks: 1
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# repro-catalogue

[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)

[![Build Status](https://travis-ci.com/alan-turing-institute/repro-catalogue.svg?branch=master)](https://travis-ci.com/alan-turing-institute/repro-catalogue)

[![PyPI version](https://badge.fury.io/py/repro-catalogue.svg)](https://badge.fury.io/py/repro-catalogue)

[![Documentation Status](https://readthedocs.org/projects/pip/badge/)](https://repro-catalogue.readthedocs.io/en/latest/)

A command line tool to catalogue versions of data, code and results to support reproducibility of research projects.

## Contents

* [Introduction](#introduction)

* [Installation](#installation)

* [Contributing](#contributing)

* [Contributors](#contributors)

## Introduction

Research projects are frequently updated - new data are added, and the code undergoes regular changes. Under these circumstances, it's easy to store results, yet lose track of the context in which they were produced.

The `catalogue` tool aids reproducibility by saving **hash values** of the input data and the results, along with the **git commit hash** of the code used to generate those results. The `catalogue` command line interface then allows the user to easily compare the hash values from different occasions on which the analysis was run so that changes to the input data, code and results can be identified and the impact on reproducibility can be understood.

## Installation

The package is available on PyPI and requires Python 3 to use:

```{bash}

pip install repro-catalogue

```

See [https://repro-catalogue.readthedocs.io](https://repro-catalogue.readthedocs.io) for full documentation on how to install and use the tool.

## Contributing

🚧 This repository is always a work in progress and everyone is encouraged to help us build something that is useful to the many. 🚧

Everyone is asked to follow our [code of conduct](CODE_OF_CONDUCT.md) and to checkout our [contributing guidelines](CONTRIBUTING.md) for more information on how to get started.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Louise Bowler
📖 🤔 👀 📆 🎨 🚧 🚇 💻

    
Isla
🎨 🤔 💻 📖

    
Kirstie Whitaker
🎨 🤔 🚇

    
Sarah Gibson
💻 👀

    
kevinxufs
👀 📓 📖 💻 🎨 🤔

    
Eric Daub
🎨 🤔 💻 📖 👀 🚧 📆

    
Radka Jersakova
🎨 🤔 💻 👀 📖 🚧 📆 🚇

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!