# iSim

**Repository Path**: ryime/isim

## Basic Information

- **Project Name**: iSim
- **Description**: 一个面向Windows的Verilog图形界面仿真工具
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: testing
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 12
- **Forks**: 3
- **Created**: 2022-08-31
- **Last Updated**: 2024-08-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Verilog, EDA, GUI

## README

## 介绍

iSim是一款**面向Windows的Verilog图形界面仿真工具**。该仿真工具拥有一个简洁、友好的图形界面，包含工程管理、模块层次显示、代码生成模板、代码编辑、命令行和编译指令设置等功能。设计者在图形界面中无需输入命令，通过按钮即可调用iVerilog、vvp和GTKWave，完成数字电路前端从设计、仿真到验证的过程，大大降低了仿真工具的使用难度，提高了设计者的设计效率。iSim使用Qt-C++编写。

## 更新日志
2.2.3版本\
2022.9.14 文本编辑器添加自动缩进功能。

## 使用说明

### 安装

目前程序的发布方式为压缩包的形式，用户在下载后解压，双击iSim.exe运行即可。
**注意，安装目录路径里不能包含中文。**

打开iSim后，程序界面如下图所示：

![maininterface](./picture/main.png)

程序界面默认为中文界面，通过菜单栏中的“工具(Tool)-首选项(Preference)-语言(Language)”设置可以在中文与英文中切换，切换后重启方可生效。

### 新建工程(New Project)

在菜单栏中点击“文件(File)-新建工程(New Project)”，在弹出的向导界面中设置工程名字、工程路径，点击继续，在下一页中添加工程所需要的Verilog源代码（若没有则可以先不用添加），点击完成，结束向导。

### 新建源文件(New Source)

在菜单栏中点击“工程(Project)-新建源文件(New Source)”，在弹出的向导界面中设置源文件名字、源文件路径（默认为当前工程路径，一般无需更改），点击继续，在下一页中设置源文件的时间刻度(`timescale)、参数的名称和数值、端口的名称和属性，点击完成结束向导。

### 文本编辑

新建或打开一个工程后，左侧会显示工程里的源文件列表，双击一个源文件即可读取该文件并在右侧的代码编辑器里显示。在右侧的代码编辑器中可以对Verilog文件进行编辑，在文件(File)菜单中可以进行打开、保存等操作。

### 代码编译

当代码编辑完成后，可以使用iverilog对代码进行编译。在菜单栏中的“进程(Process)”菜单中，有三个编译选项：编译(Compile)、编译全部(Compile All)、编译工程(Compile Project)，其中“编译(Compile)”会调用iverilog编译当前选中的文件，“编译全部(Compile All)”会依次调用iverilog编译工程下所有的文件，“编译工程(Compile Project)”会调用iverilog，将工程下的所有文件作为一个整体进行编译。

若编译发生错误，文件名旁会显示一个红色的叉号，同时下方的控制台也会显示具体的错误信息，可以通过点击“错误(Error)”标签进入错误列表，双击错误列表中的某一项可以转到错误对应的位置。若编译成功，则会在文件名下方显示iverilog编译产生的中间文件，同时可以在“进程(Process)”菜单中点击“运行(Run)”来调用vvp以运行该中间文件。运行完成后，可以在进程菜单中点击“显示波形(Show Wave)”来调用GTKWave以显示波形。

iverilog、vvp、GTKWave已经包含在程序压缩包中，如果用户需要使用自己的iverilog或GTKWave，可以在菜单栏中“工具(Tool)-首选项(Preference)-编译工具(Compile Tool)”中修改路径。

## 仓库目录结构

在此仓库中，master分支为较稳定版本分支，稳定版本的程序会提交在master分支中；testing分支为测试分支，当添加一些小功能、修复一些小bug后会将程序提交到testing分支中。

-iSim\
    |- gtkwave (gtkwave程序文件夹)\
    |- iconengines (Qt打包时生成的icon链接库文件夹)\
    |- imageformats (Qt打包时生成的链接库文件夹)\
    |- iverilog (iverilog程序文件夹)\
    |- picture (本文件使用的图片)\
    |- platforms (Qt打包时生成的跨平台文件夹)\
    |- Sample (样例工程)\
    |- src (程序源码)\
    |- styles (Qt打包时生成的样式文件夹)\
    |- translations (Qt打包时生成的翻译文件夹)\
    iSim.exe (iSim可执行程序)\
    readme.md (本文件)