# OpenEDI

**Repository Path**: brightmind/open-edi

## Basic Information

- **Project Name**: OpenEDI
- **Description**: 通过OpenEDI开源数据基础构件，用户将可以访问完全开源开放、接口丰富的、统一高效的数据库，算法库及计算架构，利用高效的内存与符号表管理功能，进行层次化设计和增量设计。
由于基于此基础构件开发的EDA工具之间没有数据壁垒，IC芯片的设计者能流畅地在不同设计工具之间切换而不用担心数据丢失，从而提高设计效率，缩短产品研发乃至上市时间，抢占市场。
EDA工具的开发者也能受益于该数据库，激发自己的灵感，设计出顶尖的点工具，从而推动整个IC设计产业链的发展。
- **Primary Language**: C++
- **License**: BSD-3-Clause
- **Default Branch**: dev-openedi
- **Homepage**: https://www.openeda.com/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 68
- **Created**: 2021-09-02
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenEDI

#### Description
An open-source infrastructure for VLSI design automation tool set.  

#### Software Architecture
Key components include:
- Database - OpenEDI database, core module.
- Parser - parse standard data format and import data to OpenEDI databade.
- CommandManager - manage commands.
- MessageManager - manage messages.
- IOManager - High-performance file IO.
- GUI - Graphic user interface

#### Building Dependency (Recommend)

- [GCC 6.5.0](http://ftp.tsukuba.wide.ad.jp/software/gcc/releases/gcc-6.5.0/gcc-6.5.0.tar.gz)
- [Cmake 3.12.4](https://cmake.org/files/v3.12/cmake-3.12.4-Linux-x86_64.tar.gz)
- [Qt 5.9.7](http://download.qt.io/archive/qt/5.9/5.9.7/qt-opensource-linux-x64-5.9.7.run)
- Python 3.6
- [Google test](https://gitee.com/mirrors/googletest)(Integrated as a submodule)
- [Pybind11](https://gitee.com/mirrors/pybind11)(Integrated as a submodule)
- Boost 1.55 +
- Tcl/Tk 8.6.9+
- Flex 2.5.37+
- Bison 3.0.0+
- [Gperftools 2.7.90](https://github.com/gperftools/gperftools/releases/download/gperftools-2.7.90/gperftools-2.7.90.tar.gz)
- [LZ4 1.9.2](https://github.com/lz4/lz4)

####  Deploy development environment

##### 1.Manual configuration guide

- [Ubuntu 20.04](config_guide_ubuntu20.04.md)
- [CentOS 7.9](config_guide_centos7.9.md)

##### 2.Dockerfile(Recommend)

- Download the dockerfile [Ubuntu 20.04](fast_deploy_ubuntu_20.04.dockerfile)   **or**  [CentOS 7.9](fast_deploy_centos_7.9.dockerfile), then build the docker image

```
docker build -t openedi -f fast_deploy_ubuntu_20.04.dockerfile .
or
docker build -t openedi -f fast_deploy_centos_7.9.dockerfile .

docker run --name openedi -it -p 2222:22 -d openedi
```

- Login to the container, check out and build the code.
```
docker exec -it openedi bash
or
ssh root@localhost -p 2222
```

- Default username:root, password:Passw0rd

#### Installation

1.  Clone the repository with submodules.
~~~~~~~~~~~~~~~~~~~~~
git clone --recursive https://gitee.com/niiceda/open-edi.git
~~~~~~~~~~~~~~~~~~~~~
Alternatively, you can clone the repository and the submodules in two steps.
~~~~~~~~~~~~~~~~~~~~~
git clone https://gitee.com/niiceda/open-edi.git
cd open-edi
git submodule update --init
~~~~~~~~~~~~~~~~~~~~~

2.  Build the program.
~~~~~~~~~~~~~~~~~~~~~
mkdir build   # assume you are inside the root directory of the repository
cd build
cmake ..      # you may add -DCMAKE_INSTALL_PREFIX=your/install/path to specify the build installation location, which by default is <repository>/
make          # you may add -j to turn on parallel building
make test     # optional step to run unittests
make docs     # optional step to generate HTML documentations
make install  # install 'openeda' binary and all related files in build installation location
~~~~~~~~~~~~~~~~~~~~~

#### Instructions

1.  Once installed (after make install), you can find the 'openeda' binary under 'your/install/path/bin/' directory. Run the binary <your/install/path/bin/>openeda in your design location, and try the openeda TCL commands:
~~~~~~~~~~~~~~~~~~~~~
OpenEDA> read_lef test.lef
OpenEDA> read_verilog test.v
OpenEDA> read_def test.def
OpenEDA> read_timing_library test.lib
~~~~~~~~~~~~~~~~~~~~~

2.  You can also find some test cases in demo directory, and run them with the binary just built.:
~~~~~~~~~~~~~~~~~~~~~
cd demo
tar xvf demo_case.tar.xz
cd demo_case
run.sh <your/install/path/bin/openeda>
~~~~~~~~~~~~~~~~~~~~~

#### Contribution

Welcome to contribute to our open source EDA ecosystems!
1.  Fork the repository.
2.  Create Feat_xxx branch.
3.  Commit your code.
4.  Create Pull Request to repository 'OpenEDI', branch 'dev-contrinutor'.


#### Features

1.  Open source parser to support lef, def, v, lib format design files
2.  Open source database API

#### Milestones

1.  2020/11/03 Open source EDI project went ONLINE on Gitee [https://gitee.com/niiceda/open-edi](https://gitee.com/niiceda/open-edi)
2.  2020/11/05 OpenEDI project became the recommended open source project.
3.  2020/12/01 OpenEDI project achieved the most valuable open source project [GVP](https://gitee.com/gvp)