Metadata-Version: 2.2
Name: reedsolomon
Version: 0.0.1
Summary: A Python package for Reed-Solomon error correction codes
Home-page: https://github.com/Archange-py/Reed-Solomon_Codes
Author: Archange
Author-email: Archange <archange_paradise@proton.me>
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.
        
Project-URL: Homepage, https://github.com/Archange-py/Reed-Solomon_Codes
Keywords: reedsolomon,POO,error-correcting code
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12.4
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mpmath==1.3.0
Requires-Dist: sympy==1.13.3
Provides-Extra: dev
Requires-Dist: sympy; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: requires-python

<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.
