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 components and plugins are also provided for reprounzip: reprounzip-vagrant, which unpacks the experiment in a Vagrant virtual machine; reprounzip-docker, which unpacks the experiment in a Docker container; and reprounzip-vistrails, which creates a VisTrails workflow to reproduce the experiment. 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, or 3.3 or greater is required to run ReproZip [1]. If you don’t have Python on your machine, you can get it from python.org. 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, Python headers, a working C compiler |
| reprounzip | None |
| reprounzip-vagrant | Python headers, a working C compiler, Vagrant v1.1+, VirtualBox |
| reprounzip-docker | Docker |
| reprounzip-vistrails | None [2] |
Debian and Ubuntu¶
You can get all the required dependencies using APT:
apt-get install python python-dev python-pip gcc libsqlite3-dev libssl-dev libffi-dev
Fedora & CentOS¶
You can get the dependencies using the Yum packaging manager:
yum install python python-devel gcc sqlite-devel openssl-devel libffi-devel
| [1] | reprozip and reprounzip graph will not work before 2.7.3 due to Python bug 13676 related to sqlite3. Python 2.6 is ancient and unsupported. |
| [2] | VisTrails v2.2.3+ is required to run the workflow generated by the plugin. |
Installing reprozip¶
To install or update the reprozip component, simply run the following command:
$ pip install -U reprozip
Installing reprounzip¶
You can install or update reprounzip with all the available components and plugins using:
$ pip install -U reprounzip[all]
Or you can install reprounzip and choose components manually:
# Example, this installs all the components
$ pip install -U reprounzip reprounzip-docker reprounzip-vagrant reprounzip-vistrails
Mac OS X¶
For Mac OS X, only the reprounzip component is available.
Binaries¶
An installer containing Python 2.7, reprounzip, and all the plugins can be downloaded from GitHub.
Required Software Packages¶
Python 2.7.3 or greater, or 3.3 or greater is required to run ReproZip [3]. If you don’t have Python on your machine, you can get it from python.org; you should prefer a 2.x release to a 3.x one. 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 | Python headers, Vagrant v1.1+, VirtualBox |
| reprounzip-docker | Docker |
| reprounzip-vistrails | None [4] |
You will need Xcode installed, which you can get from the Mac App Store, and the Command Line Developer Tools; instrucions on installing the latter may depend on your Mac OS X version (some information on StackOverflow here).
| [3] | reprozip and reprounzip graph will not work before 2.7.3 due to Python bug 13676 related to sqlite3. Python 2.6 is ancient and unsupported. |
| [4] | VisTrails v2.2.3+ is required to run the workflow generated by the plugin. |
Installing reprounzip¶
First, be sure to upgrade setuptools:
$ pip install -U setuptools
You can install or update reprounzip with all the available components and plugins using:
$ pip install -U reprounzip[all]
Or you can install reprounzip and choose components manually:
# Example, this installs all the components
$ pip install -U reprounzip reprounzip-docker reprounzip-vagrant reprounzip-vistrails
Windows¶
For Windows, only the reprounzip component is available.
Binaries¶
A 32-bit installer containing Python 2.7, reprounzip, and all the plugins can be downloaded from GitHub.
Required Software Packages¶
Python 2.7.3 or greater, or 3.3 or greater is required to run ReproZip [5]. If you don’t have Python on your machine, you can get it from python.org; you should prefer a 2.x release to a 3.x one. 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 | Vagrant v1.1+, VirtualBox |
| reprounzip-docker | Docker [7] |
| reprounzip-vistrails | None [6] |
| [5] | reprozip and reprounzip graph will not work before 2.7.3 due to Python bug 13676 related to sqlite3. Python 2.6 is ancient and unsupported. |
| [6] | VisTrails v2.2.3+ is required to run the workflow generated by the plugin. |
| [7] | Windows Professional Edition is required for Docker, it will not work on Windows Home Edition; see FAQ. |
Installing reprounzip¶
You can install or update reprounzip with all the available components and plugins using:
$ pip install -U reprounzip[all]
Or you can install reprounzip and choose components manually:
# Example, this installs all the components
$ pip install -U reprounzip reprounzip-docker reprounzip-vagrant reprounzip-vistrails