Metadata-Version: 1.1
Name: NetworkSim
Version: 0.2.1
Summary: A WDM ring datacentre network simulator
Home-page: https://github.com/HYang1996/NetworkSim
Author: Hongyi Yang
Author-email: zceehya@ucl.ac.uk
License: MIT
Download-URL: https://github.com/HYang1996/NetworkSim/archive/refs/tags/0.2.1.tar.gz
Description: .. -*- mode: rst -*-
        
        |github|_ |readthedocs|_ |pypi|_ |binder|_
        
        .. |github| image:: https://img.shields.io/github/workflow/status/HYang1996/NetworkSim/Build%20and%20Test?logo=github
        .. _github: https://github.com/HYang1996/NetworkSim/actions?query=workflow%3A%22Build+and+Test%22
        
        .. |readthedocs| image:: https://readthedocs.org/projects/networksim/badge/?version=latest
        .. _readthedocs: https://networksim.readthedocs.io/en/latest/
        
        .. |pypi| image:: https://img.shields.io/pypi/v/NetworkSim
        .. _pypi: https://pypi.org/project/NetworkSim/
        
        .. |binder| image:: https://mybinder.org/badge_logo.svg
        .. _binder: https://mybinder.org/v2/gh/HYang1996/NetworkSim/master?filepath=examples
        
        NetworkSim
        ==========
        
        NetworkSim is a Python package used to simulation data transmission in a typical optical wavelength ring network using the Wavelength Division Multiplexing (WDM) technique:
        
        .. image:: docs/source/images/Ring-Network-Diagram.png
            :width: 800
            :align: center
        
        
        In this package, two protocols have been implemented for the simulation, namely the fixed transmitter - tunable receiver (FT-TR) protocol and the tunable transmitter - fixed receiver (TT-FR) protocol.
        
        This package is developed as part of our final year group project and is still under development. It will be constantly updated as we troubleshoot bugs and implement additional features.
        
        Installation
        ------------
        
        The package is available via PyPI using:
        
        .. code-block:: bash
        
            pip install NetworkSim
        
        Quickstart
        ----------
        
        .. code-block:: python
        
            from NetworkSim import BaseSimulator
        
            simulator = BaseSimulator()
            simulator.initialise()
            simulator.run()
            simulator.summary()
        
        Documentation
        -------------
        
        Read the detailed package `API reference <https://networksim.readthedocs.io/en/latest/>`__.
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
