Blame - docs/projects.rst - oransc/doc

blob: f3665c73e0312273bddec2ebe53eb4e23495d884 [file] [log] [blame]

weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	1	.. This work is licensed under a Creative Commons Attribution 4.0 International License.
				2	.. SPDX-License-Identifier: CC-BY-4.0
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	3	.. Copyright (C) 2019 CMCC
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	4
weichen	dbea4a6	2020-02-26 22:39:51 -0500	[diff] [blame]	5	.. index rst file
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	6
				7
weichen	dbea4a6	2020-02-26 22:39:51 -0500	[diff] [blame]	8	O-RAN SC Projects
weichen	f6a02c0	2020-11-26 06:10:45 -0500	[diff] [blame]	9	=================
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	10
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	11	RAN Intelligent Controller Applications (RICAPP)
				12	------------------------------------------------
				13	RICAPP includes open source sample xAPPs and platform applications that can we used for integration, testing, and demonstrations.
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	14
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	15	More detailed function documentation can be found as follow:
				16
weichen	9447de3	2021-03-07 20:48:19 -0500	[diff] [blame]	17	.. * :doc:`Alarm Go Library <ric-plt-alarm-go:index>`
				18	.. * :doc:`Admission Control xAPP <ric-app-admin:index>`
				19
weichen	cdf0733	2021-09-01 21:43:29 -0400	[diff] [blame]	20	* :doc:`Anomaly Detection xAPP <ric-app-ad:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	21	* :doc:`GS-lite Stream Processing Engine <com-gs-lite:index>`
weichen	ab5e08b	2020-06-09 23:41:48 -0400	[diff] [blame]	22	* :doc:`HelloWorld xAPP <ric-app-hw:index>`
weichen	cdf0733	2021-09-01 21:43:29 -0400	[diff] [blame]	23	* :doc:`HW-go xAPP <ric-app-hw-go:index>`
weichen	a00e30f	2019-11-27 04:47:28 -0500	[diff] [blame]	24	* :doc:`KPI monitoring <ric-app-kpimon:index>`
weichen	ab5e08b	2020-06-09 23:41:48 -0400	[diff] [blame]	25	* :doc:`QoE Predictor xApp <ric-app-qp:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	26	* :doc:`RIC APP ML <ric-app-ml:index>`
				27	* :doc:`RIC Measurement Campaign (MC) xApp <ric-app-mc:index>`
weichen	ab5e08b	2020-06-09 23:41:48 -0400	[diff] [blame]	28	* :doc:`Traffic Steering xAPP <ric-app-ts:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	29
weichen	10a1e57	2019-11-17 22:43:06 -0500	[diff] [blame]	30
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	31	Near Realtime RAN Intelligent Controller (RIC)
				32	----------------------------------------------
				33	This project a initial RIC Platform to support xAPPs with limited support for O1, A1, and E2 interfaces.
weichen	10a1e57	2019-11-17 22:43:06 -0500	[diff] [blame]	34
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	35	More detailed function documentation can be found as follow:
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	36
weichen	914edd6	2019-11-14 02:01:38 -0500	[diff] [blame]	37	* :doc:`A1 <ric-plt-a1:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	38	* :doc:`ASN.1 Documents <ric-plt-asn1-documents:index>`
weichen	914edd6	2019-11-14 02:01:38 -0500	[diff] [blame]	39	* :doc:`DBAAS <ric-plt-dbaas:index>`
weichen	ef2d6c1	2019-12-02 02:42:54 -0500	[diff] [blame]	40	* :doc:`E2 <ric-plt-e2:index>`
				41	* :doc:`E2MGR <ric-plt-e2mgr:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	42	* :doc:`GOLOG <com-golog:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	43	* :doc:`Jaegeradapter <ric-plt-jaegeradapter:index>`
				44	* :doc:`LOG <com-log:index>`
weichen	ef2d6c1	2019-12-02 02:42:54 -0500	[diff] [blame]	45	* :doc:`nodeb-rnib <ric-plt-nodeb-rnib:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	46	* :doc:`PYLOG <com-pylog:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	47	* :doc:`Reasouce Status Manager <ric-plt-resource-status-manager:index>`
				48	* :doc:`RIC Message Router <ric-plt-lib-rmr:index>`
