From 8a39acf411e424e46b80d9bb64cf87a828db075a Mon Sep 17 00:00:00 2001 From: Edson Porto da Silva Date: Wed, 10 Nov 2021 11:11:30 -0300 Subject: [PATCH] Update README.md --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ade747d3..dc7fbf5b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Fiber Optic Communications with Python -Simulate optical communications systems with Python. +Simulate optical communications systems with Python. This repository contains code to simulate systems, subsystems and components of fiber optic communication systems, for educational and research purposes. [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/edsonportosilva/OptiCommpy-public/HEAD?urlpath=lab) @@ -9,16 +9,16 @@ Simulate optical communications systems with Python. * QAM/PSK signal generation with [Commpy](https://github.com/veeresht/CommPy) * Numerical models to simulate optical transmitters, nonlinear propagation over optical fibers, and optical receivers. * CPU and GPU-based implementations of the [*split-step Fourier Method*](https://en.wikipedia.org/wiki/Split-step_method) to simulate polarization multiplexed WDM transmission. -* Standard digital signal processing (DSP) blocks employed in coherent optical receivers. +* Standard digital signal processing (DSP) blocks employed in coherent optical receivers. For most of the cases, [Numba](https://numba.pydata.org/) is used to speed up the core functions. * Tools to evaluate transmission performance metrics such as *bit-error-rate* (BER), *symbol-error-rate* (SER), *mutual information* (MI), *generalized mutual information* (GMI). -How can I contribute? ---------------------- +## How can I contribute? + If you want to contribute to this project, just 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 (edsonporto88@gmail.com). -Requirements/Dependencies -------------------------- +## Requirements/Dependencies + - python 3.2 or above - numpy 1.10 or above - scipy 0.15 or above @@ -26,8 +26,7 @@ Requirements/Dependencies - Commpy 0.7.0 or above - numba 0.54.1 or above -Installation ------------- +## Installation Clone from github and install as follows::