Metadata-Version: 2.1
Name: ftpvl
Version: 0.1.2
Summary: A visualization library for FPGA Tool Performance
Home-page: https://github.com/TypingKoala/FPGA-Tool-Performance-Visualization-Library
Author: Johnny Bui
Author-email: me@johnnybui.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
Requires-Dist: seaborn
Requires-Dist: pandas
Requires-Dist: jinja2


# FPGA Tool Performance Visualization Library (FTPVL)
![Python application](https://github.com/TypingKoala/FPGA-Tool-Performance-Visualization-Library/workflows/Python%20application/badge.svg)

<img src="https://raw.githubusercontent.com/TypingKoala/FPGA-Tool-Performance-Visualization-Library/master/examples/images/singletablevisualizer.png" alt="Single Table Visualization" width="100%">

FTPVL is a library for simplifying the data collection and visualization process
for Symbiflow development. Although it was made with Symbiflow in mind, it is
highly extensible for future integration with other software.

## Dependencies
The library extensively uses [Pandas](https://pandas.pydata.org/) for data
management and processing. Other dependencies are explained below:
* `pandas`: for data management and processing
* `seaborn`: for colormap generation
* `jinja2`: for visualization generation

### Development Dependencies
* `requests-mock`: for mocking request object for testing fetchers
* `pylint`: for linting
* `pytest`: testrunner
* `coverage`: for coverage testing
* `black`: for auto-formatting

## Example Usage
Take a look at the notebooks below to demonstrate the functionality of FTPVL.

1. [Using `HydraFetcher` and Processors](https://colab.research.google.com/drive/1BIQ-iulDFpzcve7lGJPwLePJ5ETBJ6Ut?usp=sharing)
2. [Styling tables with `SingleTableVisualizer`](https://colab.research.google.com/drive/1u3EnmIYnTBk-LXZhqNHt_h4aMuq-_cWq?usp=sharing)
3. [Comparing two different Evaluations](https://colab.research.google.com/drive/1I7InmA6210vIIwdQ7TGHE6aF_WwIm1dM?usp=sharing)

