docs/user-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2020
   4
   5 ============================================================================================
   6 HelloWorld xAPP (Python)
   7 ============================================================================================
   8 --------------------------------------------------------------------------------------------
   9 User's Guide
  10 --------------------------------------------------------------------------------------------
  11
  12 Introduction
  13 ============================================================================================
  14
  15 The RIC platform provides set of functions as part of xAPP Python Framework that the xAPPs can use to accomplish their tasks.
  16 This xAPP is envisioned to provide python xAPP developers, examples of implementing these sets of functions.
  17 Note, HW xAPP does not address/implement any RIC Usecases.
  18
  19 HelloWorld xAPP Features
  20 ============================================================================================
  21
  22 RIC Platform provides many Frameworks, APIs and libraries to aid the development of xAPPs. All xAPPs will have some custom
  23 processing functional logic core to the xApp and some additional non-functional platform related processing using
  24 these APIs and libraries. This xAPP attempts to show the usage of such additional platform processing using xapp RIC framework APIs and libraries.
  25
  26
  27 The Hello World xApp demonstrates how a python based xApp uses the A1, and E2 interfaces and persistent database read-write operations.
  28