Merge branch 'main' into add-paper

edsonportosilva · May 9, 2024 · 38b8d89 · 38b8d89
2 parents 35b605d + c5718e3
commit 38b8d89
Show file tree

Hide file tree

Showing 226 changed files with 15,780 additions and 2,989 deletions.
diff --git a/README.md b/README.md
@@ -43,15 +43,13 @@ If you want to contribute to this project, implement the feature you want and se
 ## Requirements/Dependencies
 
 -  python>=3.2
--  numpy>=1.9.2
--  scipy>=0.15.0
+-  numpy>=1.24.4
+-  scipy>=1.13.0
 -  matplotlib>=3.7.0
--  scikit-commpy>=0.7.0
--  numba>=0.54.1
+-  numba>=0.54.1,<=0.57.0
 -  tqdm>=4.64.1
 -  simple-pid>=1.0.1
 -  mpl-scatter-density>=0.7.0
--  pandas>=2.0.0
 -  sphinx-rtd-theme>=1.2.2
 -  nbsphinx>=0.9.3
 -  nbsphinx-link>=1.3.0

diff --git a/README.rst b/README.rst
@@ -65,15 +65,13 @@ Requirements/Dependencies
 -------------------------
 
 -  python>=3.2
--  numpy>=1.9.2
--  scipy>=0.15.0
+-  numpy>=1.24.4
+-  scipy>=1.13.0
 -  matplotlib>=3.7.0
--  scikit-commpy>=0.7.0
--  numba>=0.54.1
+-  numba>=0.54.1,<=0.57.0
 -  tqdm>=4.64.1
 -  simple-pid>=1.0.1
 -  mpl-scatter-density>=0.7.0
--  pandas>=2.0.0
 -  sphinx-rtd-theme>=1.2.2
 -  nbsphinx>=0.9.3
 -  nbsphinx-link>=1.3.0