weichen	914edd6	2019-11-14 02:01:38 -0500	[diff] [blame]	49	* :doc:`Routing Manager <ric-plt-rtmgr:index>`
				50	* :doc:`Shared Data Layer (SDL) in C++ <ric-plt-sdl:index>`
				51	* :doc:`Shared Data Layer (SDL) in Go <ric-plt-sdlgo:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	52	* :doc:`Streaming Protobufs <ric-plt-streaming-protobufs:index>`
weichen	ef2d6c1	2019-12-02 02:42:54 -0500	[diff] [blame]	53	* :doc:`Subscription Manager <ric-plt-submgr:index>`
weichen	914edd6	2019-11-14 02:01:38 -0500	[diff] [blame]	54	* :doc:`Tracelibcpp <ric-plt-tracelibcpp:index>`
				55	* :doc:`Tracelibgo <ric-plt-tracelibgo:index>`
				56	* :doc:`Vespamgr <ric-plt-vespamgr:index>`
weichen	d25cbea	2020-06-10 02:12:45 -0400	[diff] [blame]	57	* :doc:`xapp-frame <ric-plt-xapp-frame:index>`
				58	* :doc:`xAPP C++ <ric-plt-xapp-frame-cpp:index>`
				59	* :doc:`xApp Python <ric-plt-xapp-frame-py:index>`
weichen	914edd6	2019-11-14 02:01:38 -0500	[diff] [blame]	60
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	61
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	62	Non-RealTime RAN Intelligent Controller (NONRTRIC)
				63	--------------------------------------------------
elinuxhenrik	e8796f5	2020-04-14 17:09:16 +0200	[diff] [blame]	64	Non-RT RIC focus on feature functionality of A1-interface (consumer and provider), and closed-loop use cases. The Non-RT RIC project will also work together with the OAM project to align activities on a case-by-case base for O1 interfaces. Project should focus on use cases supported in ONAP. The work should be sponsored in O-RAN and initial code contributions in O-RAN SC. Interoperability with ONAP should be aligned between the standards and will follow initial contributions in this project.
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	65
				66	More detailed function documentation can be found as follow:
				67
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	68	* :doc:`A1 Interface Simulator <sim-a1-interface:index>`
elinuxhenrik	1e36a60	2020-12-07 16:28:48 +0100	[diff] [blame]	69	* :doc:`Non-RT RIC Components <nonrtric:index>`
elinuxhenrik	e8796f5	2020-04-14 17:09:16 +0200	[diff] [blame]	70	* :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	71
				72
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	73	Operations and Maintenance (OAM)
				74	--------------------------------
				75	The O-RAN-SC-OAM project provides reference implementation according to the O-RAN OAM (WG1) documents. In addition we provide a common MnS-Consumer for development and module test purposes. The assumption is that the projects for the ManagedElements can concentrate on the more important user-plane.
				76
				77	More detailed function documentation can be found as follow:
				78
weichen	cdf0733	2021-09-01 21:43:29 -0400	[diff] [blame]	79	* :doc:`NF OAM Adopter <oam-nf-oam-adopter:index>`
				80	* :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`
weichen	443311b	2019-11-29 01:42:15 -0500	[diff] [blame]	81	* :doc:`OAM Operation and Maintenance <oam:index>`
weichen	914edd6	2019-11-14 02:01:38 -0500	[diff] [blame]	82	* :doc:`RIC Dashboard <portal-ric-dashboard:index>`
weichen	1773844	2021-05-28 03:47:42 -0400	[diff] [blame]	83	* :doc:`TR069 Adapter <oam-tr069-adapter:index>`
weichen	cdf0733	2021-09-01 21:43:29 -0400	[diff] [blame]	84
weichen	22baee3	2021-05-31 02:16:06 -0400	[diff] [blame]	85
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	86
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	87	O-RAN Central Unit (OCU)
				88	------------------------
DW Talton	1ab4494	2021-01-19 11:42:43 -0700	[diff] [blame]	89	The OCU is target an initial software deliverable with limited functionality. Focus on a basic E2 interface to enable initial integration testing between RIC and OCU.
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	90
				91	More detailed function documentation can be found as follow:
				92
weichen	ac77362	2020-06-19 00:26:23 -0400	[diff] [blame]	93	.. * :doc:`Open LTE <scp-ocu-openlte:index>`
				94
				95	* :doc:`5G NR <scp-ocu-5gnr:index>`
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	96
				97
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	98	O-RAN Distributed Unit High Layers (ODUHIGH)
				99	--------------------------------------------
				100	Focus on initial L2 functional blocks based on seed code contributions.
				101
				102	More detailed function documentation can be found as follow:
weichen	635c0af	2019-11-20 04:25:54 -0500	[diff] [blame]	103
weichen	664c532	2019-11-20 02:24:51 -0500	[diff] [blame]	104	* :doc:`O-DU Layer 2 <o-du-l2:index>`
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	105
				106
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	107	O-RAN Distributed Unit Low Layers (ODULOW)
				108	------------------------------------------
				109	Focus on initial L1 functional blocks based on seed code contributions.
				110
				111	More detailed function documentation can be found as follow:
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	112
weichen	0829aea	2019-11-20 22:37:22 -0500	[diff] [blame]	113	* :doc:`O-DU Layer 1 <o-du-phy:index>`
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	114
weichen	664c532	2019-11-20 02:24:51 -0500	[diff] [blame]	115
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	116	Infrastructure (INF)
				117	--------------------
				118	Initial building blocks for infrastructure to run O-RAN NF components.
				119
				120	More detailed function documentation can be found as follow:
				121
				122	* :doc:`Realtime Platform <pti-rtp:index>`
