# xroute_env
RL environment for detailed routing.
## Quickstart
### Installation
To interact with the xroute environment, you need to download the simulator first:
| Operating System | Download Link |
| --- | --- |
| Ubuntu 22.04 | [Download](https://drive.google.com/file/d/1-Zxd0HiOHclNtwCON5wOM78eCzsPrOBB/view?usp=sharing) |
Then, put the simulator in the `third_party/openroad` folder.
### Launch Algorithm Backend
[DQN](./baseline/DQN/README.md)
[PPO](./baseline/DQN/PPO.md)
### Launch Simulator
Run the following command to get launch script:
```bash
cd examples
python3 init.py [start_port][worker_num]
```
start_port: the listen port number of the first worker instance.
worker_num: the number of worker instances.
Raw data
{
"_id": null,
"home_page": "",
"name": "xroute-env",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "Reinforcement Learning,VLSI,EDA,RL,AI,detailed routing,gymnasium",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/73/72/6c473815dce7ff34a433ccba4630ef5612ab7aacbbbde89e0aabdee6ad06/xroute_env-0.0.0.tar.gz",
"platform": null,
"description": "# xroute_env\nRL environment for detailed routing.\n\n## Quickstart\n\n### Installation\n\nTo interact with the xroute environment, you need to download the simulator first:\n\n| Operating System | Download Link |\n| --- | --- |\n| Ubuntu 22.04 | [Download](https://drive.google.com/file/d/1-Zxd0HiOHclNtwCON5wOM78eCzsPrOBB/view?usp=sharing) |\n\nThen, put the simulator in the `third_party/openroad` folder.\n\n### Launch Algorithm Backend\n\n[DQN](./baseline/DQN/README.md)\n\n[PPO](./baseline/DQN/PPO.md)\n\n### Launch Simulator\n\nRun the following command to get launch script:\n\n```bash\ncd examples\npython3 init.py [start_port][worker_num]\n```\n\nstart_port: the listen port number of the first worker instance.\n\nworker_num: the number of worker instances.\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A standard API for reinforcement learning in detailed routing.",
"version": "0.0.0",
"project_urls": {
"Bug Report": "https://github.com/xplanlab/xroute_env/issues",
"Documentation": "https://github.com/xplanlab/xroute_env",
"Homepage": "https://xplan-lab.org/",
"Repository": "https://github.com/xplanlab/xroute_env"
},
"split_keywords": [
"reinforcement learning",
"vlsi",
"eda",
"rl",
"ai",
"detailed routing",
"gymnasium"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "443946c54f0cf96d8b00a3aa25823983190df019eced9a39612034347328cda4",
"md5": "6477c759046690eff61b2ae0f34acdf9",
"sha256": "095e938094573696dd6be6280a4dc0d8945cc6fb4c4174306d235d34584f4cf0"
},
"downloads": -1,
"filename": "xroute_env-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6477c759046690eff61b2ae0f34acdf9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3029,
"upload_time": "2023-06-08T09:22:14",
"upload_time_iso_8601": "2023-06-08T09:22:14.067218Z",
"url": "https://files.pythonhosted.org/packages/44/39/46c54f0cf96d8b00a3aa25823983190df019eced9a39612034347328cda4/xroute_env-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "73726c473815dce7ff34a433ccba4630ef5612ab7aacbbbde89e0aabdee6ad06",
"md5": "4012bc10f0e0dc04e215b8d1eab0bc92",
"sha256": "14ce478e3a602c89f8d99e1ac9fa4ce145b9374337e4194057f4908a4b5d9279"
},
"downloads": -1,
"filename": "xroute_env-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4012bc10f0e0dc04e215b8d1eab0bc92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 2919,
"upload_time": "2023-06-08T09:22:15",
"upload_time_iso_8601": "2023-06-08T09:22:15.851384Z",
"url": "https://files.pythonhosted.org/packages/73/72/6c473815dce7ff34a433ccba4630ef5612ab7aacbbbde89e0aabdee6ad06/xroute_env-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-08 09:22:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xplanlab",
"github_project": "xroute_env",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "xroute-env"
}
JSON
