{ "info": { "author": "Batten Research Group", "author_email": "brg-pymtl@csl.cornell.edu", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "License :: OSI Approved :: BSD License", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3 :: Only", "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)" ], "description": "
\n=======================================\n    ____        ____  _______   __\n   / __ \\__  __/ __ \\/ ____/ | / /\n  / /_/ / / / / / / / /   /  |/ /\n / ____/ /_/ / /_/ / /___/ /|  /\n/_/    \\__, /\\____/\\____/_/ |_/\n      /____/\n=======================================\n
\n[![Build Status](https://travis-ci.com/cornell-brg/pymtl3-net.svg?branch=master)](https://travis-ci.com/cornell-brg/pymtl3-net)\n\nPyOCN (PyMTL-OCN Generator) is a parameterizable and powerful OCN (on-chip network) generator to generate synthesizable Verilog for different OCNs based on user-specified configurations (e.g., network size, topology, number of virtual channels, routing strategy, switching arbitration, etc.). It comes with PyMTL implementation and is the first one to provide functional-level (FL), cycle-level (CL), and register-transfer-level (RTL) modeling for building OCNs. Furthermore, POSH OCN Generator is open-source with a modular design and standardized interfaces between modules. The configurability and extensibility are maximized by its parametrization system to fit in various research and industrial needs.\n\nDemo\n--------------------------------------------------------\n\nWe have a demo at repl.it (https://repl.it/@ChengTan/pymtl3-net-demo), which shows the key features of PyOCN.\n\n\nRelated publications\n--------------------------------------------------------------------------\n\n- Cheng Tan, Yanghui Ou, Shunning Jiang, Peitian Pan, Christopher Torng, Shady Agwa, and Christopher Batten. _\"PyOCN: A Unified Framework for Modeling, Testing, and Evaluating On-Chip Networks.\"_ 37th IEEE International Conference on Computer Design. (ICCD-37), Nov 2019.\n\n- Shunning Jiang, Christopher Torng, and Christopher Batten. _\"An Open-Source Python-Based Hardware Generation, Simulation, and Verification Framework.\"_ First Workshop on Open-Source EDA Technology (WOSET'18) held in conjunction with ICCAD-37, Nov. 2018.\n\n- Shunning Jiang, Berkin Ilbeyi, and Christopher Batten. _\"Mamba: Closing the Performance Gap in Productive Hardware Development Frameworks.\"_ 55th ACM/IEEE Design Automation Conf. (DAC-55), June 2018.\n\n\nLicense\n--------------------------------------------------------------------------\n\nPyOCN is offered under the terms of the Open Source Initiative BSD\n3-Clause License. More information about this license can be found here:\n\n - http://choosealicense.com/licenses/bsd-3-clause\n - http://opensource.org/licenses/BSD-3-Clause\n\n\nInstallation\n--------------------------------------------------------\n\nPyOCN requires Python3.7 and has the following additional prerequisites:\n\n - graphviz, verilator\n - git, Python headers, and libffi\n - virtualenv\n - PyMTL3\n\nThe steps for installing these prerequisites and PyOCN on a fresh Ubuntu\ndistribution are shown below. They have been tested with Ubuntu Trusty\n14.04.\n\n### Install python3\n\n```\n % sudo apt-get install python3.7\n```\n\n### Install graphviz\n\n```\n % sudo apt-get install -y graphviz\n```\n\n### Install Verilator\n\n[Verilator][4] is an open-source toolchain for compiling Verilog RTL\nmodels into C++ simulators. PyOCN uses Verilator for Verilog import.\n\n```\n % wget https://github.com/cornell-brg/verilator-travisci-cache/raw/master/verilator-travis-4.008.tar.gz\n % tar -C ${HOME} -xzf verilator-travis-4.008.tar.gz\n % export VERILATOR_ROOT=${HOME}/verilator\n % export PATH=${VERILATOR_ROOT}/bin:${PATH}\n % export PYMTL_VERILATOR_INCLUDE_DIR=${VERILATOR_ROOT}/share/verilator/include\n % verilator --version\n```\n\n [4]: http://www.veripool.org/wiki/verilator\n\n### Install git, Python headers, and libffi\n\nWe need to install the Python headers and libffi in order to be able to\ninstall the cffi Python package. cffi provides an elegant way to call C\nfunctions from Python, and PyMTL uses cffi to call C code generated by\nVerilator. We will use git to grab the PyMTL source. The following\ncommands will install the appropriate packages:\n\n```\n % sudo apt-get install git python-dev libffi-dev\n```\n\n### Create virtual environment\n\nWhile not strictly necessary, we strongly recommend using [virtualenv][5]\nto install PyMTL3 and the Python packages that PyMTL3 depends on.\nvirtualenv enables creating isolated Python environments. The following\ncommands will create and activate the virtual environment:\n\n```\n % python3 -m venv ${HOME}/venv\n % source ${HOME}/venv/bin/activate\n```\n\n [5]: https://virtualenv.pypa.io/en/latest/\n\n### Install PyMTL3 and Python requirements\n\n```\n % pip install pymtl3\n % pip install --upgrade pip setuptools twine\n % pip install --requirement requirements.txt\n % pip list\n```\n\n### Clone PyOCN repo\n\nWe can now use git to clone the PyOCN repo.\n\n```\n % mkdir -p ${HOME}/cornell-brg\n % cd ${HOME}/cornell-brg\n % git clone --depth=50 https://github.com/cornell-brg/posh-ocn.git cornell-brg/posh-ocn\n```\n\nWhen you're done testing/developing, you can deactivate the virtualenv::\n\n```\n % deactivate\n```\n\nQuickview\n--------------------------------------------------------\n\n### OCN generator hierarchy:\n\n\n### Test with a set of simple tests:\n![test table](docs/test.png)\n\n### OCN generator design flow:\n\n\n### Generic network architecture:\n\n\n### OCN generic router architecture:\n\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/cornell-brg/pymtl3-net", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "pymtl3-net", "package_url": "https://pypi.org/project/pymtl3-net/", "platform": "", "project_url": "https://pypi.org/project/pymtl3-net/", "project_urls": { "Homepage": "https://github.com/cornell-brg/pymtl3-net" }, "release_url": "https://pypi.org/project/pymtl3-net/0.1.6/", "requires_dist": [ "pymtl3", "ruamel.yaml" ], "requires_python": ">=3.6", "summary": "PyMTL3-Net: an open-source Python-based framework for modeling, testing, and evaluating on-chip interconnection networks", "version": "0.1.6" }, "last_serial": 5924481, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "0d596c24e31d7b90764de0961203c744", "sha256": "007e9bc8812a5afc1981a2b1a47217b34837d579e768bfa706f34a4e50af8f49" }, "downloads": -1, "filename": "pymtl3_net-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "0d596c24e31d7b90764de0961203c744", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 76255, "upload_time": "2019-09-04T01:10:10", "url": "https://files.pythonhosted.org/packages/27/aa/27282fa08934309817def833d5a41c9461b49f0e068d18a10f6a59d69d85/pymtl3_net-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0a56db30a320886a9ef249c5bc25f8fd", "sha256": "38004eed33709d44564f7a44a2bc7cdc48a8dc078f44a3b8031a7e2884c35f44" }, "downloads": -1, "filename": "pymtl3-net-0.1.0.tar.gz", "has_sig": false, "md5_digest": "0a56db30a320886a9ef249c5bc25f8fd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 41697, "upload_time": "2019-09-04T01:10:12", "url": "https://files.pythonhosted.org/packages/08/25/48ea70e1a3a6393b86f14c44aa1b0b47fd3fc244a5dcf334ba305366f576/pymtl3-net-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "d55f98160f1f3fe88fc1440d1b721d76", "sha256": "f0e21df096e9c211373ae2524b01ad69e2da829db1c698eaaca7347ccc235e00" }, "downloads": -1, "filename": "pymtl3_net-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d55f98160f1f3fe88fc1440d1b721d76", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 76336, "upload_time": "2019-09-04T23:05:36", "url": "https://files.pythonhosted.org/packages/21/52/a4ca0eacb329cc2c86428661a71a074d9260e20c731b5ace051a1918ba69/pymtl3_net-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cf2adaf31e3595ef71f14e4762bd8963", "sha256": "3adbdf171254ca086bfd8af43c38206abc35a2f914e63d3ce10b6a03abaa84f9" }, "downloads": -1, "filename": "pymtl3-net-0.1.1.tar.gz", "has_sig": false, "md5_digest": "cf2adaf31e3595ef71f14e4762bd8963", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 41768, "upload_time": "2019-09-04T23:05:37", "url": "https://files.pythonhosted.org/packages/b9/4c/b59d64fc515a0c0e821779120076292af74b0705dda05d178a74b2e0cb5d/pymtl3-net-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "44987262025d408be52c55bb6d2f2408", "sha256": "a7b86ff1ebfcda5fe30f1e8810c68f22388883c14a3610f8bf318bef6945a709" }, "downloads": -1, "filename": "pymtl3_net-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "44987262025d408be52c55bb6d2f2408", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 76612, "upload_time": "2019-09-05T20:34:12", "url": "https://files.pythonhosted.org/packages/24/11/78f6cf302eea7333352430fdea8e63114d1eb88601a4c4250dbe8142d9ef/pymtl3_net-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "35b06568dde499ce963f5c3b2fe734aa", "sha256": "02437ac279c49fd0fede4e6af9d8eed9910a43877f6e2fc990e426ccc4a045f6" }, "downloads": -1, "filename": "pymtl3-net-0.1.2.tar.gz", "has_sig": false, "md5_digest": "35b06568dde499ce963f5c3b2fe734aa", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 42574, "upload_time": "2019-09-05T20:34:14", "url": "https://files.pythonhosted.org/packages/bb/7c/d8e0ae22e6ce5307707e9cb2816ea8a3e047aedf5abefb452d94d19cafcf/pymtl3-net-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "f7a900efe177181c939ad165bed9f14f", "sha256": "1933c71a5fe19e5cb9caffbbffeaddfac9f03c87ade17c7aeb0a47236c1d17ca" }, "downloads": -1, "filename": "pymtl3_net-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "f7a900efe177181c939ad165bed9f14f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 76589, "upload_time": "2019-09-05T22:21:29", "url": "https://files.pythonhosted.org/packages/99/60/9f5d1e786b89352dcff837be6b78d0ce485f3cb1dc9bc1eb30dd44cda8f8/pymtl3_net-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f3c2b7f69f14f10d8317c0fffd5768b0", "sha256": "152cd3341f6f20904876edab0666e012b6364bb68494b87237c74f41a964628c" }, "downloads": -1, "filename": "pymtl3-net-0.1.3.tar.gz", "has_sig": false, "md5_digest": "f3c2b7f69f14f10d8317c0fffd5768b0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 42559, "upload_time": "2019-09-05T22:21:31", "url": "https://files.pythonhosted.org/packages/8a/b5/60af4bc97453b7c9497a84688357fafd1fe5ddfbfebea8d1d672cbd346bb/pymtl3-net-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "47d029931e70497c7cf87785520dd080", "sha256": "3cdf4c9cb1f7a8aec1f086e593f86e29ac559d7bdc912a02210676da8a9bdb35" }, "downloads": -1, "filename": "pymtl3_net-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "47d029931e70497c7cf87785520dd080", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 76893, "upload_time": "2019-09-06T02:03:01", "url": "https://files.pythonhosted.org/packages/7d/4c/986fac5dab6710adef2bad71a408e0a87bee642a21b3047894f9f59d7463/pymtl3_net-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b0f8e98a70a49b69d678a35a7a3af52d", "sha256": "8000b87a867a7f991cfdfcb5cf54fc39c944ed1568b47d6eadf75de97aec4447" }, "downloads": -1, "filename": "pymtl3-net-0.1.4.tar.gz", "has_sig": false, "md5_digest": "b0f8e98a70a49b69d678a35a7a3af52d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 42893, "upload_time": "2019-09-06T02:03:02", "url": "https://files.pythonhosted.org/packages/65/84/197d4066f5997f9010a790bf0b1396404f6b2f434bd252779b266f964a6f/pymtl3-net-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "538aad92e6f600b38c579229078b7871", "sha256": "079f718769ac049321013ca57abdd6ae387311069ad6848d2318719dceb44883" }, "downloads": -1, "filename": "pymtl3_net-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "538aad92e6f600b38c579229078b7871", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 89126, "upload_time": "2019-10-03T00:44:01", "url": "https://files.pythonhosted.org/packages/c3/22/e4560030174ccaa8aa1e81534524fbe1c89d56dc91855ae463b514b6d1a9/pymtl3_net-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e5e347965e740196fb7553797a6a2958", "sha256": "28da389f9c5d1b6a45adaf8c40316cc21447c918fddbad954509a2720479c062" }, "downloads": -1, "filename": "pymtl3-net-0.1.5.tar.gz", "has_sig": false, "md5_digest": "e5e347965e740196fb7553797a6a2958", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 49172, "upload_time": "2019-10-03T00:44:03", "url": "https://files.pythonhosted.org/packages/eb/4e/c2a25817b62e96826756e4ec655d1f9e41c5be0e5411c9f8f0fa9071cbc0/pymtl3-net-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "66f0bf3c9e8c2246f2acce03b70ed05d", "sha256": "264fca762a4bb997dca1ea8c2dab6ba5c0fff1991725300c71aaf7b82b4259b5" }, "downloads": -1, "filename": "pymtl3_net-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "66f0bf3c9e8c2246f2acce03b70ed05d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 89259, "upload_time": "2019-10-03T17:28:54", "url": "https://files.pythonhosted.org/packages/cc/46/313f9028f759ddb3a909b0fef2d62dcd65aa64df8c0fb923f09ff5d6b995/pymtl3_net-0.1.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c716d8129751e3df83dc240646a85b37", "sha256": "68ee8328f41493976baa236f9c62a92b8637dfbded3c207db57f4765e7e6fb6b" }, "downloads": -1, "filename": "pymtl3-net-0.1.6.tar.gz", "has_sig": false, "md5_digest": "c716d8129751e3df83dc240646a85b37", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 49289, "upload_time": "2019-10-03T17:28:55", "url": "https://files.pythonhosted.org/packages/ca/13/280d865fd028df16f7ef11b3984889a0adacaaab89ab26c72eba13a42899/pymtl3-net-0.1.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "66f0bf3c9e8c2246f2acce03b70ed05d", "sha256": "264fca762a4bb997dca1ea8c2dab6ba5c0fff1991725300c71aaf7b82b4259b5" }, "downloads": -1, "filename": "pymtl3_net-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "66f0bf3c9e8c2246f2acce03b70ed05d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 89259, "upload_time": "2019-10-03T17:28:54", "url": "https://files.pythonhosted.org/packages/cc/46/313f9028f759ddb3a909b0fef2d62dcd65aa64df8c0fb923f09ff5d6b995/pymtl3_net-0.1.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c716d8129751e3df83dc240646a85b37", "sha256": "68ee8328f41493976baa236f9c62a92b8637dfbded3c207db57f4765e7e6fb6b" }, "downloads": -1, "filename": "pymtl3-net-0.1.6.tar.gz", "has_sig": false, "md5_digest": "c716d8129751e3df83dc240646a85b37", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 49289, "upload_time": "2019-10-03T17:28:55", "url": "https://files.pythonhosted.org/packages/ca/13/280d865fd028df16f7ef11b3984889a0adacaaab89ab26c72eba13a42899/pymtl3-net-0.1.6.tar.gz" } ] }