Link
Oktopus

Developer Guide

Working with Oktopus source code.

Table of contents

  1. Install
  2. Framework Structure

The source code can be located here.

Install

Install the Oktopus Framework module by running:

pip install -e .

Framework Structure

The Oktopus Framework module has two main submodules:

  • oktopus.multicast: This module is the Oktopus APIs.

  • oktopus.solver: This module is Optimization engine, which contains the Oktopus algorithm.

oktopus
|-- multicast
|   |-- app
|   |-- session
|   |-- routing
|   +-- (other helper files and objects) ...
|
|-- solver
|   |-- oktopus_algorithm
|   |-- cplex
|   +-- (other algorithms) ...
|
+-- (other helper packages) ...

Oktopus Framework module structure.

Oktopus