PyPI - OptiCommPy - Versions diffs - 0.9.0__tar.gz → 0.10.0__tar.gz - Mend

OptiCommPy 0.9.0tar.gz → 0.10.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

{OptiCommPy-0.9.0 → OptiCommPy-0.10.0/OptiCommPy.egg-info}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OptiCommPy
-Version: 0.9.0
+Version: 0.10.0
 Summary: Optical Communications Algorithms with Python
 Home-page: https://github.com/edsonportosilva/OptiCommPy
 Maintainer: Edson Porto da Silva
@@ -35,7 +35,7 @@ components of fiber optic communication systems, for educational and research pu
      :width: 600px
      :align: center
-|PyPI| |PyPI - Downloads| |Documentation Status| |DOI|
+|PyPI| |PyPI - Downloads| |Documentation Status| |DOI| |JOSS|
 Available features
 ------------------
@@ -58,8 +58,9 @@ Available features
    -  *Several NxN MIMO adaptive equalization algorithms*.
    -  *Carrier phase recovery algorithms.*
+-  Functions to implement forward error correction (FEC) encoders and decoders.
 -  For most of the cases, `Numba <https://numba.pydata.org/>`__ is used
-   to speed up the core DSP functions.
+   to speed up the code.
 -  Evaluate transmission performance with metrics such as:
    -  *Bit-error-rate* (BER).
@@ -75,9 +76,15 @@ Available features
 How can I contribute?
 ---------------------
-If you want to contribute to this project, implement the feature you
-want and send me a pull request. If you want to suggest new features or
-discuss anything related to OptiCommPy, please get in touch with me
+- If you want to contribute to this project:
+   - Create a new issue in the GitHub repository to discuss the feature you want to implement.
+   - Fork the repository and create a new branch.
+   - Make sure you have the latest version of the code.
+   - Check the conventions adopted in the code writing (e.g. naming conventions, docstrings, etc.).
+   - Remember to write an example of usage for the new feature you are implementing.
+   - After the process is finished, send a pull request.
+- If you want to suggest or discuss anything related to OptiCommPy, please get in touch via e-mail
 (edsonporto88@gmail.com).
 Requirements/Dependencies
@@ -87,14 +94,15 @@ Requirements/Dependencies
 -  numpy>=1.24.4
 -  scipy>=1.13.0
 -  matplotlib>=3.7.0
--  numba>=0.54.1,<=0.57.0
+-  numba>=0.54.1
 -  tqdm>=4.64.1
 -  simple-pid>=1.0.1
 -  mpl-scatter-density>=0.7.0
 -  sphinx-rtd-theme>=1.2.2
 -  nbsphinx>=0.9.3
 -  nbsphinx-link>=1.3.0
--  cupy-cuda12x >= 13.1.0 (optional, in case GPU processing is desired)
+-  prettytable>=3.16.0
+-  cupy-cuda12x>=13.1.0 (optional, in case GPU processing is desired)
 Installation
 ------------
@@ -123,16 +131,16 @@ You can find the latest documentation in
 Citing this repository
 ----------------------
-Edson Porto da Silva, Adolfo Herbster, Carlos Daniel Fontes da Silva, &
-Joaquin Matres. (2023). edsonportosilva/OptiCommPy: v0.7.0-alpha
-(v0.7.0-alpha). Zenodo. https://doi.org/10.5281/zenodo.10304945
+Edson Porto da Silva, Adolfo Fernandes Herbster. "OptiCommPy: Open-source Simulation of Fiber Optic Communications with Python", *Journal of Open Source Software*, 9(98), 6600, (2024) https://doi.org/10.21105/joss.06600
 .. |PyPI| image:: https://img.shields.io/pypi/v/OptiCommPy?label=pypi%20package
 .. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/OptiCommPy
 .. |Documentation Status| image:: https://readthedocs.org/projects/opticommpy/badge/?version=latest
    :target: https://opticommpy.readthedocs.io/en/latest/?badge=latest
-.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10304945.svg
-   :target: https://doi.org/10.5281/zenodo.10304945
+.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.11450597.svg
+   :target: https://doi.org/10.5281/zenodo.11450597
+.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.06600/status.svg
+   :target: https://doi.org/10.21105/joss.06600

{OptiCommPy-0.9.0 → OptiCommPy-0.10.0}/OptiCommPy.egg-info/SOURCES.txt RENAMED Viewed

@@ -10,10 +10,13 @@ OptiCommPy.egg-info/top_level.txt
 optic/__init__.py
 optic/plot.py
 optic/utils.py
