Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.45 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.45 KB

DEVIL Server

This repository contains a server program offering control of multiple EVIL PID controllers over the network. It is intended to run on a number of mini-computers (such as the Raspberry Pi) connected via USB to the EVIL boxes to offer an Ethernet interface to them.

This project is written in "modern" C++ and will require a compiler that supports C++14 to build. Clang 3.6 and GCC 5.1.0 are known to work, GCC 4.9 is known to contain bugs that cause compilation to fail.

Originally written by David Nadlinger [0] for hardware developed by Ludwig de Clerq [1] and Vlad Negnevitsky [2] in the Trapped Ion Quantum Information Group, ETH Zurich.

Documentation

The code base includes documentation comments compatible with Doxygen. Run doxygen in the root directory of the repository and then browse to docs/html/index.html to view the generated documentation.

Coding Style

Apart from generally following good programming practice, please try to keep the code format reasonably consistent. Since there is is no excuse for wasting brain-power on that in this day and age, clang-format [3] is used. Ideally, you run it before every check-in like this:

clang-format -style=file -i <files_you_changed>

There are also various options available for editor/IDE integration.


[0] mailto:[email protected] [1] mailto:[email protected] [2] mailto:[email protected] [3] http://clang.llvm.org/docs/ClangFormat.html