diff --git a/docs/build/doctrees/comm.doctree b/docs/build/doctrees/comm.doctree
diff --git a/docs/build/doctrees/dsp.doctree b/docs/build/doctrees/dsp.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.Qfunc.doctree b/docs/build/doctrees/generated/optic.comm.metrics.Qfunc.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.bert.doctree b/docs/build/doctrees/generated/optic.comm.metrics.bert.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.calcEVM.doctree b/docs/build/doctrees/generated/optic.comm.metrics.calcEVM.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.calcLLR.doctree b/docs/build/doctrees/generated/optic.comm.metrics.calcLLR.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.calcLinOSNR.doctree b/docs/build/doctrees/generated/optic.comm.metrics.calcLinOSNR.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.fastBERcalc.doctree b/docs/build/doctrees/generated/optic.comm.metrics.fastBERcalc.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.monteCarloGMI.doctree b/docs/build/doctrees/generated/optic.comm.metrics.monteCarloGMI.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.monteCarloMI.doctree b/docs/build/doctrees/generated/optic.comm.metrics.monteCarloMI.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.theoryBER.doctree b/docs/build/doctrees/generated/optic.comm.metrics.theoryBER.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.metrics.theoryMI.doctree b/docs/build/doctrees/generated/optic.comm.metrics.theoryMI.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.GrayCode.doctree b/docs/build/doctrees/generated/optic.comm.modulation.GrayCode.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.GrayMapping.doctree b/docs/build/doctrees/generated/optic.comm.modulation.GrayMapping.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.apskConst.doctree b/docs/build/doctrees/generated/optic.comm.modulation.apskConst.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.demap.doctree b/docs/build/doctrees/generated/optic.comm.modulation.demap.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.demodulateGray.doctree b/docs/build/doctrees/generated/optic.comm.modulation.demodulateGray.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.minEuclid.doctree b/docs/build/doctrees/generated/optic.comm.modulation.minEuclid.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.modulateGray.doctree b/docs/build/doctrees/generated/optic.comm.modulation.modulateGray.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.pamConst.doctree b/docs/build/doctrees/generated/optic.comm.modulation.pamConst.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.pskConst.doctree b/docs/build/doctrees/generated/optic.comm.modulation.pskConst.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.modulation.qamConst.doctree b/docs/build/doctrees/generated/optic.comm.modulation.qamConst.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.ofdm.calcSymbolRate.doctree b/docs/build/doctrees/generated/optic.comm.ofdm.calcSymbolRate.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.ofdm.demodulateOFDM.doctree b/docs/build/doctrees/generated/optic.comm.ofdm.demodulateOFDM.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.ofdm.hermit.doctree b/docs/build/doctrees/generated/optic.comm.ofdm.hermit.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.ofdm.modulateOFDM.doctree b/docs/build/doctrees/generated/optic.comm.ofdm.modulateOFDM.doctree
diff --git a/docs/build/doctrees/generated/optic.comm.ofdm.zeroPad.doctree b/docs/build/doctrees/generated/optic.comm.ofdm.zeroPad.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.carrierRecovery.bps.doctree b/docs/build/doctrees/generated/optic.dsp.carrierRecovery.bps.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.carrierRecovery.cpr.doctree b/docs/build/doctrees/generated/optic.dsp.carrierRecovery.cpr.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.carrierRecovery.ddpll.doctree b/docs/build/doctrees/generated/optic.dsp.carrierRecovery.ddpll.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.carrierRecovery.fourthPowerFOE.doctree b/docs/build/doctrees/generated/optic.dsp.carrierRecovery.fourthPowerFOE.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.carrierRecovery.viterbi.doctree b/docs/build/doctrees/generated/optic.dsp.carrierRecovery.viterbi.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.clockRecovery.calcClockDrift.doctree b/docs/build/doctrees/generated/optic.dsp.clockRecovery.calcClockDrift.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.clockRecovery.gardnerClockRecovery.doctree b/docs/build/doctrees/generated/optic.dsp.clockRecovery.gardnerClockRecovery.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.clockRecovery.gardnerTED.doctree b/docs/build/doctrees/generated/optic.dsp.clockRecovery.gardnerTED.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.clockRecovery.gardnerTEDnyquist.doctree b/docs/build/doctrees/generated/optic.dsp.clockRecovery.gardnerTEDnyquist.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.clockRecovery.interpolator.doctree b/docs/build/doctrees/generated/optic.dsp.clockRecovery.interpolator.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.clockSamplingInterp.doctree b/docs/build/doctrees/generated/optic.dsp.core.clockSamplingInterp.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.decimate.doctree b/docs/build/doctrees/generated/optic.dsp.core.decimate.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.finddelay.doctree b/docs/build/doctrees/generated/optic.dsp.core.finddelay.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.firFilter.doctree b/docs/build/doctrees/generated/optic.dsp.core.firFilter.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.gaussianComplexNoise.doctree b/docs/build/doctrees/generated/optic.dsp.core.gaussianComplexNoise.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.gaussianNoise.doctree b/docs/build/doctrees/generated/optic.dsp.core.gaussianNoise.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.lowPassFIR.doctree b/docs/build/doctrees/generated/optic.dsp.core.lowPassFIR.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.movingAverage.doctree b/docs/build/doctrees/generated/optic.dsp.core.movingAverage.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.phaseNoise.doctree b/docs/build/doctrees/generated/optic.dsp.core.phaseNoise.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.pnorm.doctree b/docs/build/doctrees/generated/optic.dsp.core.pnorm.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.pulseShape.doctree b/docs/build/doctrees/generated/optic.dsp.core.pulseShape.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.quantizer.doctree b/docs/build/doctrees/generated/optic.dsp.core.quantizer.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.rcFilterTaps.doctree b/docs/build/doctrees/generated/optic.dsp.core.rcFilterTaps.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.resample.doctree b/docs/build/doctrees/generated/optic.dsp.core.resample.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.rrcFilterTaps.doctree b/docs/build/doctrees/generated/optic.dsp.core.rrcFilterTaps.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.sigPow.doctree b/docs/build/doctrees/generated/optic.dsp.core.sigPow.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.signal_power.doctree b/docs/build/doctrees/generated/optic.dsp.core.signal_power.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.symbolSync.doctree b/docs/build/doctrees/generated/optic.dsp.core.symbolSync.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.core.upsample.doctree b/docs/build/doctrees/generated/optic.dsp.core.upsample.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.equalization.edc.doctree b/docs/build/doctrees/generated/optic.dsp.equalization.edc.doctree
diff --git a/docs/build/doctrees/generated/optic.dsp.equalization.mimoAdaptEqualizer.doctree b/docs/build/doctrees/generated/optic.dsp.equalization.mimoAdaptEqualizer.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.OSA.doctree b/docs/build/doctrees/generated/optic.models.amplification.OSA.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.edfParams.doctree b/docs/build/doctrees/generated/optic.models.amplification.edfParams.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.edfaArgs.doctree b/docs/build/doctrees/generated/optic.models.amplification.edfaArgs.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.edfaSM.doctree b/docs/build/doctrees/generated/optic.models.amplification.edfaSM.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.getN2Pop.doctree b/docs/build/doctrees/generated/optic.models.amplification.getN2Pop.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.getOverlapInt.doctree b/docs/build/doctrees/generated/optic.models.amplification.getOverlapInt.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.get_mode_radius.doctree b/docs/build/doctrees/generated/optic.models.amplification.get_mode_radius.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.get_spectrum.doctree b/docs/build/doctrees/generated/optic.models.amplification.get_spectrum.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.gilesSpatial.doctree b/docs/build/doctrees/generated/optic.models.amplification.gilesSpatial.doctree
diff --git a/docs/build/doctrees/generated/optic.models.amplification.gilesSpectrum.doctree b/docs/build/doctrees/generated/optic.models.amplification.gilesSpectrum.doctree
diff --git a/docs/build/doctrees/generated/optic.models.channels.awgn.doctree b/docs/build/doctrees/generated/optic.models.channels.awgn.doctree
diff --git a/docs/build/doctrees/generated/optic.models.channels.linearFiberChannel.doctree b/docs/build/doctrees/generated/optic.models.channels.linearFiberChannel.doctree
diff --git a/docs/build/doctrees/generated/optic.models.channels.manakovSSF.doctree b/docs/build/doctrees/generated/optic.models.channels.manakovSSF.doctree
diff --git a/docs/build/doctrees/generated/optic.models.channels.ssfm.doctree b/docs/build/doctrees/generated/optic.models.channels.ssfm.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.adc.doctree b/docs/build/doctrees/generated/optic.models.devices.adc.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.balancedPD.doctree b/docs/build/doctrees/generated/optic.models.devices.balancedPD.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.basicLaserModel.doctree b/docs/build/doctrees/generated/optic.models.devices.basicLaserModel.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.coherentReceiver.doctree b/docs/build/doctrees/generated/optic.models.devices.coherentReceiver.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.edfa.doctree b/docs/build/doctrees/generated/optic.models.devices.edfa.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.hybrid_2x4_90deg.doctree b/docs/build/doctrees/generated/optic.models.devices.hybrid_2x4_90deg.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.iqm.doctree b/docs/build/doctrees/generated/optic.models.devices.iqm.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.mzm.doctree b/docs/build/doctrees/generated/optic.models.devices.mzm.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.pbs.doctree b/docs/build/doctrees/generated/optic.models.devices.pbs.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.pdmCoherentReceiver.doctree b/docs/build/doctrees/generated/optic.models.devices.pdmCoherentReceiver.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.photodiode.doctree b/docs/build/doctrees/generated/optic.models.devices.photodiode.doctree
diff --git a/docs/build/doctrees/generated/optic.models.devices.pm.doctree b/docs/build/doctrees/generated/optic.models.devices.pm.doctree
diff --git a/docs/build/doctrees/generated/optic.models.modelsGPU.edfa.doctree b/docs/build/doctrees/generated/optic.models.modelsGPU.edfa.doctree
diff --git a/docs/build/doctrees/generated/optic.models.modelsGPU.manakovSSF.doctree b/docs/build/doctrees/generated/optic.models.modelsGPU.manakovSSF.doctree
diff --git a/docs/build/doctrees/generated/optic.models.modelsGPU.ssfm.doctree b/docs/build/doctrees/generated/optic.models.modelsGPU.ssfm.doctree
diff --git a/docs/build/doctrees/generated/optic.models.tx.simpleWDMTx.doctree b/docs/build/doctrees/generated/optic.models.tx.simpleWDMTx.doctree
diff --git a/docs/build/doctrees/generated/optic.plot.constHist.doctree b/docs/build/doctrees/generated/optic.plot.constHist.doctree
diff --git a/docs/build/doctrees/generated/optic.plot.eyediagram.doctree b/docs/build/doctrees/generated/optic.plot.eyediagram.doctree
diff --git a/docs/build/doctrees/generated/optic.plot.pconst.doctree b/docs/build/doctrees/generated/optic.plot.pconst.doctree
diff --git a/docs/build/doctrees/generated/optic.plot.plotColoredConst.doctree b/docs/build/doctrees/generated/optic.plot.plotColoredConst.doctree
diff --git a/docs/build/doctrees/generated/optic.plot.plotDecisionBoundaries.doctree b/docs/build/doctrees/generated/optic.plot.plotDecisionBoundaries.doctree
diff --git a/docs/build/doctrees/generated/optic.plot.plotPSD.doctree b/docs/build/doctrees/generated/optic.plot.plotPSD.doctree
diff --git a/docs/build/doctrees/generated/optic.plot.randomCmap.doctree b/docs/build/doctrees/generated/optic.plot.randomCmap.doctree
diff --git a/...build/doctrees/JOSS_paper_example.doctree → docs/build/doctrees/getting_started.doctree b/...build/doctrees/JOSS_paper_example.doctree → docs/build/doctrees/getting_started.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/models.doctree b/docs/build/doctrees/models.doctree
diff --git a/...octrees/nbsphinx/JOSS_paper_example.ipynb → ...d/doctrees/nbsphinx/getting_started.ipynb b/...octrees/nbsphinx/JOSS_paper_example.ipynb → ...d/doctrees/nbsphinx/getting_started.ipynb
diff --git a/docs/build/doctrees/plot.doctree b/docs/build/doctrees/plot.doctree
diff --git a/docs/build/doctrees/test_WDM_transmission.doctree b/docs/build/doctrees/test_WDM_transmission.doctree
diff --git a/docs/build/doctrees/utils.doctree b/docs/build/doctrees/utils.doctree
diff --git a/docs/build/html/_sources/JOSS_paper_example.nblink.txt b/docs/build/html/_sources/JOSS_paper_example.nblink.txt
diff --git a/docs/build/html/_sources/getting_started.nblink.txt b/docs/build/html/_sources/getting_started.nblink.txt
@@ -0,0 +1,3 @@
+{
+  "path": "../../examples/getting_started.ipynb"
+}
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -20,7 +20,7 @@ Welcome to OptiCommPy's documentation!
     :maxdepth: 1
     :caption: Examples
 
