py3gpp


Namepy3gpp JSON
Version 0.3.2 PyPI version JSON
download
home_page
SummaryFunctions for 5G NR signal processing
upload_time2023-11-03 09:48:01
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords
VCS
bugtrack_url
requirements pylint anybadge pytest pytest-xdist importlib_resources
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![CI](https://github.com/catkira/py3gpp/actions/workflows/lint_and_test.yml/badge.svg)](https://github.com/catkira/py3gpp/actions/workflows/lint_and_test.yml)
[![Pylint](https://catkira.github.io/py3gpp/pylint.svg)](https://github.com/catkira/py3gpp/actions/workflows/python-package.yml)
[![PyPI version](https://badge.fury.io/py/py3gpp.svg)](https://badge.fury.io/py/py3gpp)
[![Downloads](https://static.pepy.tech/badge/py3gpp)](https://pepy.tech/project/py3gpp)

# Summary
This python package aims to replace the Matlab 5G Toolbox in Python. The call syntax of functions is the same as in matlab where possible. There are some differences, because matlab allows to continuously index a multidimensional array in one axis. In python this is not possible, therefore the result of functions like nrPBCHIndices() is also multidimensional here to make it compatible with Python.

# Installation
'python3 -m pip install py3gpp'
or
clone this repo and then do 'python3 -m pip install -e .'

# Getting started
run 'examples/test_py3gpp.ipynb'

The example data is ideal data generated with Matlab, but the code has been tested with real data that has CFO, SFO and noise.

# Documentation
See Matlab documentation of equivalent function

# Coding Guideline
## Formatting
* Screen width 120
* spaces on each side of math operators like +-*/
## Testing
* Each function must have a hard-coded test that can run on CI
* Each function should have a Matlab test that can run on a machine with Matlab license
* Hard-coded test cases should cover the most common argument combinations
* Matlab tests should cover more argument combinations than the hard-coded tests
## Function interface
* Functions should return numpy arrays if the return value is an array
* Functions should accept numpy arrays and python lists if an input value is an array
* Config objects should have a getter and setter method and declare the internal variable with underscore at the beginning
* Input arguments should be checked and a 'ValueError' or 'TypeError' should be raised if an argument is not correct

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "py3gpp",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "Benjamin Menk\u00fcc <benjamin@menkuec.de>",
    "download_url": "https://files.pythonhosted.org/packages/92/ec/24547e87c5055b0ad5ab954d8c92cf8d53a604c4f38dc76cd7ee57cc7483/py3gpp-0.3.2.tar.gz",
    "platform": null,
    "description": "[![CI](https://github.com/catkira/py3gpp/actions/workflows/lint_and_test.yml/badge.svg)](https://github.com/catkira/py3gpp/actions/workflows/lint_and_test.yml)\n[![Pylint](https://catkira.github.io/py3gpp/pylint.svg)](https://github.com/catkira/py3gpp/actions/workflows/python-package.yml)\n[![PyPI version](https://badge.fury.io/py/py3gpp.svg)](https://badge.fury.io/py/py3gpp)\n[![Downloads](https://static.pepy.tech/badge/py3gpp)](https://pepy.tech/project/py3gpp)\n\n# Summary\nThis python package aims to replace the Matlab 5G Toolbox in Python. The call syntax of functions is the same as in matlab where possible. There are some differences, because matlab allows to continuously index a multidimensional array in one axis. In python this is not possible, therefore the result of functions like nrPBCHIndices() is also multidimensional here to make it compatible with Python.\n\n# Installation\n'python3 -m pip install py3gpp'\nor\nclone this repo and then do 'python3 -m pip install -e .'\n\n# Getting started\nrun 'examples/test_py3gpp.ipynb'\n\nThe example data is ideal data generated with Matlab, but the code has been tested with real data that has CFO, SFO and noise.\n\n# Documentation\nSee Matlab documentation of equivalent function\n\n# Coding Guideline\n## Formatting\n* Screen width 120\n* spaces on each side of math operators like +-*/\n## Testing\n* Each function must have a hard-coded test that can run on CI\n* Each function should have a Matlab test that can run on a machine with Matlab license\n* Hard-coded test cases should cover the most common argument combinations\n* Matlab tests should cover more argument combinations than the hard-coded tests\n## Function interface\n* Functions should return numpy arrays if the return value is an array\n* Functions should accept numpy arrays and python lists if an input value is an array\n* Config objects should have a getter and setter method and declare the internal variable with underscore at the beginning\n* Input arguments should be checked and a 'ValueError' or 'TypeError' should be raised if an argument is not correct\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Functions for 5G NR signal processing",
    "version": "0.3.2",
    "project_urls": {
        "Homepage": "https://github.com/catkira/py3gpp"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "02ce15d1aecf6cb6ee124143fa88caf8b3d06718f9b2d4151867b388c0ddeb25",
                "md5": "eec3553a3f2a8340cd10d5e3b470bd54",
                "sha256": "e54a2f454f4e63d6e49bcad59a5356515edbb6a0a8a6d1830a282d6f60dc8cff"
            },
            "downloads": -1,
            "filename": "py3gpp-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "eec3553a3f2a8340cd10d5e3b470bd54",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 67230,
            "upload_time": "2023-11-03T09:47:59",
            "upload_time_iso_8601": "2023-11-03T09:47:59.885801Z",
            "url": "https://files.pythonhosted.org/packages/02/ce/15d1aecf6cb6ee124143fa88caf8b3d06718f9b2d4151867b388c0ddeb25/py3gpp-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "92ec24547e87c5055b0ad5ab954d8c92cf8d53a604c4f38dc76cd7ee57cc7483",
                "md5": "6341d25f1086a562b6f8b6fcd3e02f22",
                "sha256": "2c36db323c8f9b96b600e0e488fbe2a131c32191f1f9e17cf1ffdf3e07977cfb"
            },
            "downloads": -1,
            "filename": "py3gpp-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "6341d25f1086a562b6f8b6fcd3e02f22",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 67847,
            "upload_time": "2023-11-03T09:48:01",
            "upload_time_iso_8601": "2023-11-03T09:48:01.602095Z",
            "url": "https://files.pythonhosted.org/packages/92/ec/24547e87c5055b0ad5ab954d8c92cf8d53a604c4f38dc76cd7ee57cc7483/py3gpp-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-03 09:48:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "catkira",
    "github_project": "py3gpp",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "pylint",
            "specs": []
        },
        {
            "name": "anybadge",
            "specs": []
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "pytest-xdist",
            "specs": []
        },
        {
            "name": "importlib_resources",
            "specs": []
        }
    ],
    "lcname": "py3gpp"
}
        
Elapsed time: 0.15892s