Commit 5bfb634c authored by Adrian Pino's avatar Adrian Pino
Browse files

Merge branch 'chore/improve-readme' into 'main' 

Chore/improve readme

See merge request !187
parents 593ecc79 fe4796e5

README.md

+17 −15
Original line number Diff line number Diff line
@@ -13,8 +13,8 @@ Open source SDK to abstract CAMARA/GSMA Transformation Functions (TFs) for Edge 


## Features



- Abstract CAMARA Transformation Functions (TFs)

- Unified Python SDK for interacting with Edge Cloud platforms, 5G Core solutions, and O-RAN solutions.

- Abstract CAMARA NBI & GSMA E/WBI Transformation Functions (TFs)

- Unified Python SDK for interacting with Edge Cloud platforms, 5G Core solutions, and O-RAN controllers.

- Modular and extensible adapter structure
@@ -39,19 +39,27 @@ Open source SDK to abstract CAMARA/GSMA Transformation Functions (TFs) for Edge 


### EdgeCloud Platforms



| Platform   | Status     |

| Platform   | Supported     |

|------------|------------|

| Kubernetes | ✅  |

| i2Edge     | ✅  |

| aerOS      | ✅  |

| Kubernetes | Yes  |

| i2Edge     | Yes  |

| aerOS      | Yes  |



### Network Adapters



| Platform     | NEF Version | QoD | Location Retrieval | Traffic Influence |

|--------------|-------------|-----|---------------------|--------------------|

| Open5GS      | [v1.2.3](https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/29122-hc0.zip) TS 29.122 (v17.12.0) | ✅  | ✅                  | ❌                 |

| Open5GCore   | [v1.2.3](https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/29122-hc0.zip) TS 29.122 (v17.12.0) | ✅  | ❌                  | ❌                 |

| OAI          | [v1.2.3](https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/29122-hc0.zip) TS 29.122 (v17.12.0) | ✅  | ❌                  | ✅                 |

| Open5GS      | [v1.2.3](https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/29122-hc0.zip) TS 29.122 (v17.12.0) | Yes  | Yes                  |                  |

| Open5GCore   | [v1.2.3](https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/29122-hc0.zip) TS 29.122 (v17.12.0) | Yes  |                   |                  |

| OAI          | [v1.2.3](https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/29122-hc0.zip) TS 29.122 (v17.12.0) | Yes  |                   | Yes                 |



### O-RAN Adapters



| Platform   | Supported     |

|------------|------------|

| Juniper O-RAN controller | WIP  |

| i2CAT O-RAN controller     | WIP  |





---
@@ -158,12 +166,6 @@ API ->> SDK: network_client.create_qos_session(QOS_SESSION_REQUEST) 
SDK ->> NEF: Equivalent endpoint

NEF ->> 5GS: QoS session creation

```

---



## Roadmap for TF SDK 2nd release



- [ ] Add support to GSMA OPG.02 TFs

- [ ] Include JUNIPER O-RAN adapter



---

pyproject.toml

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" 


[project]

name = "sunrise6g-opensdk"

version = "1.0.15"

version = "1.0.16"

description = "Open source SDK to abstract CAMARA/GSMA Transformation Functions (TFs) for Edge Cloud platforms, 5G network cores and Open RAN solutions."

keywords = [

  "Federation",