Metadata-Version: 2.4
Name: neoradium
Version: 0.5.3
Summary: NeoRadium 3GPP 5G NR wireless communication python library
Home-page: https://github.com/InterDigitalInc/NeoRadium
Author: Shahab Hamidi-Rad
Author-email: shahab.hamidi-rad@interdigital.com
License: InterDigital Limited Software Evaluation License
Project-URL: Source, https://github.com/InterDigitalInc/NeoRadium
Project-URL: Documentation, https://interdigitalinc.github.io/NeoRadium/
Project-URL: Bug Tracker, https://github.com/InterDigitalInc/NeoRadium/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10, <4
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24.0
Requires-Dist: matplotlib
Requires-Dist: jupyterlab
Requires-Dist: scipy
Requires-Dist: Pillow
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<img src="https://raw.githubusercontent.com/InterDigitalInc/NeoRadium/main/NeoRadium.png" alt="NeoRadium" width="400px"/>

[![version](https://img.shields.io/pypi/v/neoradium)](https://pypi.org/project/neoradium/)
[![Python versions](https://img.shields.io/pypi/pyversions/neoradium)](https://pypi.org/project/neoradium/)
[![Docs](https://img.shields.io/badge/docs-online-brightgreen)](https://interdigitalinc.github.io/NeoRadium/)

**NeoRadium** is a Python library for simulating end-to-end wireless communication systems based on the latest **3GPP 5G NR** standards. Its object-oriented design abstracts much of the complexity involved in physical-layer modeling, enabling researchers and engineers to rapidly build, customize, and evaluate communication pipelines using standard Python workflows.

<img src="https://raw.githubusercontent.com/InterDigitalInc/NeoRadium/main/Playground/RayTracing/AnimateLA.gif" alt="AnimateLA"/>

In many wireless communication projects, the primary focus is a specific component of the physical layer, such as channel estimation, equalization, precoding, beam management, scheduling, or channel coding. Implementing an entire standards-compliant communication pipeline simply to evaluate a single algorithm can be time-consuming and error-prone. **NeoRadium** addresses this challenge by providing a comprehensive 3GPP-based simulation framework that allows researchers to focus on the components they care about while leveraging a complete, interoperable end-to-end system.

**NeoRadium** is designed to run on standard desktop and laptop computers without requiring specialized hardware, complex software stacks, or GPUs. If your system supports Python 3.10 or later, you can start exploring and developing communication-system simulations immediately.

The project includes a comprehensive **Playground** containing numerous tutorials and examples presented as **Jupyter Notebooks**. These notebooks demonstrate key APIs, explain core concepts, and provide practical examples ranging from basic resource-grid operations to complete end-to-end 5G NR simulations.

## Documentation

* [Installation Guide](https://interdigitalinc.github.io/NeoRadium/html/source/installation.html)
* [Documentation Home](https://interdigitalinc.github.io/NeoRadium/html/index.html)
* [Playground](https://interdigitalinc.github.io/NeoRadium/html/source/Playground/Playground.html)

## The Playground

The **Playground** directory contains a collection of tutorial notebooks covering the major **NeoRadium** modules and workflows. To run these examples, start a [Jupyter Notebook](https://jupyter.org) server and open the notebooks in your web browser.

The tutorials range from introductory examples to advanced end-to-end simulations and provide a practical way to learn **NeoRadium**'s APIs and capabilities.

## Author
* Shahab Hamidi-Rad, InterDigital AI Lab

## Citation
If you use **NeoRadium** in your work, please cite it as:

```bibtex
@software{Id_AILAB_NeoRadium_2026,
  author  = {Hamidi-Rad, Shahab},
  title   = {NeoRadium},
  version = {0.5.3},
  year    = {2026},
  month   = {September},
  url     = {https://github.com/InterDigitalInc/NeoRadium}
}
```
