This is a quick install for general use of COSMOS.

If you do not have Ubuntu 18.04, it is recommended to install a virtual machine to emulate Ubuntu 18.04. If you are already using Ubuntu 18.04, please skip the installation of VirtualBox and start from Dependencies.

VirtualBox Installation

You can follow the instructions from development environment.


Install dependencies by running the following in a terminal or command line:

$ sudo apt update && sudo apt upgrade -y
$ sudo apt-get install git cmake build-essential -y

Clone COSMOS Core

Clone and run the installer script by executing the following:

$ git clone ~/cosmos
$ cd ~/cosmos
$ ./

Testing COSMOS

Let's test the installation of COSMOS.

Check that the bin folder was created under cosmos:

$ cd ~/cosmos
$ ls

You should see bin as one of the outputs.


A path allows easy access to executable programs. Through this method, you will be able to run agents globally; simply add the cosmos/bin folder to the path. Enter into the terminal:

$ nano ~/.bashrc

This will open up the file containing the directories the shell looks for programs in. Now, add the following line to the bottom of the file:

export PATH="$HOME/cosmos/bin:$PATH"

After you've added that line, press CTRL + S to save the file, and then CTRL + X to exit.

Next, close the terminal window and open up a new one to reload the PATH. You should be able to run the following command to see the usage of the program:

$ agent

(Optional) Install COSMOS Web

Here, we will install COSMOS Web, a website that helps visualize the telemetry data that comes in from the satellites. This allows you to host the website on your computer.

Install Docker

Docker helps create versions of code and sets up the environment to make it easier for it to be shared.

We will install the community edition of docker by following this guide. The instructions are repeated below:

$ sudo apt-get update
$ sudo apt-get install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
$ curl -fsSL | sudo apt-key add -
$ sudo add-apt-repository \
   "deb [arch=amd64] \
   $(lsb_release -cs) \
 $ sudo apt-get update
 $ sudo apt-get install docker-ce docker-ce-cli

To test your docker installation, run:

$ sudo docker run hello-world

Build Docker Image

Now that docker has been installed, we will build the COSMOS Web on our computers. To do so, run the following:

$ cd ~/cosmos
$ sudo docker build -t cosmos .

Starting COSMOS Web

We can now run COSMOS Web on our computers with the command:

$ sudo docker run --network host --entrypoint "cosmos_web" cosmos

See Also