-    JOSS_paper_example
+    getting_started
     test_WDM_transmission
 
 .. toctree::

diff --git a/docs/build/html/comm.html b/docs/build/html/comm.html
@@ -1,14 +1,12 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="English">
+<html class="writer-html5" lang="English" >
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Digital Communications Utilities &mdash; OptiCommPy 0.6.0 documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
-
-
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -19,7 +17,7 @@
         <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="_static/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
-        <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
+        <script src="https://unpkg.com/@jupyter-widgets/html-manager@^0.20.0/dist/embed-amd.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -51,7 +49,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="JOSS_paper_example.html">Getting started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="test_WDM_transmission.html">Simulation of coherent WDM transmission</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Package documentation</span></p>

diff --git a/docs/build/html/dsp.html b/docs/build/html/dsp.html
@@ -1,14 +1,12 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="English">
+<html class="writer-html5" lang="English" >
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Digital Signal Processing (DSP) &mdash; OptiCommPy 0.6.0 documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
-
-
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -19,7 +17,7 @@
         <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="_static/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
-        <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
+        <script src="https://unpkg.com/@jupyter-widgets/html-manager@^0.20.0/dist/embed-amd.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -51,7 +49,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="JOSS_paper_example.html">Getting started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="test_WDM_transmission.html">Simulation of coherent WDM transmission</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Package documentation</span></p>
@@ -805,6 +803,8 @@ <h2>DSP algorithms for carrier phase and frequency recovery (<code class="xref p
 <dd class="field-odd"><p>real-valued np.array</p>
 </dd>
 </dl>
+<p class="rubric">References</p>
+<p>[1] T. Pfau, S. Hoffmann, e R. Noé, “Hardware-efficient coherent digital receiver concept with feedforward carrier recovery for M-QAM constellations”, Journal of Lightwave Technology, vol. 27, nº 8, p. 989–999, 2009, doi: 10.1109/JLT.2008.2010511.</p>
 </dd></dl>
 
 <dl class="py function">
@@ -853,6 +853,10 @@ <h2>DSP algorithms for carrier phase and frequency recovery (<code class="xref p
 </p>
 </dd>
 </dl>
+<p class="rubric">References</p>
+<p>[1] T. Pfau, S. Hoffmann, e R. Noé, “Hardware-efficient coherent digital receiver concept with feedforward carrier recovery for M-QAM constellations”, Journal of Lightwave Technology, vol. 27, nº 8, p. 989–999, 2009, doi: 10.1109/JLT.2008.2010511.</p>
+<p>[2] S. J. Savory, “Digital coherent optical receivers: Algorithms and subsystems”, IEEE Journal on Selected Topics in Quantum Electronics, vol. 16, nº 5, p. 1164–1179, set. 2010, doi: 10.1109/JSTQE.2010.2044751.</p>
+<p>[3] H. Meyer, Digital Communication Receivers: Synchronization, Channel estimation, and Signal Processing, Wiley 1998. Section 5.8 and 5.9.</p>
 </dd></dl>
 
 <dl class="py function">
@@ -880,8 +884,7 @@ <h2>DSP algorithms for carrier phase and frequency recovery (<code class="xref p
 </dd>
 </dl>
 <p class="rubric">References</p>
-<p>[1] H. Meyer, Digital Communication Receivers: Synchronization, Channel
-estimation, and Signal Processing, Wiley 1998. Section 5.8 and 5.9.</p>
+<p>[1] H. Meyer, Digital Communication Receivers: Synchronization, Channel estimation, and Signal Processing, Wiley 1998. Section 5.8 and 5.9.</p>
 </dd></dl>
 
 <dl class="py function">
@@ -907,6 +910,8 @@ <h2>DSP algorithms for carrier phase and frequency recovery (<code class="xref p
 <dd class="field-odd"><p>np.array, float</p>
 </dd>
 </dl>
+<p class="rubric">References</p>
+<p>[1] S. J. Savory, “Digital coherent optical receivers: Algorithms and subsystems”, IEEE Journal on Selected Topics in Quantum Electronics, vol. 16, nº 5, p. 1164–1179, set. 2010, doi: 10.1109/JSTQE.2010.2044751.</p>
 </dd></dl>
 
 <dl class="py function">
@@ -928,6 +933,8 @@ <h2>DSP algorithms for carrier phase and frequency recovery (<code class="xref p
 <dd class="field-odd"><p>np.array, float</p>
 </dd>
 </dl>
+<p class="rubric">References</p>
+<p>[1] S. J. Savory, “Digital coherent optical receivers: Algorithms and subsystems”, IEEE Journal on Selected Topics in Quantum Electronics, vol. 16, nº 5, p. 1164–1179, set. 2010, doi: 10.1109/JSTQE.2010.2044751.</p>
 </dd></dl>
 
 </section>

diff --git a/docs/build/html/generated/optic.comm.metrics.Qfunc.html b/docs/build/html/generated/optic.comm.metrics.Qfunc.html
@@ -1,14 +1,12 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="English">
+<html class="writer-html5" lang="English" >
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>optic.comm.metrics.Qfunc &mdash; OptiCommPy 0.6.0 documentation</title>
-      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
-
-
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -19,7 +17,7 @@
         <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="../_static/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
-        <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
+        <script src="https://unpkg.com/@jupyter-widgets/html-manager@^0.20.0/dist/embed-amd.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -51,7 +49,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../JOSS_paper_example.html">Getting started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../test_WDM_transmission.html">Simulation of coherent WDM transmission</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Package documentation</span></p>

diff --git a/docs/build/html/generated/optic.comm.metrics.bert.html b/docs/build/html/generated/optic.comm.metrics.bert.html
@@ -1,14 +1,12 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="English">
+<html class="writer-html5" lang="English" >
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>optic.comm.metrics.bert &mdash; OptiCommPy 0.6.0 documentation</title>
-      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
-
-
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -19,7 +17,7 @@
         <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="../_static/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
-        <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
+        <script src="https://unpkg.com/@jupyter-widgets/html-manager@^0.20.0/dist/embed-amd.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -51,7 +49,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../JOSS_paper_example.html">Getting started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../test_WDM_transmission.html">Simulation of coherent WDM transmission</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Package documentation</span></p>

diff --git a/docs/build/html/generated/optic.comm.metrics.calcEVM.html b/docs/build/html/generated/optic.comm.metrics.calcEVM.html
@@ -1,14 +1,12 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="English">
+<html class="writer-html5" lang="English" >
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>optic.comm.metrics.calcEVM &mdash; OptiCommPy 0.6.0 documentation</title>
-      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
-
-
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -19,7 +17,7 @@
         <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="../_static/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
-        <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
+        <script src="https://unpkg.com/@jupyter-widgets/html-manager@^0.20.0/dist/embed-amd.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -51,7 +49,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../JOSS_paper_example.html">Getting started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../test_WDM_transmission.html">Simulation of coherent WDM transmission</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Package documentation</span></p>

diff --git a/docs/build/html/generated/optic.comm.metrics.calcLLR.html b/docs/build/html/generated/optic.comm.metrics.calcLLR.html
@@ -1,14 +1,12 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="English">
+<html class="writer-html5" lang="English" >
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>optic.comm.metrics.calcLLR &mdash; OptiCommPy 0.6.0 documentation</title>
-      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
-
-
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -19,7 +17,7 @@
         <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="../_static/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
-        <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
+        <script src="https://unpkg.com/@jupyter-widgets/html-manager@^0.20.0/dist/embed-amd.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -51,7 +49,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../JOSS_paper_example.html">Getting started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../test_WDM_transmission.html">Simulation of coherent WDM transmission</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Package documentation</span></p>

diff --git a/docs/build/html/generated/optic.comm.metrics.calcLinOSNR.html b/docs/build/html/generated/optic.comm.metrics.calcLinOSNR.html
@@ -1,14 +1,12 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="English">
+<html class="writer-html5" lang="English" >
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>optic.comm.metrics.calcLinOSNR &mdash; OptiCommPy 0.6.0 documentation</title>
-      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
-
-
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -19,7 +17,7 @@
         <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="../_static/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
-        <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
+        <script src="https://unpkg.com/@jupyter-widgets/html-manager@^0.20.0/dist/embed-amd.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -51,7 +49,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../JOSS_paper_example.html">Getting started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../test_WDM_transmission.html">Simulation of coherent WDM transmission</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Package documentation</span></p>