Name | AIMM-simulator JSON |
Version |
2.0.3
JSON |
| download |
home_page | |
Summary | AIMM 5G system-level simulator (development for the AIMM project https://aimm.celticnext.eu) |
upload_time | 2023-07-09 10:54:05 |
maintainer | |
docs_url | None |
author | |
requires_python | >=3.8 |
license | |
keywords |
5g
cellular radio
simulation
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
AIMM 5G system simulator
------------------------
The AIMM simulator emulates a cellular radio system roughly following 5G concepts and channel models. The intention is to have an easy-to-use and fast system written in pure Python with minimal dependencies. It is especially designed to be suitable for interfacing to AI engines such as ``tensorflow`` or ``pytorch``, and it is not a principal aim for it to be extremely accurate at the level of the radio channel. The simulator was developed for the AIMM project (<https://aimm.celticnext.eu>) by Keith Briggs (<https://keithbriggs.info>).
The full documentation is at <https://aimm-simulator.readthedocs.io/en/latest/>.
Software dependencies
---------------------
1. Python 3.8 or higher <https://python.org>.
2. NumPy <https://numpy.org/>.
3. Simpy <https://pypi.org/project/simpy/>.
4. If real-time plotting is needed, matplotlib <https://matplotlib.org>.
Installation
------------
Three ways are possible:
* The simplest way, direct from PyPI: ``pip install AIMM-simulator``. This will not always get the latest version.
* Download the wheel, typically ``dist/aimm_simulator-2.x.y-py3-none-any.whl`` from github, and run ``pip install <wheel>``.
* Alternatively, the package can be installed by downloading the complete repository (using the green ``<> Code ⌄`` button) as a zip, unpacking it, and then doing ``make install_local`` from inside the unpacked zip.
After installation, run a test with ``python3 examples/basic_test.py``.
Simulator block diagram
-----------------------
The diagram below (not visible on pypi.org) shows the main classes in the code and the relationships between them.
![AIMM Simulator block diagram](https://github.com/keithbriggs/AIMM-simulator/blob/main/doc/sphinx_source/AIMM_Simulator_block_diagram.png)
Raw data
{
"_id": null,
"home_page": "",
"name": "AIMM-simulator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "5G,cellular radio,simulation",
"author": "",
"author_email": "Keith Briggs <k.briggs73@btinternet.com>",
"download_url": "https://files.pythonhosted.org/packages/3a/b8/fb4d3bf40661422e03f27028f7a1e4ae4363b7b3dae420a08451b3145533/aimm_simulator-2.0.3.tar.gz",
"platform": null,
"description": "AIMM 5G system simulator\n------------------------\n\nThe AIMM simulator emulates a cellular radio system roughly following 5G concepts and channel models. The intention is to have an easy-to-use and fast system written in pure Python with minimal dependencies. It is especially designed to be suitable for interfacing to AI engines such as ``tensorflow`` or ``pytorch``, and it is not a principal aim for it to be extremely accurate at the level of the radio channel. The simulator was developed for the AIMM project (<https://aimm.celticnext.eu>) by Keith Briggs (<https://keithbriggs.info>).\n\nThe full documentation is at <https://aimm-simulator.readthedocs.io/en/latest/>.\n\nSoftware dependencies\n---------------------\n\n1. Python 3.8 or higher <https://python.org>.\n2. NumPy <https://numpy.org/>. \n3. Simpy <https://pypi.org/project/simpy/>.\n4. If real-time plotting is needed, matplotlib <https://matplotlib.org>.\n\nInstallation\n------------\n\nThree ways are possible:\n\n* The simplest way, direct from PyPI: ``pip install AIMM-simulator``. This will not always get the latest version.\n\n* Download the wheel, typically ``dist/aimm_simulator-2.x.y-py3-none-any.whl`` from github, and run ``pip install <wheel>``.\n\n* Alternatively, the package can be installed by downloading the complete repository (using the green ``<> Code \u2304`` button) as a zip, unpacking it, and then doing ``make install_local`` from inside the unpacked zip. \n\nAfter installation, run a test with ``python3 examples/basic_test.py``.\n\n\nSimulator block diagram\n-----------------------\n\nThe diagram below (not visible on pypi.org) shows the main classes in the code and the relationships between them. \n\n![AIMM Simulator block diagram](https://github.com/keithbriggs/AIMM-simulator/blob/main/doc/sphinx_source/AIMM_Simulator_block_diagram.png)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "AIMM 5G system-level simulator (development for the AIMM project https://aimm.celticnext.eu)",
"version": "2.0.3",
"project_urls": {
"documentation": "https://aimm-simulator.readthedocs.io/en/latest/",
"homepage": "https://github.com/keithbriggs/AIMM-simulator"
},
"split_keywords": [
"5g",
"cellular radio",
"simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c1bc55c12f4162b13b8a2487e0d686792559d3c57b1f9024ac360c4ce5663c35",
"md5": "811fca1790229b55b529ff102670fdd3",
"sha256": "f3ad55b6b5dc3f82d2ecdde2c6f83572929862705e67eae89d80c8a28ca7cb14"
},
"downloads": -1,
"filename": "aimm_simulator-2.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "811fca1790229b55b529ff102670fdd3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 43944,
"upload_time": "2023-07-09T10:54:02",
"upload_time_iso_8601": "2023-07-09T10:54:02.634348Z",
"url": "https://files.pythonhosted.org/packages/c1/bc/55c12f4162b13b8a2487e0d686792559d3c57b1f9024ac360c4ce5663c35/aimm_simulator-2.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ab8fb4d3bf40661422e03f27028f7a1e4ae4363b7b3dae420a08451b3145533",
"md5": "1719024a74b120fa04593caccdd13938",
"sha256": "722201aaa50de53a9efa7cdec80e0e064780ac8a7b5b3fe2093c2434de702af7"
},
"downloads": -1,
"filename": "aimm_simulator-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "1719024a74b120fa04593caccdd13938",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1723695,
"upload_time": "2023-07-09T10:54:05",
"upload_time_iso_8601": "2023-07-09T10:54:05.168842Z",
"url": "https://files.pythonhosted.org/packages/3a/b8/fb4d3bf40661422e03f27028f7a1e4ae4363b7b3dae420a08451b3145533/aimm_simulator-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-09 10:54:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "keithbriggs",
"github_project": "AIMM-simulator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "aimm-simulator"
}