logo Caravel

PEP compatible

Caravel provides a web interface to interact with your PEP-formatted projects. Caravel lets you submit jobs to any cluster resource manager, monitor jobs, summarize results, and browse project summary web pages. Caravel is a local web GUI for looper build with flask.

Installing

Release versions are posted on the GitHub caravel releases page. You can install the latest release directly from GitHub using pip:

pip install --user https://github.com/pepkit/caravel/zipball/master

Update caravel with:

pip install --user --upgrade https://github.com/pepkit/caravel/zipball/master

Hello, world!

You can now try running caravel on the command line: 

caravel example_config.yaml

The example_config.yaml file is a simple configuration file that points to your PEPs. See how to configure caravel.