README.md 1.96 KB
Newer Older
nikaeinn's avatar
nikaeinn committed
1
2
3
4
5
# MOSAIC5G Ecosystem 
M5G is an ecosystem of opensource platforms and use-cases for 4G-5G R&D. 


A service delivery platform for 5G network across reusable software 
nikaeinn's avatar
nikaeinn committed
6
7
8

Mosaic-5G is composed of the following modules:

nikaeinn's avatar
nikaeinn committed
9
* The network Store 
nikaeinn's avatar
nikaeinn committed
10
11
* The JOX juju orchestrator
* The LL-MEC low latency MEC platform
nikaeinn's avatar
nikaeinn committed
12
* The FlexRAN and FlexCN real-time master controller
nikaeinn's avatar
nikaeinn committed
13
14
* The FlexRAN agent-r for monolitic and disaggregated RAN
* The FlexCN agent-c for  monolitic and disaggregated CN
nikaeinn's avatar
nikaeinn committed
15
16
17
18
19
20
21
22
23
24
25
26

This repository is designed to serve as a meta repository from where each 
submodules can be pulled. To get the code, simply clone this repository and 
from its main directory run

```
git submodule init
```

Then choose to load the appropriate submodule depending on the deployment node 
(agent or controller).

nikaeinn's avatar
nikaeinn committed
27
28
29
30
31
32
33
34
## Store 
For the jox directory, simply run:
```
git submodule update store
```
The source code of the jox  will be cloned from the appropriate repository
and can be found in the **store** directory.

nikaeinn's avatar
nikaeinn committed
35
36
37
38
39
40
41
42
43
## Jox juju orchestrator

For the jox directory, simply run:
```
git submodule update jox
```
The source code of the jox  will be cloned from the appropriate repository
and can be found in the **jox** directory.

nikaeinn's avatar
nikaeinn committed
44
45
46
47
48
49
50
51
52
53
## LL-MEC low latency MEC 

For the ll-mec, simply run:
```
git submodule update ll-mec
```
The source code of the ll-mec will be cloned and can be found in the 
**ll-mec** directory.

## FlexRAN and FlexCN real-time controller
nikaeinn's avatar
nikaeinn committed
54
55
56
57
58
59
60
61
62

For the FlexRAN controller simply run:
```
git submodule update controller
```
The source code of the controller will be cloned from the appropriate repository
and can be found in the **controller** directory.

## FlexRAN agent
nikaeinn's avatar
nikaeinn committed
63
For the FlexRAN agent-r simply run:
nikaeinn's avatar
nikaeinn committed
64
```
nikaeinn's avatar
nikaeinn committed
65
git submodule update agent-r
nikaeinn's avatar
nikaeinn committed
66
67
```
The source code of the agent will be cloned and can be found in the 
nikaeinn's avatar
nikaeinn committed
68
**agent-r** directory.
nikaeinn's avatar
nikaeinn committed
69

nikaeinn's avatar
nikaeinn committed
70
## FlexCN agent
nikaeinn's avatar
nikaeinn committed
71
For the FlexCN agent-c simply run:
nikaeinn's avatar
nikaeinn committed
72
```
nikaeinn's avatar
nikaeinn committed
73
git submodule update agent-c
nikaeinn's avatar
nikaeinn committed
74
```
nikaeinn's avatar
nikaeinn committed
75
The source code of the agent will be cloned and can be found in the 
nikaeinn's avatar
nikaeinn committed
76
**agent-c** directory.