3GPP-based 5G/6G Metamodel

metamodel_3gpp is a Pydantic-based, implementation-agnostic model of 5G/6G mobile networks built around 3GPP concepts.

It describes network topology, services, and deployment configuration independently of any implementation, orchestrator, or vendor. This shared representation supports experiments, testbeds, simulations, and reproducible deployments across different environments.

Key concepts

The metamodel separates the logical description of a network from the details of how a particular implementation deploys it. It provides typed, validation-friendly models that are easy to serialize and extend.

The main models are:

Installation

Install the package from PyPI:

pip install metamodel_3gpp

Or install the latest source from GitHub:

git clone https://github.com/ifran-project/metamodel_3gpp.git
cd metamodel_3gpp
pip install -e .

Quick start

Create a network using the default topology:

from metamodel_3gpp import MetaModel

network = MetaModel()

# Export as JSON-compatible data or YAML
print(network.model_dump(mode="json"))
print(network.to_yaml())

The default topology includes:

• A 5G core with amf, ausf, bsf, nssf, nrf, pcf, smf, upf, udm, and udr
• One RAN gNB
• One simulated radio unit (sim_ru)
• One UE (sim_ue)
• One network slice (internet)
• One RIC instance (ric)

Custom networks

Build a network from a YAML configuration with MetaModel.from_yaml():

from metamodel_3gpp import MetaModel

network = MetaModel.from_yaml_file("network.yaml")

print(network.to_yaml(exclude_defaults=False))

A network configuration is organized around these top-level sections:

core:
  components: {}  # Core network functions

ran:
  components: {}  # RAN components, such as gNBs

ric:
  components: {}  # RIC components

rus: {}            # Radio units
ues: {}            # UE profiles and subscriptions
slices: {}         # Network slices and DNNs

Add component-specific configuration under the relevant section. All the models provide helpers for loading YAML or JSON from text or files.

Contributing

Contributions are welcome. To add or improve network concepts, extend the metamodel with additional typed fields or model classes and submit a pull request.

License

Distributed under the BSD 3-Clause Clear license. See LICENSE for details.