pking70 / beaker-guide

layout	title	nav_exclude
default	404	true

Beaker

Beaker is a collaborative platform for rapid, reproducible research.

About blueprints

Prerequisites

Docker is the foundation for Beaker experiments and must be installed to take full advantage of Beaker.

Getting Started

1. Create an account at beaker-pub.allenai.org and follow the instructions in your account settings.

   These instructions will guide you through installing and configuring the Beaker CLI. See below for more options.

   Request "Scientist" or higher credentials from a Beaker admin to get authorization to create experiments.

2. Run your first experiment. The following example counts words in the text of Moby Dick.

   beaker experiment run \
     --name wordcount-moby \
     --blueprint examples/wordcount \
     --source examples/moby:/input \
     --result-path /output

Install Beaker CLI

The most direct way to install Beaker is to download a release and extract it to your path.

tar -xvzf beaker_*.tar.gz -C /usr/local/bin

OS X users can install Beaker through Homebrew with a custom tap.

brew tap allenai/homebrew-beaker https://github.com/allenai/homebrew-beaker.git
brew install beaker

Beaker can also be installed from source using standard Go tools.

go get -u github.com/allenai/beaker/...

Notices

Beaker dependencies and licenses