https://github.com/muhd-umer/comyx

Comyx is an optimized and modular Python library for simulating wireless communication systems

https://github.com/muhd-umer/comyx

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.9%) to scientific vocabulary

Keywords

6g noma numba numpy pytorch ray reinforcement-learning ris scipy simulation star-ris wireless-communication
Last synced: 5 months ago · JSON representation

Repository

Comyx is an optimized and modular Python library for simulating wireless communication systems

Basic Info
Statistics
  • Stars: 15
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 13
Topics
6g noma numba numpy pytorch ray reinforcement-learning ris scipy simulation star-ris wireless-communication
Created almost 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Codeowners

README.md


build GitHub release License view - Documentation NumPy SciPy Numba PyTorch

Comyx is a Python library for simulating wireless communication systems. It uses NumPy and SciPy for numerical computation, and Numba for just-in-time (JIT) compilation. It provides a number of features for simulating wireless communication systems:

  • B5G Features: Supports a variety of B5G specific features, such as STAR-RIS, and NOMA.
  • Channel Models: Provides the AWGN, Rayleigh, and Rician fading models.
  • Signal Modulation: Supports a variety of modulation schemes, such as BPSK, QPSK, and QAM.
  • Performance Metrics: Can calculate a variety of performance metrics, such as the sum rate, and outage probability.

To-Do

  • [ ] Update documentation
  • [ ] Add network optimization support
  • [ ] Add Reinforcement Learning (RL) support

Installation

You can install the latest version of the package using pip:

shell pip install comyx

Note: It is recommended to create a new virtual environment so that updates/downgrades of packages do not break other projects.

Or you can clone the repository along with research code and perform an editable installation:

shell git clone https://github.com/muhd-umer/comyx.git pip install -e .

Reinforcement Learning (RL) Support

For RL support, you will need to install the following dependencies:

  • Install PyTorch (Stable)

    shell pip install torch torchvision torchaudio

  • Install Ray RLlib

    shell pip install -U ray[default] # core, dashboard, cluster launcher pip install -U ray[rllib] # tune, rllib

Owner

  • Name: Muhammad Umer
  • Login: muhd-umer
  • Kind: user
  • Location: Pakistan
  • Company: Student at https://nust.edu.pk/

Always eager to learn anything related to ML/AI systems; Has a lot of fun observing loss curves.

GitHub Events

Total
  • Watch event: 4
  • Push event: 1
  • Fork event: 1
Last Year
  • Watch event: 4
  • Push event: 1
  • Fork event: 1

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 959
  • Total Committers: 1
  • Avg Commits per committer: 959.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 8
  • Committers: 1
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
muhd-umer t****r@g****m 959

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 9 days
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • muhd-umer (5)
  • mahnooranjum (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 83 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 9
  • Total maintainers: 1
pypi.org: comyx

Comyx is an optimized and modular Python library for simulating wireless communication systems.

  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 83 Last month
Rankings
Dependent packages count: 10.0%
Average: 38.1%
Dependent repos count: 66.1%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/build.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
docs/requirements.txt pypi
  • Pygments >=2.6.1
  • ablog *
  • colorama ==0.4.6
  • docutils ==0.16
  • ipykernel *
  • ipython_genutils *
  • matplotlib *
  • numpy ==1.23.5
  • numpydoc *
  • pandas ==2.0.1
  • pydata-sphinx-theme ==0.13.0
  • scikit-learn *
  • scipy ==1.11.1
  • setuptools ==68.0.0
  • sphinx >=3.3.1
  • sphinx-autoapi *
  • sphinx-design *
  • sphinx-favicon *
  • sphinx-togglebutton *
  • sphinx_copybutton *
pyproject.toml pypi