Metadata-Version: 2.1
Name: pyphysim
Version: 0.5
Summary: Simulation of digital communication (physical layer) in python
Home-page: https://github.com/darcamo/pyphysim
License: GPL-2.0-or-later
Keywords: physical layer,QAM,PSK,QPSK,BPSK,OFDM,Modulation,Monte Carlo,simulation,MIMO,Tapped Delay Line
Author: Darlan Cavalcante Moreira
Author-email: darcamo@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Requires-Dist: cloudpickle (>=1.5.0,<2.0.0)
Requires-Dist: configobj
Requires-Dist: ipyparallel (>=6.3.0,<7.0.0)
Requires-Dist: ipython (>=7.16.1,<8.0.0)
Requires-Dist: ipywidgets (>=7.5.1,<8.0.0)
Requires-Dist: matplotlib
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: pandas (>=1.0.5,<2.0.0)
Requires-Dist: scipy
Project-URL: Repository, https://github.com/darcamo/pyphysim
Description-Content-Type: text/markdown

![Testing](https://travis-ci.org/darcamo/pyphysim.svg?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/darcamo/pyphysim/badge.svg?branch=master)](https://coveralls.io/github/darcamo/pyphysim?branch=master)
[![Documentation Status](https://readthedocs.org/projects/pyphysim/badge/?version=latest)](http://pyphysim.readthedocs.io/en/latest/?badge=latest)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

PyPhysim
========

Simulation of Digital Communication (physical layer) in Python.

This includes classes related to digital modulation (M-QAM, M-PSK, etc), AWGN
channel, Rayleigh and tapped delay line channel models, channel estimation,
MIMO, OFDM, etc.. It also includes classes related to multiuser transmission,
such as block diagonalization, interference alignment, etc., as well as classes
representing access nodes and users for easily creating physical layer
simulations.

Furthermore, a framework for implementing Monte Carlo simulations is also
implemented (see the pyphysim.simulations package) to help with creating
simulators that run many independent realizations and average the results.


Installation
------------

Pyphysim is available in [Pypi](https://pypi.org/project/pyphysim/) and can be
installed with pip or similar tools. If you want to install from the git
repository, then install [poetry](https://python-poetry.org/) first, clone the
repository, and run the command `poetry install` from the cloned folder to
install pyphysim and its dependencies in a virtual environment (created by
poetry). After that, just use `poetry shell` to activate the environment and you
should be able to import pyphysim from python started in that shell.


Examples
========

There are a few notebooks in the
[notebooks](https://github.com/darcamo/pyphysim/tree/master/notebooks) folder in
the GitHub repository. A list of some of the notebooks with a small description
is shown below for quick access.

- [Transmission_with_AWGN_channel.ipynb](https://github.com/darcamo/pyphysim/blob/master/notebooks/Transmission_with_AWGN_channel.ipynb):
  Illustrates the use of digital modulation to transmit through an AWGN channel
  and the usage of classes that help creating Monte Carlo simulations
- [Transmission_with_Rayleigh_and_AWGN_channels.ipynb](https://github.com/darcamo/pyphysim/blob/master/notebooks/Transmission_with_Rayleigh_and_AWGN_channels.ipynb): Extends the previous notebook to transmission through a Rayleigh channel and discuss running simulation
- [TDL_and_OFDM.ipynb](https://github.com/darcamo/pyphysim/blob/master/notebooks/TDL_and_OFDM.ipynb): Simulation of transmission through a frequency selective channel that varies in time using OFDM
- [PathLoss classes.ipynb](https://github.com/darcamo/pyphysim/blob/master/notebooks/PathLoss_classes.ipynb): Illustrate some path loss classes
- [Alamouti.ipynb](https://github.com/darcamo/pyphysim/blob/master/notebooks/Alamouti.ipynb): Illustrates how to simulate using multiple antennas and how to use configuration files

