0785c40623e03034aa4485355b34ec349fd130c3
[ric-plt/xapp-frame-py.git] / docs / installation-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 AT&T Intellectual Property
4
5
6 Installation Guide
7 ==================
8
9 .. contents::
10    :depth: 3
11    :local:
12
13 The `ricxappframe` is available in `PyPi <https://pypi.org/project/ricxappframe>`_ .
14 Use pip to install the version you want.
15
16 Installing the ricxappframe package does NOT install the required RMR system library,
17 a shared object written in C and available for most Linux systems.
18 For information on how to install the RMR system library, see here for
19 `DEB/RPM packages <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=3605041>`_
20 and here to install from
21 `source <https://wiki.o-ran-sc.org/display/RICP/RMR+Building+From+Source>`_.
22 Alternatively, you can use a script (note, this file contains an RMR version
23 that is subject to change!) in the
24 `a1 <https://gerrit.o-ran-sc.org/r/gitweb?p=ric-plt/a1.git;a=blob;f=integration_tests/install_rmr.sh;h=70ee489ba2895ea67ca2c93ecefb2776ba2c9ff3;hb=78ba273b279a7e7af6dba811a29746b881a53a8e>`_
25 repo.