README.md 1.78 KB
Newer Older
nikaeinn committed
1
# Subscribe and Get the MOSAIC5G Ecosystem  
nikaeinn committed
2
M5G is an ecosystem of opensource platforms and use-cases for 4G-5G R&D to build a light-weight 5G service delivery platform across reusable software components. 
nikaeinn committed
3

nikaeinn committed
4
Mosaic-5G is composed of the following submodules:
nikaeinn committed
5

nikaeinn committed
6
* The network Store 
nikaeinn committed
7 8
* The JOX juju orchestrator
* The LL-MEC low latency MEC platform
nikaeinn committed
9 10 11
* The FlexRAN for real-time master controller
* The OAI-RAN for monolitic and disaggregated RAN
* The OAI-CN  for monolitic and disaggregated CN
nikaeinn committed
12 13

This repository is designed to serve as a meta repository from where each 
nikaeinn committed
14
submodules can be pulled. Follow the instructions below to get the modules and build your platform.
nikaeinn committed
15 16


nikaeinn committed
17
1  Read, sign, and send the [terms of use]()
nikaeinn committed
18

nikaeinn committed
19
1. Create a gitlab account at [gitlab.eurecom.fr](http://gitlab.eurecom.fr) page, and follow the instructions to create a user acount.
nikaeinn committed
20

nikaeinn committed
21
1. Subscribe to [**Mosaic5G**](mailto:mosaic5g_users@lists.eurecom.fr) by clicking at [subscribe](mailto:mailto:mosaic5g_users@lists.eurecom.fr?subject=subscribe mosaic5g_users YourGitAccount YourFirstName YourLastName) and replace the following placeholders "YourGitAccount" "YourFirstName" "YourLastName"
nikaeinn committed
22

nikaeinn committed
23
1. Clone this repository:  `git clone http://gitlab.eurecom.fr/mosaic5g/mosaic5g.git`
nikaeinn committed
24

nikaeinn committed
25
1. Build all the platforms from source or Snap  
nikaeinn committed
26
    * From Source: `./build_m5g -m `
nikaeinn committed
27 28 29 30 31
    * From Snap:   `./build_m5g -M `

1. Buil specific platform from source or Snap
    * FlexRAN: `./build_m5g -f ` or `./build_m5g -F `
    * LL-MEC: `./build_m5g -l `  or `./build_m5g -L `
nikaeinn committed
32 33
    * JOX: `./build_m5g -j `
    * STORE: `./build_m5g -s `
nikaeinn committed
34 35 36
    * OAI-RAN: `./build_m5g -r `  or `./build_m5g -R `
    * OAI-CN: `./build_m5g -c `  or `./build_m5g -C `

nikaeinn committed
37 38 39 40 41
1. Check the help of build_m5g:
    * `./build_m5g -h `


For manual operation, please have a look at the build_m5g script.