Installing Orbit¶

Server Installation¶

Prerequisites¶

Ubuntu 16.04 LTS or higher, RHELv7 or higher
Docker version >18.09 (Docker installation instructions)
Python >3.6 and <3.8
Conda or pip/venv
>5GB of free machine storage
The orbit_team_installer.sh file.

Steps¶

Create and activate a virtual environment of your choice for Orbit installation
Ensure the orbit_team_installer.sh file is executable
```
chmod +x orbit_team_installer.sh
```
Run the installer
```
./orbit_team_installer.sh
```
Start Orbit Server
```
orbit-server start &
```

Tip

This will run Orbit-Server in the background. You can stop Orbit-Server at any time using orbit-server stop from within the virtual environment you created.

Client Installation¶

Prerequisites¶

Python >3.6
Conda or pip/venv
>2GB of free machine storage
The orbit_team_installer.sh file
macOS, Linux or Windows 10

macOS / Linux¶

Create a virtual environment of your choice to install orbit-team python packages

a) Using Conda: conda create --name orbit-team python=3.6

OR

b) Using venv: python -m venv .orbit-team
Activate the environment for installation

a) Using Conda: conda activate orbit-team

OR

b) Using pip: source .orbit-team/bin/activate
Ensure the orbit_team_installer.sh file is executable
```
chmod +x orbit_team_installer.sh
```
Run the installer with the client options. (Confirm prompts when requested)
```
./orbit_team_installer.sh -- --client
```
After installation is completed you can use the orbit-team sdk in your application

Windows 10¶

Create a virtual environment of your choice to install orbit-team python packages

a) Using Conda: conda create --name orbit-team python=3.6

OR

b) Using venv: python -m venv .\orbit-team
Activate the environment for installation

a) Using Conda: conda activate orbit-team

OR

b) Using venv: \orbit-team\Scripts\activate.bat
Extract files from archive installer using 7zip or winRAR
After extracting the files, navigate with your CMD terminal to the folder and run
```
python orbit_installer.py -vdilf orbit_team.tgz 
```