Skip to main content

Linux tool enabling reproducible experiments (unpacker)

Project description

ReproZip is a tool aimed at scientists using Linux distributions, that simplifies the process of creating reproducible experiments from programs.

It uses the ptrace facilities of Linux to trace the processes and files that are part of the experiment and build a comprehensive provenance graph for the user to review.

Then, it can pack these files in a package to allow for easy reproducibility elsewhere, either by unpacking and running on a compatible machine or by creating a virtual machine through Vagrant.

Quickstart

Packing

On the machine where the experiment is setup, install reprozip:

$ pip install reprozip

Then run your experiment under reprozip’s monitoring (simply prefix reprozip trace):

$ reprozip trace ./myexperiment -my --options inputs/somefile.csv other_file_here.bin

This leaves you with a .reprozip directory, in which you’ll find the config.yml configuration file. In it, you can edit the command-line and environment variables, and choose which files are to be packed.

If you are using one of the supported Linux distributions (currently Debian and Ubuntu), these files are organized by package, plus an other_files: section at the end. You can add or remove files, or choose not to include a package by changing packfiles: true to packfiles: false; this allows you to make a smaller packs, since reprounzip can get these files from the package manager easily (however versions might differ).

Once done editing .reprozip/config.yml, or if you left everything as-is, simply run the packer: (note that you should review the configuration to be sure not to include sensitive information)

$ reprozip pack my_experiment.rpz

Unpacking

$ pip install reprounzip

# Installing the packages on the host machine
$ reprounzip installpkgs my_experiment.rpz

# Unpacking in a directory
$ reprounzip directory my_experiment.rpz mydirectory
$ mydirectory/script.sh
# Building a chroot environment
$ reprounzip chroot my_experiment.rpz mychroot
$ sudo mychroot/script.sh

# Building a virtual machine (requires Vagrant)
$ pip install reprounzip-vagrant
$ reprounzip vagrant --use-chroot my_experiment.rpz mytemplate
$ cd mytemplate; vagrant up
$ vagrant ssh
vagrant@vm$ sh /vagrant/script.sh

Project details


Release history Release notifications

History Node

1.0.13

History Node

1.0.11

History Node

1.0.10

History Node

1.0.9

History Node

1.0.8

History Node

1.0.7

History Node

1.0.6

History Node

1.0.5

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

History Node

0.7.2

History Node

0.7

History Node

0.6.4

History Node

0.6.3

History Node

0.6

History Node

0.5.1

History Node

0.5

History Node

0.4.1

History Node

0.4

History Node

0.3.2

History Node

0.3

History Node

0.2.1

This version
History Node

0.2

History Node

0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
reprounzip-0.2-py2.py3-none-any.whl (16.9 kB) Copy SHA256 hash SHA256 Wheel 2.7 Jun 18, 2014
reprounzip-0.2.tar.gz (12.0 kB) Copy SHA256 hash SHA256 Source None Jun 18, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page