Installation
To use Opticomlib, python <=3.10 is required.
Note
If you don’t have python installed, it’s strongly recommended to install it using Miniconda for simplicity in managing packages and environments.
Here is an example for installing Miniconda on Windows (for other OS, please refer to the official documentation),
Open a terminal and run the following commands:
$ curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o miniconda3.exe
$ start /wait "" miniconda3.exe
$ del miniconda3.exe
After installing, open the “Anaconda Prompt (miniconda3)” program to use Miniconda3. Then you can create
a new environment and install Opticomlib using the following commands:
(base)$ conda create -n optic_env python=3.10
(base)$ conda activate optic_env
(optic_env)$ pip install opticomlib
If you want to install an specific branch of the git repository, you can use the following command:
(optic_env)$ pip install git+https://github.com/armando-palacio/opticomlib.git@branch_name
Usage
To use library, you have to import the modules you need (as devices, ook, ppm, etc) and use them in your code.
Also, you need to import gv variable from any module or opticomlib directly, in order to set global variables for simulation.
Here there are some examples of how to use Opticomlib.
Generate a gaussian pulse with a given width and amplitude is so easy using
DAC()device.
from opticomlib.devices import DAC, gv
gv(sps=32, R=1e9) # set samples per slot and slot rate, it automatically will set de sampling frequency (fs),
# see "Data Types/global_variables" documentation page for more details
pulse = DAC('0001000', pulse_shape='gaussian', T=16, Vout=1) # create a gaussian pulse with 16 samples width and 1V of amplitude
# see "Devices/DAC" documentation page for more details of the DAC device
pulse.plot('r.-', style='light').grid().show() # plot, grid and show the pulse,
# see "Data Types/electrical_signal.plot" documentation page for more details of the plot method
See the response of an optical fiber for a given input optical signal is very simple using
FIBER()device:
from opticomlib.devices import DAC, FIBER
from opticomlib import optical_signal, gv
gv(sps=32, R=10e9) # set again samples per slot and slot rate
P = 1e-3 # 1 mW of peak power
pulse_i = optical_signal(DAC('0001000', pulse_shape='gaussian', T=16, Vout=P**0.5).signal) # create a gaussian pulse as before with (1 mW) of peak power and convert it as an optical_signal,
# because of the FIBER device only accepts optical_signal as input
pulse_o = FIBER(pulse_i, length=100, alpha=0, beta_2=-20, beta_3=0, gamma=1.5) # propagate the pulse through a fiber of 100km length,
# with alpha=0.2 dB/km, beta_2=-20 ps^2/km, beta_3=0 ps^3/km and gamma=1.5 1/W/km
# see "Devices/FIBER" documentation page for more details of the FIBER device
pulse_i.plot('r.-', label='Input', style='light')
pulse_o.plot('b.-', label='Output', style='light').grid().legend().show() # plot, grid, legend and show the input and output pulses
Estimate the eye diagram parameters and plot the eye of an arbitrary signal is very simple too, using
GET_EYE()device:
from opticomlib.devices import PRBS, DAC, GET_EYE, gv
import numpy as np
gv(sps=32, R=10e9) # set again samples per slot and slot rate
x = DAC(PRBS(order=15), pulse_shape='gaussian', Vout=1) # create a PRBS signal and pass it through a gaussian pulse shaping filter with 1V output
x.noise = np.random.normal(0, 0.05, len(x)) # add gaussian noise to the signal
eye = GET_EYE(x, sps_resamp=128) # get the eye diagram of x with 128 samples per slot
# see "Devices/GET_EYE" documentation page for more details of the GET_EYE device
eye.print() # print the eye diagram parameters
eye.plot().show() # plot and show the eye diagram
-----------------
*** eye ***
-----------------
sps : 32
dt : 3.125e-12
y : [0.8 0.8 0.8 ... 0.9 0.8 0.8]
t : [-1. -1. -1. ... 1. 1. 1.]
t_left : -0.4666666666675001
t_right : 0.5372549019583821
t_opt : 0.0352941176454411
t_dist : 1.0039215686258822
t_span0 : -0.014901960785853013
t_span1 : 0.08549019607673522
i : 17
y_top : [0.9 0.9 1. ... 0.9 0.8 0.8]
y_bot : [-0. -0. -0. ... 0. 0.1 0.1]
mu1 : 0.9442477130214517
s1 : 0.06336202689582064
mu0 : 0.04657654834827988
s0 : 0.06488856548646174
er : 13.069186405369418
eye_h : 0.5129193875263247
time : 699.1 ms
