| Name | reedsolomon JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | https://github.com/Archange-py/Reed-Solomon_Codes |
| Summary | A Python package for Reed-Solomon error correction codes |
| upload_time | 2025-01-19 11:40:17 |
| maintainer | None |
| docs_url | None |
| author | Archange |
| requires_python | >=3.12.4 |
| license | MIT License Copyright (c) 2024 Archange Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
reedsolomon
poo
error-correcting code
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
mpmath
sympy
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src=".\Resource\Pictures\picture_2.png" alt="DALL-E Picture">
Image generated with DALL-E
# Reed-Solomon Codes Implementation
Welcome to the **Reed-Solomon codes** GitHub repository! This project is dedicated to exploring Reed-Solomon codes. These codes are crucial in ensuring data integrity in digital communication and storage systems.
## Table of Contents
***
1. [General Info](#general-info)
2. [Getting Started](#getting-started)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [Usage](#usage)
3. [Repository Structure](#repository-structure)
4. [Links](#links)
5. [FAQs](#faqs)
## General Info
Reed-Solomon codes are a type of error-correcting code that operates on blocks of data. They are capable of detecting and correcting multiple symbol errors, making them invaluable in applications such as:
- QR Codes
- Data transmission in satellite and deep-space communication
- Storage devices (CDs, DVDs, Blu-rays)
- RAID storage systems
At present, only algorithms for polynomials and Galois fields are being developed. The construction of a mother class for the Reed-Solomon code will follow naturally.
## Getting Started
### Installation
***
You can use this command from PyPi:
- `pip install reedsolomon`
### Dependencies
***
Use this command in cmd if you are in a virtual environment:
- `pip install -r requirements.txt`
### Usage
***
Here is examples to use the `polynomial.py` file:
- [`example_polynomial.ipynb`](./examples/examples_polynomial.ipynb)
The galois field file:
- [`example_galois_field.ipynb`](./examples/examples_galois_field.ipynb)
And the reed solomon file:
- [`example_reed_solomon.ipynb`](./examples/examples_reed_solomon.ipynb)
## Repository Structure
File composition in the repository :
```plaintext
.
├── resource
│ ├── Documentation # all .pdf and .html
│ └── Picture # for the README
│
├── examples
│ ├── example_reed_solomon.ipynb
| ├── example_galois_field.ipynb
│ └── example_polynomial.ipynb
│
├── tests
│ ├── test_reed_solomon.ipynb
| ├── test_galois_field.ipynb
│ └── test_polynomial.ipynb
|
├── src
│ └── reedsolomon
│ ├── __init__.py
│ ├── __main__.py
│ ├── polynomial.py
│ ├── reedsolomon.py
│ └── galoisfield.py
│
├── LICENSE
├── README.md
├── TODO.md
├── notes.txt
├── requirements.txt
├── MANIFEST.in
├── pyproject.toml
├── setup.py
└── .gitignore
```
## Links
Here you'll find the various resources used to complete this project:
- Resources sites
- [Reed-Solomon Codes (Wikipedia)](https://en.wikipedia.org/wiki/Reed%E2%80%93Solomon_error_correction)
- [Reed-Solomon Codes for coders (Wikiversity)](https://en.wikiversity.org/wiki/Reed%E2%80%93Solomon_codes_for_coders)
- [An introduction to Reed-Solomon codes: principles, architecture and implementation](https://www.cs.cmu.edu/~guyb/realworld/reedsolomon/reed_solomon_codes.html)
- [Finite Field Arithmetic and Reed Solomon Coding - Russ Cox](https://research.swtch.com/field)
- GitHub resources:
- [Pure Python implementation](https://github.com/lrq3000/unireedsolomon)
- [Optimized Python implementation](https://github.com/tomerfiliba-org/reedsolomon)
- [PDF resources](./Resource/Documentation/):
- [CRC and Reed Solomon ECC - Jeff Reid.pdf](./Resource/Documentation/CRC_and_Reed_Solomon_ECC%20-%20Jeff%20Reid.pdf)
- [Implementing Reed Solomon - Andrew Brown.pdf](./Resource/Documentation/Implementing_Reed_Solomon%20-%20Andrew%20Brown.pdf)
- [Decoding Reed Solomon - Bruce Maggs.pdf](./Resource/Documentation/Decoding_Reed_Solomon%20-%20Bruce%20Maggs.pdf)
- [Reed Solomon codes for coders - Wikiversity.pdf](./Resource/Documentation/Reed_Solomon_codes_for_coders%20-%20Wikiversity.pdf)
- [Reed Solomon Scribe - Inconnu(e).pdf](./Resource/Documentation/Reed_Solomon_Scribe%20-%20Inconnu(e).pdf)
- [WHP 031 - C.K.P. Clarke.pdf](./Resource/Documentation/WHP%20031%20-%20C.%20K.%20P.%20Clarke.pdf)
## FAQs
For the moment there is none.
Raw data
{
"_id": null,
"home_page": "https://github.com/Archange-py/Reed-Solomon_Codes",
"name": "reedsolomon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12.4",
"maintainer_email": null,
"keywords": "reedsolomon, POO, error-correcting code",
"author": "Archange",
"author_email": "Archange <archange_paradise@proton.me>",
"download_url": "https://files.pythonhosted.org/packages/8a/45/e00b3833c6012fa2cde5a4e48c01f857692b2193d518b660f575b784eed5/reedsolomon-0.0.1.tar.gz",
"platform": null,
"description": "<img src=\".\\Resource\\Pictures\\picture_2.png\" alt=\"DALL-E Picture\"> \r\n\r\nImage generated with DALL-E\r\n\r\n# Reed-Solomon Codes Implementation\r\n\r\nWelcome to the **Reed-Solomon codes** GitHub repository! This project is dedicated to exploring Reed-Solomon codes. These codes are crucial in ensuring data integrity in digital communication and storage systems.\r\n\r\n## Table of Contents\r\n***\r\n1. [General Info](#general-info)\r\n2. [Getting Started](#getting-started) \r\n - [Installation](#installation) \r\n - [Dependencies](#dependencies)\r\n - [Usage](#usage)\r\n3. [Repository Structure](#repository-structure)\r\n4. [Links](#links)\r\n5. [FAQs](#faqs)\r\n\r\n## General Info\r\n\r\nReed-Solomon codes are a type of error-correcting code that operates on blocks of data. They are capable of detecting and correcting multiple symbol errors, making them invaluable in applications such as:\r\n\r\n- QR Codes\r\n- Data transmission in satellite and deep-space communication\r\n- Storage devices (CDs, DVDs, Blu-rays)\r\n- RAID storage systems\r\n\r\nAt present, only algorithms for polynomials and Galois fields are being developed. The construction of a mother class for the Reed-Solomon code will follow naturally.\r\n\r\n\r\n## Getting Started\r\n\r\n### Installation\r\n***\r\n\r\nYou can use this command from PyPi:\r\n- `pip install reedsolomon`\r\n\r\n\r\n### Dependencies\r\n***\r\n\r\nUse this command in cmd if you are in a virtual environment:\r\n- `pip install -r requirements.txt`\r\n\r\n\r\n### Usage \r\n***\r\n\r\nHere is examples to use the `polynomial.py` file: \r\n- [`example_polynomial.ipynb`](./examples/examples_polynomial.ipynb)\r\n\r\nThe galois field file:\r\n- [`example_galois_field.ipynb`](./examples/examples_galois_field.ipynb)\r\n\r\nAnd the reed solomon file:\r\n- [`example_reed_solomon.ipynb`](./examples/examples_reed_solomon.ipynb)\r\n\r\n\r\n## Repository Structure\r\n\r\nFile composition in the repository :\r\n\r\n```plaintext\r\n. \r\n\u251c\u2500\u2500 resource \r\n\u2502 \u251c\u2500\u2500 Documentation # all .pdf and .html \r\n\u2502 \u2514\u2500\u2500 Picture # for the README \r\n\u2502\r\n\u251c\u2500\u2500 examples \r\n\u2502 \u251c\u2500\u2500 example_reed_solomon.ipynb \r\n| \u251c\u2500\u2500 example_galois_field.ipynb \r\n\u2502 \u2514\u2500\u2500 example_polynomial.ipynb \r\n\u2502\r\n\u251c\u2500\u2500 tests \r\n\u2502 \u251c\u2500\u2500 test_reed_solomon.ipynb \r\n| \u251c\u2500\u2500 test_galois_field.ipynb \r\n\u2502 \u2514\u2500\u2500 test_polynomial.ipynb \r\n|\r\n\u251c\u2500\u2500 src \r\n\u2502 \u2514\u2500\u2500 reedsolomon\r\n\u2502 \u251c\u2500\u2500 __init__.py\r\n\u2502 \u251c\u2500\u2500 __main__.py\r\n\u2502 \u251c\u2500\u2500 polynomial.py\r\n\u2502 \u251c\u2500\u2500 reedsolomon.py\r\n\u2502 \u2514\u2500\u2500 galoisfield.py\r\n\u2502\r\n\u251c\u2500\u2500 LICENSE\r\n\u251c\u2500\u2500 README.md\r\n\u251c\u2500\u2500 TODO.md\r\n\u251c\u2500\u2500 notes.txt\r\n\u251c\u2500\u2500 requirements.txt\r\n\u251c\u2500\u2500 MANIFEST.in\r\n\u251c\u2500\u2500 pyproject.toml\r\n\u251c\u2500\u2500 setup.py\r\n\u2514\u2500\u2500 .gitignore\r\n```\r\n\r\n## Links\r\n\r\nHere you'll find the various resources used to complete this project:\r\n\r\n- Resources sites\r\n - [Reed-Solomon Codes (Wikipedia)](https://en.wikipedia.org/wiki/Reed%E2%80%93Solomon_error_correction)\r\n\r\n - [Reed-Solomon Codes for coders (Wikiversity)](https://en.wikiversity.org/wiki/Reed%E2%80%93Solomon_codes_for_coders)\r\n\r\n - [An introduction to Reed-Solomon codes: principles, architecture and implementation](https://www.cs.cmu.edu/~guyb/realworld/reedsolomon/reed_solomon_codes.html)\r\n\r\n - [Finite Field Arithmetic and Reed Solomon Coding - Russ Cox](https://research.swtch.com/field)\r\n\r\n- GitHub resources:\r\n - [Pure Python implementation](https://github.com/lrq3000/unireedsolomon)\r\n\r\n - [Optimized Python implementation](https://github.com/tomerfiliba-org/reedsolomon)\r\n\r\n- [PDF resources](./Resource/Documentation/):\r\n - [CRC and Reed Solomon ECC - Jeff Reid.pdf](./Resource/Documentation/CRC_and_Reed_Solomon_ECC%20-%20Jeff%20Reid.pdf)\r\n\r\n - [Implementing Reed Solomon - Andrew Brown.pdf](./Resource/Documentation/Implementing_Reed_Solomon%20-%20Andrew%20Brown.pdf)\r\n\r\n - [Decoding Reed Solomon - Bruce Maggs.pdf](./Resource/Documentation/Decoding_Reed_Solomon%20-%20Bruce%20Maggs.pdf)\r\n\r\n - [Reed Solomon codes for coders - Wikiversity.pdf](./Resource/Documentation/Reed_Solomon_codes_for_coders%20-%20Wikiversity.pdf)\r\n\r\n - [Reed Solomon Scribe - Inconnu(e).pdf](./Resource/Documentation/Reed_Solomon_Scribe%20-%20Inconnu(e).pdf)\r\n\r\n - [WHP 031 - C.K.P. Clarke.pdf](./Resource/Documentation/WHP%20031%20-%20C.%20K.%20P.%20Clarke.pdf)\r\n\r\n## FAQs\r\n\r\nFor the moment there is none.\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Archange Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A Python package for Reed-Solomon error correction codes",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/Archange-py/Reed-Solomon_Codes"
},
"split_keywords": [
"reedsolomon",
" poo",
" error-correcting code"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5dcb1ed3e414c1d2bb524bcce787ca6b8fe49915812b70db2d826f88fade64d",
"md5": "871cabce1f151cfd822a61577c22266c",
"sha256": "e1f554d6f529b522f89d6db3b303592dae2313a70dd9ca97523b05d1295895e7"
},
"downloads": -1,
"filename": "reedsolomon-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "871cabce1f151cfd822a61577c22266c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12.4",
"size": 13645,
"upload_time": "2025-01-19T11:40:12",
"upload_time_iso_8601": "2025-01-19T11:40:12.329533Z",
"url": "https://files.pythonhosted.org/packages/e5/dc/b1ed3e414c1d2bb524bcce787ca6b8fe49915812b70db2d826f88fade64d/reedsolomon-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a45e00b3833c6012fa2cde5a4e48c01f857692b2193d518b660f575b784eed5",
"md5": "51620a927f4b0648815ba28d2d2f0253",
"sha256": "503b782d1d36bc1ca101b95a7d718bb6dd1790689690e392cf63e2aecf913140"
},
"downloads": -1,
"filename": "reedsolomon-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "51620a927f4b0648815ba28d2d2f0253",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12.4",
"size": 4124877,
"upload_time": "2025-01-19T11:40:17",
"upload_time_iso_8601": "2025-01-19T11:40:17.244432Z",
"url": "https://files.pythonhosted.org/packages/8a/45/e00b3833c6012fa2cde5a4e48c01f857692b2193d518b660f575b784eed5/reedsolomon-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 11:40:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Archange-py",
"github_project": "Reed-Solomon_Codes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "mpmath",
"specs": [
[
"==",
"1.3.0"
]
]
},
{
"name": "sympy",
"specs": [
[
"==",
"1.13.3"
]
]
}
],
"lcname": "reedsolomon"
}
