Helios Server

To obtain a Helios server, either self hosted or hosted by Cartesian Theatre, please contact sales.

Installation with default out of the box configuration usually takes under a minute to get up and running. In that scenario simply run the following on the installation target which has access to the server package repository:


$ sudo apt install helios-server


This will download, configure, and install the server as a normal system service.


Helios Client Utilities

This is a set of command line utilities for interacting with a Helios server. You can use them to manage your music catalogue as well as perform similarity matches. They use the Helios Python SDK and can be used as examples for developing your own applications that use the Helios REST API.

To install run the following on Ubuntu Disco (19.04) or later:


$ sudo add-apt-repository ppa:kip/helios-public
$ sudo apt install helios-client-utilities


The utilities are fully documented and each come with their own manual. Try running the following:


$ man helios


The source code to all of the utilities is fully available gratis under the terms of the GNU General Public License (GPLv3).


Helios Python SDK

A client side Helios software development kit (SDK) has already been prepared for you to enable rapidly integrating Helios into your own platform in the form of an easy to use pure Python module. It is pre-packaged for Ubuntu Disco (19.04) and later.

The purpose of the module is to provide an API to Python applications to communicate with a remote Helios server. In only a few lines of code you can manage your music catalogue and perform similarity matches.

To install it in seconds simply run the following:


$ sudo add-apt-repository ppa:kip/helios-public
$ sudo apt install python3-helios-client


To use the module, it's as simple as:


$ python3
>>> import helios
>>> from pprint import pprint
>>> client = helios.client(host="your_server_hostname")
>>> status = client.get_server_status()
>>> pprint(status)


The module's source code is fully available gratis under the terms of the GNU Lesser General Public License (LGPL) for use, study, redistribution, or modification within any commercial product.


REST API Documentation

The Helios server sports a simple to use industry-standard REST API. You can find documentation available here.