{"id":13786880,"url":"https://github.com/ahmed-agiza/EDAViewer","last_synced_at":"2025-05-12T00:30:33.499Z","repository":{"id":41599372,"uuid":"280260470","full_name":"ahmed-agiza/EDAViewer","owner":"ahmed-agiza","description":"EDAV: Open-Source EDA Viewer; render design LEF/DEF files in your browser!","archived":false,"fork":false,"pushed_at":"2023-01-06T11:40:59.000Z","size":3237,"stargazers_count":68,"open_issues_count":16,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-18T00:37:14.762Z","etag":null,"topics":["cgo","def","def-viewer","digitaldesign","eda","electronic-design-automation","hardware","hardware-design","layout","lef","opendb","opendb-database","physical-synthesis","pixijs","server-side-rendering","serverless","serverless-side-rendering","viewer","vlsi","webgl"],"latest_commit_sha":null,"homepage":"https://edaviewer.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ahmed-agiza.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-16T21:16:24.000Z","updated_at":"2024-10-16T07:01:50.000Z","dependencies_parsed_at":"2023-02-06T00:16:24.651Z","dependency_job_id":null,"html_url":"https://github.com/ahmed-agiza/EDAViewer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmed-agiza%2FEDAViewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmed-agiza%2FEDAViewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmed-agiza%2FEDAViewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmed-agiza%2FEDAViewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahmed-agiza","download_url":"https://codeload.github.com/ahmed-agiza/EDAViewer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253655746,"owners_count":21943067,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cgo","def","def-viewer","digitaldesign","eda","electronic-design-automation","hardware","hardware-design","layout","lef","opendb","opendb-database","physical-synthesis","pixijs","server-side-rendering","serverless","serverless-side-rendering","viewer","vlsi","webgl"],"created_at":"2024-08-03T20:00:20.430Z","updated_at":"2025-05-12T00:30:32.343Z","avatar_url":"https://github.com/ahmed-agiza.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Semi Custom Design/ FPGAs"],"sub_categories":[],"readme":"# EDAV: Cloud EDA Viewer\n\n![EDAV](/client/assets/img/EditorScreenshot.png?raw=true)\n\nEDAV is a cloud-based open-source viewer for electronic design automation (EDA) design files: [Library Exchange Format (LEF) \u0026 Design Exchange Format (DEF)](http://www.ispd.cc/contests/19/lefdefref.pdf)\n\n**Website:** [https://edaviewer.com](https://edaviewer.com)\n\n## What is included:\n\n-   [Go](https://golang.org) server for parsing LEF \u0026 DEF files into JSON using [OpenDB LEF/DEF 5.8 parsers](https://github.com/The-OpenROAD-Project/OpenDB) to be rendered with the viewer.\n-   [Go](https://golang.org) interface for OpenDB to process design files using Go language.\n-   Client interface to easily upload design files to the parsing server and render the resulting JSON into the browser (without storage on the server).\n-   [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) based LEF/DEF viewer with various features to view and navigate the parsed design.\n-   [Serverless SAM](https://aws.amazon.com/serverless/sam) templates to deploy directly to the cloud.\n\n## Using EDAV\n\n### Running on the Cloud\n\nYou can access EDAV directly at [https://edaviewer.com](https://edaviewer.com) and start rendering your designs right away.\n\nIf you would like to deploy to a private cloud, check the [deploy](/deploy) folder for the serverless configuration and templates.\n\n### Running in Docker\n\nYou can build and run EDAV server and client directly using [Docker](https://www.docker.com) by running:\n\n```sh\n./run-docker.sh\n```\n\nThis will build the server and client's docker images and run them on ports **8080 \u0026 3000**, respectively. You can then access EDAV through [http://localhost:3000](http://localhost:3000).\n\n### Running on Bare-metal\n\n#### Building and running the server\n\nThe server is built using Go, so you need to have Go installed. Also, the Makefile automatically pulls and builds [OpenDB](https://github.com/The-OpenROAD-Project/OpenDB), but you need to have OpenDB prerequisites ([CMake](https://cmake.org), [Tcl](https://www.tcl.tk), [SWIG](http://www.swig.org), [flex](https://sourceforge.net/projects/flex/), [bison](https://www.gnu.org/software/bison/)..) installed for the build to succeed.\nAfter installing Go and OpenDB prerequisites, run Make to build the server binary (includes OpenDB):\n\n```sh\nmake build\n```\n\nThen run the server:\n\n```sh\nmake server\n```\n\nTher server should be accessible at port **8080** by default unless modified by the environment variable **PORT**.\n\n#### Building and running the client\n\nThe client is built on [Next.js](https://nextjs.org), so you need to have [Node.js](https://nodejs.org) (v10+) and [yarn](https://yarnpkg.com) installed.\nTo install the node dependencies, you can either:\n\n```sh\ncd client \u0026\u0026 yarn install\n```\n\nor\n\n```sh\nmake build-client\n```\n\nThen run the client:\n\n```sh\ncd client \u0026\u0026 yarn run dev\n```\n\nor\n\n```sh\nmake client\n```\n\nTher 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.\n\n## WebGL Viewer\n\nEDAV renders the parsed design using EDAV LEF/DEF viewer. The viewer is based on [PixiJS](https://www.pixijs.com), 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:\n\n-   Viewport pan \u0026 zoom support.\n-   Visibility control panel to hide and show different parts of the design.\n-   Components explorer to search and view various design components.\n-   Viewer customization from the settings window (changing colors, render settings, etc.).\n-   Component details dialog on double click from the viewport or the components explorer.\n-   Exporting the design to PNG or JPEG images.\n\n## OpenDB Go Bindings\n\nThe server includes a clean interface into OpenDB for parsing design files using [CGO](https://golang.org/cmd/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.\n\nExample:\n\n```go\nvar db goopendb.OpenDB\ndb, err := goopendb.NewDatabase()\nif err != nil {\n       fmt.Fprintf(os.Stderr, \"%v\", err)\n       return\n}\ndefer db.FreeDatabase() // Cleanup for C structs\nerr = db.ParseLEF(\"server/example/Nangate45/NangateOpenCellLibrary.mod.lef\")\nif err != nil {\n       fmt.Fprintf(os.Stderr, \"%v\", err)\n       return\n}\nerr = db.ParseDEF(\"server/example/Nangate45/gcd.def\")\nif err != nil {\n       fmt.Fprintf(os.Stderr, \"%v\", err)\n       return\n}\ndesign, err := db.GetDesign()\nif err != nil {\n       fmt.Fprintf(os.Stderr, \"%v\", err)\n       return\n}\n/**\n* The design struct should hold the parsed design objects:\n type Design struct {\n    Name           string\n    Instances      []*Instance\n    Nets           []*Net\n    InstancePins   []*Pin\n    BlockPins      []*Pin\n    RoutingVias    []*Via\n    ViaDefinitions []*Via\n    Layers         []*Layer\n    CoreArea       float64\n    DieArea        float64\n    DesignArea     float64\n    Utilization    float64\n    BoundingBox    *Rect\n    Core           *Rect\n    Die            *Rect\n    Rows           []*Row\n    Tracks         []*Grid\n    Sites          []*Site\n    GCell          *Grid\n    Geometries     []*Geometry\n}\n*/\n```\n\n## Main libraries and technologies:\n\n-   **[Go](https://golang.org)**: for the server.\n-   **[OpenDB](https://github.com/The-OpenROAD-Project/OpenDB)**: for LEF/DEF parsing.\n-   **[Node.js](https://nodejs.org)**: for client tecnhologies.\n-   **[React](https://reactjs.org)**: for the client interface.\n-   **[Next.js](https://nextjs.org)**: for server-side rendering.\n-   **[Creative Tim's Next.js Material Kit](https://github.com/creativetimofficial/nextjs-material-kit)**: for the client boilerplate and many components in the client interface.\n-   **[Material-UI](https://material-ui.com)**: for many components in the client interface.\n-   **[PixiJS](https://www.pixijs.com)**: for the WebGL viewer.\n\n## Contribution\n\nCommunity contributions are welcome, feel free to open a [pull request](../../pulls) with any new features/fixes you would like to provide.\n\n## Issues\n\nIf you encounter any bug or you want to request any new feature, please open a GitHub [issue](../../issues/new/choose) using the templates provided.\n\n## License\n\nEDAV is open-source under the [MIT license](/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmed-agiza%2FEDAViewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmed-agiza%2FEDAViewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmed-agiza%2FEDAViewer/lists"}