ahmed-agiza/edaviewer

EDAV: Open-Source EDA Viewer; render design LEF/DEF files in your browser!

EDAV: Cloud EDA Viewer

EDAV is a cloud-based open-source viewer for electronic design automation (EDA) design files: Library Exchange Format (LEF) & Design Exchange Format (DEF)

Website: https://edaviewer.com

What is included:

• Go server for parsing LEF & DEF files into JSON using OpenDB LEF/DEF 5.8 parsers to be rendered with the viewer.
• Go interface for OpenDB to process design files using Go language.
• Client interface to easily upload design files to the parsing server and render the resulting JSON into the browser (without storage on the server).
• WebGL based LEF/DEF viewer with various features to view and navigate the parsed design.
• Serverless SAM templates to deploy directly to the cloud.

Using EDAV

Running on the Cloud

You can access EDAV directly at https://edaviewer.com and start rendering your designs right away.

If you would like to deploy to a private cloud, check the deploy folder for the serverless configuration and templates.

Running in Docker

You can build and run EDAV server and client directly using Docker by running:

./run-docker.sh

This will build the server and client's docker images and run them on ports 8080 & 3000, respectively. You can then access EDAV through http://localhost:3000.

Running on Bare-metal

Building and running the server

The server is built using Go, so you need to have Go installed. Also, the Makefile automatically pulls and builds OpenDB, but you need to have OpenDB prerequisites (CMake, Tcl, SWIG, flex, bison..) installed for the build to succeed. After installing Go and OpenDB prerequisites, run Make to build the server binary (includes OpenDB):

make build

Then run the server:

make server

Ther server should be accessible at port 8080 by default unless modified by the environment variable PORT.

Building and running the client

The client is built on Next.js, so you need to have Node.js (v10+) and yarn installed. To install the node dependencies, you can either:

cd client && yarn install

or

make build-client

Then run the client:

cd client && yarn run dev

or

make client

Ther server should be accessible at port 3000 by default unless modified by the environment variable PORT. You might also need to set the environment variable NEXT_PUBLIC_EDAV_SERVER_URL to the server URL if you have changed the defaults.

WebGL Viewer

EDAV renders the parsed design using EDAV LEF/DEF viewer. The viewer is based on PixiJS, which uses a WebGL engine by default (and falls back to canvas if needed) for high-performance rendering in the browser. The viewer has various features, such as:

• Viewport pan & zoom support.
• Visibility control panel to hide and show different parts of the design.
• Components explorer to search and view various design components.
• Viewer customization from the settings window (changing colors, render settings, etc.).
• Component details dialog on double click from the viewport or the components explorer.
• Exporting the design to PNG or JPEG images.

OpenDB Go Bindings

The server includes a clean interface into OpenDB for parsing design files using CGO. The interface can be used in any project that desires to process LEF/DEF files using Go instead of regular C++ or Tcl; feel free to ask for support for more features from OpenDB.

Example:

var db goopendb.OpenDB
db, err := goopendb.NewDatabase()
if err != nil {
       fmt.Fprintf(os.Stderr, "%v", err)
       return
}
defer db.FreeDatabase() // Cleanup for C structs
err = db.ParseLEF("server/example/Nangate45/NangateOpenCellLibrary.mod.lef")
if err != nil {
       fmt.Fprintf(os.Stderr, "%v", err)
       return
}
err = db.ParseDEF("server/example/Nangate45/gcd.def")
if err != nil {
       fmt.Fprintf(os.Stderr, "%v", err)
       return
}
design, err := db.GetDesign()
if err != nil {
       fmt.Fprintf(os.Stderr, "%v", err)
       return
}
/**
* The design struct should hold the parsed design objects:
 type Design struct {
    Name           string
    Instances      []*Instance
    Nets           []*Net
    InstancePins   []*Pin
    BlockPins      []*Pin
    RoutingVias    []*Via
    ViaDefinitions []*Via
    Layers         []*Layer
    CoreArea       float64
    DieArea        float64
    DesignArea     float64
    Utilization    float64
    BoundingBox    *Rect
    Core           *Rect
    Die            *Rect
    Rows           []*Row
    Tracks         []*Grid
    Sites          []*Site
    GCell          *Grid
    Geometries     []*Geometry
}
*/

Main libraries and technologies:

• Go: for the server.
• OpenDB: for LEF/DEF parsing.
• Node.js: for client tecnhologies.
• React: for the client interface.
• Next.js: for server-side rendering.
• Creative Tim's Next.js Material Kit: for the client boilerplate and many components in the client interface.
• Material-UI: for many components in the client interface.
• PixiJS: for the WebGL viewer.

Contribution

Community contributions are welcome, feel free to open a pull request with any new features/fixes you would like to provide.

Issues

If you encounter any bug or you want to request any new feature, please open a GitHub issue using the templates provided.

License

EDAV is open-source under the MIT license.

edaviewer's Issues

edaviewer.com example design causes internal server error 500

Describe the bug
Navigating to https://edaviewer.com/example triggers an internal server error:

To Reproduce
Steps to reproduce the behavior:

1. Go to 'https://edaviewer.com/example'
2. See error

Expected behavior
No error.

Screenshots
See above.

Environment (please complete the following information):

• OS: FreeBSD 12.2-RELEASE-p3
• Firefox 85.0 (64-bit)

Additional context
N/A

Macros viewing feature can be added for better visualization.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.