Data

Tools

Indexes

Applications

Experiments

Open Source Science

PyNGHam

PyNGHam: A Python library of the NGHam protocol - Published in JOSS (2023)

https://github.com/mgm8/pyngham

Science Score: 95.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
    Found 5 DOI reference(s) in README and JOSS metadata
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

Python library of the NGHam protocol

Basic Info
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 7
Created over 4 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog Contributing License

README.md

PyNGHam

Overview

The PyNGHam library is a Python version of the original NGHam protocol library written in C by Jon Petter Skagmo (LA3JPA).

The original implementation and a further description of the protocol can be found here.

Dependencies

Installing

This library is available in the PyPI repository, and can be installed with the following command:

  • pip install pyngham

Or, directly from the source files:

  • python setup.py install

Documentation

The documentation page is available here. Instructions to build the documentation page are described below.

Contributing instructions are also available here.

Dependencies

Building the Documentation

The documentation pages can be built with Sphinx by running the following command inside the docs folder:

  • make html

Usage Example

The usage of the library is pretty straightforward, after the initialization, there are two methods: one to encode a list of bytes, and other to decode a packet. Below there is a basic usage example:

```python from pyngham import PyNGHam

pngh = PyNGHam()

data = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

pkt = pngh.encode(data)

print("Encoded packet:", pkt)

pl, errors, errors_pos = pngh.decode(pkt)

print("Decoded data:", pl) print("Number of errors:", errors) print("Errors positions:", errors_pos) ```

More usage examples can be found in the documentation page.

License

This project is licensed under LGPLv3 license.

Owner

  • Name: Gabriel Mariano Marcelino
  • Login: mgm8
  • Kind: user
  • Location: Florianópolis - Brazil
  • Company: @spacelab-ufsc

Embedded Systems Engineer & PhD Student

JOSS Publication

PyNGHam: A Python library of the NGHam protocol
Published
January 21, 2023
DOI
Volume 8, Issue 81, Page 4915
Authors
Gabriel Mariano Marcelino ORCID
Space Technology Research Laboratory (SpaceLab), Universidade Federal de Santa Catarina, Senai Institute for Innovation in Embedded Systems (ISI-SE)
Editor
Mehmet Hakan Satman ORCID
Tags
Telecommunications Protocols Ham Radio
View PDF Review Thread Software Archive

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 136
  • Total Committers: 3
  • Avg Commits per committer: 45.333
  • Development Distribution Score (DDS): 0.029
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Gabriel Mariano Marcelino g****8@g****m 132
Mehmet Hakan Satman m****n@g****m 3
Daniel S. Katz d****z@i****g 1
Committer Domains (Top 20 + Academic)
ieee.org: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 3
  • Total pull requests: 27
  • Average time to close issues: 3 months
  • Average time to close pull requests: 19 minutes
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 1.33
  • Average comments per pull request: 0.0
  • Merged pull requests: 27
  • 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
View more stats
Top Authors
Issue Authors
  • mgm8 (2)
  • 0xCoto (1)
Pull Request Authors
  • mgm8 (25)
  • jbytecode (1)
  • danielskatz (1)
Top Labels
Issue Labels
bug (1) extensions (1) spp (1)
Pull Request Labels
documentation (8) enhancement (1) spp (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 5 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 7
  • Total maintainers: 1
pypi.org: pyngham

PyNGHam library

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 5 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 21.8%
Forks count: 22.7%
Stargazers count: 23.1%
Average: 23.5%
Downloads: 40.1%
Maintainers (1)
mgm8
Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi
  • Sphinx *
  • sphinx-rtd-theme *
requirements.txt pypi
  • crc *
setup.py pypi
  • crc *
.github/workflows/draft-pdf.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/workflows/sphinx-build.yml actions
  • actions/checkout v1 composite
  • actions/upload-artifact v1 composite
  • ammaraskar/sphinx-action master composite
.github/workflows/sphinx-deploy.yml actions
  • actions/checkout v1 composite
  • actions/upload-artifact v1 composite
  • ad-m/github-push-action master composite
  • ammaraskar/sphinx-action master composite
.github/workflows/test.yml actions
  • actions/checkout v2 composite