Installation

ReproZip is available as open source, released under the Revised BSD License. The tool is comprised of two components: reprozip (for the packing step) and reprounzip (for the unpack step). Additional plugins are also provided for reprounzip: reprounzip-vagrant, which unpacks the experiment in a Vagrant virtual machine, and reprounzip-docker, which unpacks the experiment in a Docker container; more plugins may be developed in the future (and, of course, you are free to roll your own). In our website, you can find links to our PyPI packages and our GitHub repository.

In the following, you will find installation instructions for Linux, Mac OS X, and Windows. ReproZip is also available for the Anaconda Python distribution.

Linux

For Linux distributions, both reprozip and reprounzip components are available.

Required Software Packages

Python 2.7.3 or greater is recommended to run ReproZip. Older versions should allow reprounzip to work, but some features will not be available [1]. If you don’t have it yet on your machine, you can get Python from python.org [2]; you should prefer a 2.x releases to 3.x. You will also need the pip installer.

Besides Python and pip, each component or plugin to be used may have additional dependencies that you need to install (if you do not have them already installed in your environment), as described below:

Component / Plugin Required Software Packages
reprozip SQLite [3], Python headers [4], a working C compiler
reprounzip None
reprounzip-vagrant Python headers [4] [5], a working C compiler [5], Vagrant, VirtualBox
reprounzip-docker Docker
[1]reprounzip graph will not work due to Python bug 13676 related to sqlite3.
[2]On Debian and Debian-based, this is provided by python: sudo apt-get install python.
[3]On Debian and Debian-based, this is provided by libsqlite3-dev: sudo apt-get install libsqlite3-dev.
[4](1, 2) On Debian and Debian-based, this is provided by python-dev: sudo apt-get install python-dev.
[5](1, 2) Required to build PyCrypto.

Installing reprozip

To install the reprozip component, simply run the following command:

$ pip install reprozip

To update the software, use the flag -U:

$ pip install -U reprozip

Installing reprounzip

To install the reprounzip component, simply run the following command:

$ pip install reprounzip

To update the software, use the flag -U:

$ pip install -U reprounzip

The additional plugins for reprounzip can also be installed using the same command:

$ pip install reprounzip-docker reprounzip-vagrant

Alternatively, you can install reprounzip with all the available plugins using:

$ pip install reprounzip[all]

Mac OS X

For Mac OS X, only the reprounzip component is available.

Binaries

Coming soon!

Required Software Packages

Python 2.7.3 or greater is recommended to run ReproZip. Older versions should allow reprounzip to work, but some features will not be available [6]. If you don’t have it yet on your machine, you can get Python from python.org; you should prefer a 2.x releases to 3.x. You will also need the pip installer (see their installation instructions here).

Besides Python and pip, each component or plugin to be used may have additional dependencies that you need to install (if you do not have them already installed in your environment), as described below:

Component / Plugin Required Software Packages
reprounzip None
reprounzip-vagrant Python headers [7] [8], a working C compiler [7] [8], Vagrant, VirtualBox
reprounzip-docker Docker
[6]reprounzip graph will not work due to Python bug 13676 related to sqlite3.
[7](1, 2) This is usually provided by installing Xcode (in the Mac App Store) and the Command Line Developer Tools; instructions on installing the latter may depend on your Mac OS X version (some information on StackOverflow here).
[8](1, 2) Required to build PyCrypto.

Installing reprounzip

First, be sure to upgrade setuptools:

$ pip install -U setuptools

To install the reprounzip component, simply run the following command:

$ pip install reprounzip

To update the software, use the flag -U:

$ pip install -U reprounzip

The additional plugins for reprounzip can also be installed using the same command:

$ pip install reprounzip-docker reprounzip-vagrant

Alternatively, you can install reprounzip with all the available plugins using:

$ pip install reprounzip[all]

Windows

For Windows, only the reprounzip component is available.

Binaries

Coming soon!

Required Software Packages

Python 2.7.3 or greater is recommended to run ReproZip. Older versions should allow reprounzip to work, but some features will not be available [9]. If you don’t have it yet on your machine, you can get Python from python.org; you should prefer a 2.x releases to 3.x. You will also need the pip installer.

Besides Python and pip, each component or plugin to be used may have additional dependencies that you need to install (if you do not have them already installed in your environment), as described below:

Component / Plugin Required Software Packages
reprounzip None
reprounzip-vagrant PyCrypto [10], Vagrant, VirtualBox
reprounzip-docker Docker
[9]reprounzip graph will not work due to Python bug 13676 related to sqlite3.
[10]A working C compiler is required to build PyCrypto. For installation without building from source, please see this page.

Installing reprounzip

To install the reprounzip component, simply run the following command:

$ pip install reprounzip

To update the software, use the flag -U:

$ pip install -U reprounzip

The additional plugins for reprounzip can also be installed using the same command:

$ pip install reprounzip-vagrant
$ pip install reprounzip-docker

Alternatively, you can install reprounzip with all the available plugins using:

$ pip install reprounzip[all]

Anaconda

reprozip and reprounzip can also be installed on the Anaconda Python distribution, from Binstar:

$ conda install -c https://conda.binstar.org/vida-nyu reprozip reprounzip reprounzip-docker reprounzip-vagrant

Note, however, that reprozip is only available for Linux.