+optic/comm/fec.py
 optic/comm/metrics.py
 optic/comm/modulation.py
 optic/comm/ofdm.py
+optic/comm/sources.py
 optic/dsp/carrierRecovery.py
+optic/dsp/carrierRecoveryGPU.py
 optic/dsp/clockRecovery.py
 optic/dsp/core.py
 optic/dsp/coreGPU.py
@@ -22,6 +25,7 @@ optic/models/amplification.py
 optic/models/channels.py
 optic/models/devices.py
 optic/models/modelsGPU.py
+optic/models/perturbation.py
 optic/models/tx.py
 tests/test_dsp.py
 tests/test_metrics.py

{OptiCommPy-0.9.0 → OptiCommPy-0.10.0}/OptiCommPy.egg-info/requires.txt RENAMED Viewed

@@ -3,9 +3,10 @@ scipy>=1.13.0
 matplotlib>=3.7.0
 sympy
 tqdm>=4.64.1
-numba<=0.57,>=0.54.0
+numba>=0.54.0
 simple-pid>=1.0.1
 mpl-scatter-density>=0.7.0
 sphinx-rtd-theme>=1.2.2
 nbsphinx>=0.9.3
 nbsphinx-link>=1.3.0
+prettytable>=3.16.0

{OptiCommPy-0.9.0/OptiCommPy.egg-info → OptiCommPy-0.10.0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OptiCommPy
-Version: 0.9.0
+Version: 0.10.0
 Summary: Optical Communications Algorithms with Python
 Home-page: https://github.com/edsonportosilva/OptiCommPy
 Maintainer: Edson Porto da Silva
@@ -35,7 +35,7 @@ components of fiber optic communication systems, for educational and research pu
      :width: 600px
      :align: center
-|PyPI| |PyPI - Downloads| |Documentation Status| |DOI|
+|PyPI| |PyPI - Downloads| |Documentation Status| |DOI| |JOSS|
 Available features
 ------------------
@@ -58,8 +58,9 @@ Available features
    -  *Several NxN MIMO adaptive equalization algorithms*.
    -  *Carrier phase recovery algorithms.*
+-  Functions to implement forward error correction (FEC) encoders and decoders.
 -  For most of the cases, `Numba <https://numba.pydata.org/>`__ is used
-   to speed up the core DSP functions.
+   to speed up the code.
 -  Evaluate transmission performance with metrics such as:
    -  *Bit-error-rate* (BER).
@@ -75,9 +76,15 @@ Available features
 How can I contribute?
 ---------------------
-If you want to contribute to this project, implement the feature you
-want and send me a pull request. If you want to suggest new features or
-discuss anything related to OptiCommPy, please get in touch with me
+- If you want to contribute to this project:
+   - Create a new issue in the GitHub repository to discuss the feature you want to implement.
+   - Fork the repository and create a new branch.
+   - Make sure you have the latest version of the code.
+   - Check the conventions adopted in the code writing (e.g. naming conventions, docstrings, etc.).
+   - Remember to write an example of usage for the new feature you are implementing.
+   - After the process is finished, send a pull request.
+- If you want to suggest or discuss anything related to OptiCommPy, please get in touch via e-mail
 (edsonporto88@gmail.com).
 Requirements/Dependencies
@@ -87,14 +94,15 @@ Requirements/Dependencies
 -  numpy>=1.24.4
 -  scipy>=1.13.0
 -  matplotlib>=3.7.0
--  numba>=0.54.1,<=0.57.0
+-  numba>=0.54.1
 -  tqdm>=4.64.1
 -  simple-pid>=1.0.1
 -  mpl-scatter-density>=0.7.0
 -  sphinx-rtd-theme>=1.2.2
 -  nbsphinx>=0.9.3
 -  nbsphinx-link>=1.3.0
--  cupy-cuda12x >= 13.1.0 (optional, in case GPU processing is desired)
+-  prettytable>=3.16.0
+-  cupy-cuda12x>=13.1.0 (optional, in case GPU processing is desired)
 Installation
 ------------
@@ -123,16 +131,16 @@ You can find the latest documentation in
 Citing this repository
 ----------------------
-Edson Porto da Silva, Adolfo Herbster, Carlos Daniel Fontes da Silva, &
-Joaquin Matres. (2023). edsonportosilva/OptiCommPy: v0.7.0-alpha
-(v0.7.0-alpha). Zenodo. https://doi.org/10.5281/zenodo.10304945
+Edson Porto da Silva, Adolfo Fernandes Herbster. "OptiCommPy: Open-source Simulation of Fiber Optic Communications with Python", *Journal of Open Source Software*, 9(98), 6600, (2024) https://doi.org/10.21105/joss.06600
 .. |PyPI| image:: https://img.shields.io/pypi/v/OptiCommPy?label=pypi%20package
 .. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/OptiCommPy
 .. |Documentation Status| image:: https://readthedocs.org/projects/opticommpy/badge/?version=latest
    :target: https://opticommpy.readthedocs.io/en/latest/?badge=latest
-.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10304945.svg
-   :target: https://doi.org/10.5281/zenodo.10304945
+.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.11450597.svg
+   :target: https://doi.org/10.5281/zenodo.11450597
+.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.06600/status.svg
+   :target: https://doi.org/10.21105/joss.06600

{OptiCommPy-0.9.0 → OptiCommPy-0.10.0}/README.rst RENAMED Viewed

@@ -16,7 +16,7 @@ components of fiber optic communication systems, for educational and research pu
      :width: 600px
      :align: center
-|PyPI| |PyPI - Downloads| |Documentation Status| |DOI|
+|PyPI| |PyPI - Downloads| |Documentation Status| |DOI| |JOSS|
 Available features
 ------------------
@@ -39,8 +39,9 @@ Available features
    -  *Several NxN MIMO adaptive equalization algorithms*.
    -  *Carrier phase recovery algorithms.*
+-  Functions to implement forward error correction (FEC) encoders and decoders.
 -  For most of the cases, `Numba <https://numba.pydata.org/>`__ is used
-   to speed up the core DSP functions.
+   to speed up the code.
 -  Evaluate transmission performance with metrics such as:
    -  *Bit-error-rate* (BER).
@@ -56,9 +57,15 @@ Available features
 How can I contribute?
 ---------------------
-If you want to contribute to this project, implement the feature you
-want and send me a pull request. If you want to suggest new features or
-discuss anything related to OptiCommPy, please get in touch with me
+- If you want to contribute to this project:
+   - Create a new issue in the GitHub repository to discuss the feature you want to implement.
+   - Fork the repository and create a new branch.
+   - Make sure you have the latest version of the code.
+   - Check the conventions adopted in the code writing (e.g. naming conventions, docstrings, etc.).
+   - Remember to write an example of usage for the new feature you are implementing.
+   - After the process is finished, send a pull request.
+- If you want to suggest or discuss anything related to OptiCommPy, please get in touch via e-mail
 (edsonporto88@gmail.com).
 Requirements/Dependencies
@@ -68,14 +75,15 @@ Requirements/Dependencies
 -  numpy>=1.24.4
 -  scipy>=1.13.0
 -  matplotlib>=3.7.0
--  numba>=0.54.1,<=0.57.0
+-  numba>=0.54.1
 -  tqdm>=4.64.1
 -  simple-pid>=1.0.1
 -  mpl-scatter-density>=0.7.0
 -  sphinx-rtd-theme>=1.2.2
 -  nbsphinx>=0.9.3
 -  nbsphinx-link>=1.3.0
--  cupy-cuda12x >= 13.1.0 (optional, in case GPU processing is desired)
+-  prettytable>=3.16.0
+-  cupy-cuda12x>=13.1.0 (optional, in case GPU processing is desired)
 Installation
 ------------
@@ -104,16 +112,16 @@ You can find the latest documentation in
 Citing this repository
 ----------------------
-Edson Porto da Silva, Adolfo Herbster, Carlos Daniel Fontes da Silva, &
-Joaquin Matres. (2023). edsonportosilva/OptiCommPy: v0.7.0-alpha
-(v0.7.0-alpha). Zenodo. https://doi.org/10.5281/zenodo.10304945
+Edson Porto da Silva, Adolfo Fernandes Herbster. "OptiCommPy: Open-source Simulation of Fiber Optic Communications with Python", *Journal of Open Source Software*, 9(98), 6600, (2024) https://doi.org/10.21105/joss.06600
 .. |PyPI| image:: https://img.shields.io/pypi/v/OptiCommPy?label=pypi%20package
 .. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/OptiCommPy
 .. |Documentation Status| image:: https://readthedocs.org/projects/opticommpy/badge/?version=latest
    :target: https://opticommpy.readthedocs.io/en/latest/?badge=latest
-.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10304945.svg
-   :target: https://doi.org/10.5281/zenodo.10304945
+.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.11450597.svg
+   :target: https://doi.org/10.5281/zenodo.11450597
+.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.06600/status.svg
+   :target: https://doi.org/10.21105/joss.06600

OptiCommPy 0.9.0__tar.gz → 0.10.0__tar.gz

OptiCommPy 0.9.0tar.gz → 0.10.0tar.gz