{"id":19290942,"url":"https://github.com/the-openroad-project/openroad-cloud","last_synced_at":"2025-02-23T23:52:44.678Z","repository":{"id":103727460,"uuid":"159000651","full_name":"The-OpenROAD-Project/OpenROAD-Cloud","owner":"The-OpenROAD-Project","description":"The source code that empowers OpenROAD Cloud","archived":false,"fork":false,"pushed_at":"2020-06-29T16:49:20.000Z","size":2934,"stargazers_count":12,"open_issues_count":1,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-05T20:09:21.212Z","etag":null,"topics":["automation","brown-university","cloud-computing","eda","openroad","scale-lab"],"latest_commit_sha":null,"homepage":"https://cloud.theopenroadproject.org","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/The-OpenROAD-Project.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-25T05:23:23.000Z","updated_at":"2024-12-08T20:20:04.000Z","dependencies_parsed_at":"2023-03-31T15:34:08.807Z","dependency_job_id":null,"html_url":"https://github.com/The-OpenROAD-Project/OpenROAD-Cloud","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/The-OpenROAD-Project%2FOpenROAD-Cloud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-OpenROAD-Project%2FOpenROAD-Cloud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-OpenROAD-Project%2FOpenROAD-Cloud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-OpenROAD-Project%2FOpenROAD-Cloud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/The-OpenROAD-Project","download_url":"https://codeload.github.com/The-OpenROAD-Project/OpenROAD-Cloud/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240395749,"owners_count":19794573,"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":["automation","brown-university","cloud-computing","eda","openroad","scale-lab"],"created_at":"2024-11-09T22:23:06.526Z","updated_at":"2025-02-23T23:52:44.645Z","avatar_url":"https://github.com/The-OpenROAD-Project.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenROAD Cloud\nThe source code that empowers [https://cloud.theopenroadproject.org/](https://cloud.theopenroadproject.org/)\n\n![version](https://img.shields.io/badge/version-alpha-blue.svg)\n![coverage](https://img.shields.io/badge/coverage-unknown-yellowgreen.svg)\n![uptime](https://img.shields.io/badge/uptime-98%25-green.svg)\n\n## Purpose\n[The OpenROAD Project](https://theopenroadproject.org/) aims at providing a 24-hour, no-human-in-the-loop layout design \nfor SoC, package and PCB with no Power-Performance-Area (PPA) loss. The cloud infrastructure set up at \n[OpenROAD Cloud](https://cloud.theopenroadproject.org/) makes the tools and designs accessible through\nan easy-to-use web-based interface.\n\nIf you want to jump start using our platform, go to the [Quickstart](#quickstart-guide) section. \nTo get a deeper look at the platform, refer to the [documentation](#documentation) section.  \n\n## Quickstart Guide\n![quickstart](https://img.shields.io/badge/quickstart-new-brightgreen.svg)\n\nGo to [https://cloud.theopenroadproject.org](https://cloud.theopenroadproject.org), \nregister for an account using your email. \n\n### Prepare Your Design\n\nOpenROAD Cloud processes designs that reside in a `git` repository. \nIn order to run your own design through OpenROAD Cloud flow, create add a file to the root of the repository and name it `openroad.yml`.\nThis file declares required configurations for running the flow. Below is a description for its fields described on the [AES example](https://github.com/OpenROAD-Cloud/aes):\n\n```\nplatform: nangate45             # currently only supports 'nangate'\n\ndesign_name: aes_cipher_top     # top-level design name\n\nverilog_files:                  # relative path of the source files\n  - src/aes_cipher_top.v\n  - src/aes_inv_cipher_top.v\n  - src/aes_inv_sbox.v\n  - src/aes_key_expand_128.v\n  - src/aes_rcon.v\n  - src/aes_sbox.v\n  - src/timescale.v\nsdc_file: constraint.sdc        # relative path of the constraint file\n\ndie_area: \"0 0 620.15 620.6\"            # die area as a box\ncore_area: \"10.07 11.2 610.27 610.8\"    # core area as a box\n\nclock_period: 5.00             # clock period in nanoseconds\n```\n\n\u003e Make sure to upload the design files (in `.v` format) and the constraint file (`in .sdc` format) to the same repository as well.\n\n### Run OpenROAD Cloud Flow\n\n1. Login to your account on [https://cloud.theopenroadproject.org](https://cloud.theopenroadproject.org).\n2. From left panel, click **My Designs**.\n3. Click **Import Design**.\n4. Give a name to your design (can be any arbitrary nickname), and paste in the repo URL (repository must be public).\n5. After the design is added, click **Run on latest version**.\n6. You will receive email notifications updating you on the status of the flow.\n\n### Examples\n\n* [GCD](https://github.com/OpenROAD-Cloud/gcd)\n* [AES](https://github.com/OpenROAD-Cloud/aes)\n\n## Deployment on a Private Cloud\nAlthough the publicly available platform enables our research and offers ease-of-use and latest \nimprovements to users around the world, OpenROAD flow can be independently deployed on a private \ncloud infrastructure.\n\n### Architecture\nTODO:\n\n### Deployment Guide\nTODO:\n\n## Contributing\n\nPropose feature requests that you can work on using the [Feature Request](.github/ISSUE_TEMPLATE/feature_request.md) template.\n\nIn general, here are the skills and tracks you can contribute to:\n\n- **Frontend development**: We build user-centric web-based interfaces. You can contribute to this track if you have\ndecent skills in `HTML`, `CSS`, `JavaScript` and `JQuery`. \nDare to modernize our frontend stack to `VueJS`, `Angular` or `React`? We would love to hear from you. \n- **Backend development**: Our REST APIs are built using `Python Django REST Framework`. \nIn addition, there are some views rendered using `Django template system`. \nContribute to this track if you are familiar with `Python`, `Djnago`, `REST APIs` and databases.\n- **Testing**: writing unit tests, integration tests, and automating this process is at the heart of our\nCI/CD pipeline. Contribute to this track to enhance the reliability of the platform.\n\nBefore submitting a `Pull Request`, get in touch with the project contributors to align what features you will\nbe working on. \n\n## Help\nIn the issues tab, create a new issue with your question.\n\n\n## License\nBSD 2-Clause License\n\nCopyright (c) 2020, The OpenROAD Project All rights reserved.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-openroad-project%2Fopenroad-cloud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe-openroad-project%2Fopenroad-cloud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-openroad-project%2Fopenroad-cloud/lists"}