netlistx 包

author :litao
inst :tju
e-mail :李涛的邮箱
copyright: free copy and use

##简要介绍 netlistx是一个用于FPGA上插入扫描链的Python包，主要的功能有：

• 读取并解析网表文件, 生成Netlist对象.
• 对综合出来的FPGA Verilog网表进行自动编辑和修改，插入扫描链.
• 从网表构建CircuitGraph.
• 从基本的CircuitGraph构建更抽象的电路图，比如CloudRegGraph，SGraph, ESGraph.

##使用方法

• 包的顶层文件夹名称不能改动,必须是 netlistx
• 将包所在的目录加入到PYTHONPATH环境变量中。
• 安装requirements.txt中的依赖.
• partial***功能需要主机上存在Matlab,且可以直接通过命令行调用.

##架构

netlistx \文件名必须叫这个

    __init__.py
    exception.py     \自定义异常类型类s
    file_util.py     \读取vm文件函数,输入输出重定向类
    circuit.py \所有与电路相关的类s: port, circut_module, ...
    netlist.py       \Netlist类 #TODO:
    netlist_rules.py \规则检查函数s
    netlist_util.py  \网表的其他可用函数s
    cliapp.py        \命令行程序
    log.py           \全局log
    cells \单元库构建 脚本
        construct_scan_lib.py \由xilinx unisim.v 生成扫描所需的基本单元 SCAN_FD*
        faultlib.py \生成故障注入单元FIE #TODO

    itrans \iscas89门级网表翻译器 脚本.
        itrans.py       \可执行,用来读取同目录下的iscas .v网表
        Primitives.py   \Dff和Combi类定义

    graph \图生成子包
        __init__.py
        ballast.py      \BALLAST方法的实现
        circuitgraph.py \CircuitGraph类
        cloudgraph.py   \CloudRegGraph类
        crgraph.py      \The old CloudRegGraph类
        util.py         
        main.py         \与图相关的生成与验证,可以直接执行此文件

    parser \vm文件解析器子包
        __init__.py
        lex.py             \ply lex
        yacc.py            \ply yacc
        netlist_lexer.py   \网表词法分析器
        netlist_parser.py  \网表解析器.生成class_circuit中的定义的各种类型对象.
        parsetab.py        \自动生成的,不要修改

    prototype \未验证功能正确的函数暂时存放在此目录.
        __init__.py
        balance.py
        check.py
        cut.py
        fas.py
        unbpath.py

    scan \扫描插入脚本s
        __init__.py
        config.py
        fullReplace.py
        fullUsingLut.py
        partialBallast.py
        partialOpt.py
        partialOptLinear.py
        partialFusion.py     \FCCM16 数据源.不要改动.
        testbenchGenerate.py \对插入扫描链的网表生成TestBench #TODO:
        scanapp.py
        partial_esgrh.py
        util.py
    logfiles \#调试程序时的log输出
	unittest \#单元测试文件夹
    test     \#测试输入输出存储文件夹
    
    其他与PTVS. Github.相关的文件,都可以删除.不直接影响程序的功能

其他注意事项

无