Installing and using Codeface
The recommended way to set up a Codeface instance is via vagrant. Clone the repository and run
to obtain a fully provisioned Codeface machine. Vagrant defaults to Virtualbox as provider, which may cause large performance impacts especially for I/O heavy tasks. You can /alternatively/ use
vagrant up --provider=lxc
if you have the corresponding LXC provider for vagrant installed on your system. To get shell access on the machine in each case, use
If vagrant is not yet installed on your system, please consult the corresponding [wiki page] (https://github.com/siemens/codeface/wiki/Runnning-codeface-with-Vagrant).
Conceptually, work with Codeface is split in two stages:
- Analyse projects using the batch-mode command line interface. See
analysis.mdfor further details. Note that this process involves substantial amounts of git repo querying and data crunching, and can require several hours for large projects like the Linux kernel.
- Inspect the results by visual analysis with the web frontend (see
webserver.mdfor setup details), or by querying the database directly. See file
codeface/R/interactive.Rfor exemplary instructions.
Five Easy Steps to your First Analysis
To perform an analysis of project qemu (a machine emulation software) and inspect the results in the interactive web frontend, run the following steps:
- After bringing up the vagrant instance,
vagrant sshinto the virtual machine
- Start the ID service with
- Run an analysis of qemu with
/vagrant/analysis_example.sh(this process may take a while to complete)
- Start the webserver with
cd vagrant; ./shiny-server.sh
- Point your webserver on the host at http://localhost:8081