weichen	57c0f40	2021-12-21 02:06:46 -0500	[diff] [blame]	123	* :doc:`RTP O2 <pti-o2:index>`
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	124
				125
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	126	Simulations(SIM)
				127	----------------
				128	Initial simulators used for testing O-RAN NF interfaces.
				129
				130	More detailed function documentation can be found as follow:
				131
elinuxhenrik	1e36a60	2020-12-07 16:28:48 +0100	[diff] [blame]	132	* :doc:`SIM/A1-Interface <sim-a1-interface:index>`
weichen	cdf0733	2021-09-01 21:43:29 -0400	[diff] [blame]	133	* :doc:`SIM/O1-Interface <sim-o1-interface:index>`
weichen	332b287	2019-11-12 01:41:31 -0500	[diff] [blame]	134
				135
weichen	58b8cbc	2019-11-18 03:47:15 -0500	[diff] [blame]	136	Integration and Testing (INT)
				137	-----------------------------
				138	The integration and test effort will focus on testing the requirements documented in each release. This will focus on end to end test and use case testing.
				139
				140	INF Testing shall primarily be done on the Akraino-REC (Radio Edge Cloud) blueprint. While Non-RT RIC and O1 interface testing will primarily use ONAP components.
				141
				142	More detailed function documentation can be found as follow:
				143
weichen	d773eca	2019-11-29 05:17:40 -0500	[diff] [blame]	144	* :doc:`IT-DEP <it-dep:index>`
weichen	d773eca	2019-11-29 05:17:40 -0500	[diff] [blame]	145	* :doc:`IT-DEV <it-dev:index>`
				146	* :doc:`IT-OTF <it-otf:index>`
weichen	862f882	2020-06-08 04:51:03 -0400	[diff] [blame]	147	* :doc:`IT-TEST <it-test:index>`
weichen	10a1e57	2019-11-17 22:43:06 -0500	[diff] [blame]	148
				149
weichen	94f0a21	2021-12-15 03:45:00 -0500	[diff] [blame]	150	Service Managerment and Orgestration(SMO)
				151	-----------------------------------------
weichen	68ddf7a	2021-12-22 02:47:37 -0500	[diff] [blame]	152	The SMO project implements the O1 and the O1/VES interface. The former is used for configuration and management of RAN Network Functions (NF) while the latter collects all the events that are reported by different RAN NFs.
weichen	94f0a21	2021-12-15 03:45:00 -0500	[diff] [blame]	153
				154	More detailed function documentation can be found as follow:
				155
				156	* :doc:`SMO-VES <smo-ves:index>`
weichen	57c0f40	2021-12-21 02:06:46 -0500	[diff] [blame]	157	* :doc:`SMO O1 <smo-o1:index>`
Toshiaki Takahashi	a471319	2022-06-22 22:03:41 +0900	[diff] [blame]	158	* :doc:`SMO O2 <smo-o2:index>`
weichen	94f0a21	2021-12-15 03:45:00 -0500	[diff] [blame]	159
				160
zhangxiaohua	89bb061	2022-12-12 15:24:01 +0800	[diff] [blame]	161	AI/ML Framework
				162	---------------
				163	the AI/ML Framework is stand alone installation (separated from existing platform deployment) and initial AIML workflow modules.
weichen	10a1e57	2019-11-17 22:43:06 -0500	[diff] [blame]	164
zhangxiaohua	89bb061	2022-12-12 15:24:01 +0800	[diff] [blame]	165	More detailed function documentation can be found as follow:
				166
				167	* :doc:`AIMLFW Training Manager <aiml-fw-awmf-tm:index>`
				168	* :doc:`AIMLFW Dashboard <portal-aiml-dashboard:index>`
				169	* :doc:`AIMLFW Data Extraction <aiml-fw-athp-data-extraction:index>`
				170	* :doc:`AIMLFW Feature Store SDK <aiml-fw-athp-sdk-feature-store:index>`
				171	* :doc:`AIMLFW Model Storage SDK <aiml-fw-athp-sdk-model-storage:index>`
zhangxiaohua	fb292a9	2022-12-14 09:21:07 +0800	[diff] [blame]	172	* :doc:`AIMLFW Kubeflow adapter <aiml-fw-athp-tps-kubeflow-adapter:index>`
				173	* :doc:`AIMLFW dep <aiml-fw-aimlfw-dep:index>`
zhangxiaohua	998000d	2022-12-16 10:44:39 +0800	[diff] [blame]	174	* :doc:`AIMLFW QoE Prediction assist xApp <ric-app-qp-aimlfw:index>`
weichen	10a1e57	2019-11-17 22:43:06 -0500	[diff] [blame]	175