In order to run Cloudburst, whether in local mode or in cluster mode, the Cloudburst runtime requires a copy of the Anna KVS to be running. Both Cloudburst and Anna can be run with limited capabilities on a single machine. You can find documentation on running Anna in local mode here. The rest of this document assumes that Anna is already running in local mode on your machine.
Cloudburst currently only supports Python3. To install Python dependencies, simply run pip3 install -r requirements.txt from the Cloudburst source directory.
Before running Cloudburst, we need to compile its Protobufs locally to generate the Python dependency files. scripts/build.sh automatically does this for you and installs them in the correct location, but it requires having the protoc tool installed. If you need to remove the locally compiled protobufs, you can run bash scripts/clean.sh.
Prepackaged scripts to install dependencies such as protoc on Fedora, Debian, and macOS can be found in common/scripts/install-dependencies(-osx).sh. To install the common submodule run git submodule update --init --recursive.
Finally, Cloudburst requires access to the Anna Python client, which is in the Anna KVS repository. A default script to clone the Anna repository and install the client (the client is not currently pip-installable) can be found in scripts/install-anna.sh. You can customize the installation location by adding the --prefix flag to the setup.py command.
Once all the protobufs have been compiled, scripts/start-cloudburst-local.sh will start a local Cloudburst server. You can stop these processes with scripts/stop-cloudburst-local.sh. For more information on how to interact with Cloudburst once it is running, see the function execution docs.