| Name | runrest JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | https://github.com/hvppycoding/runrest |
| Summary | A wrapper for running REST, a reinforcement learning framework for constructing rectilinear Steiner Minimum tree (RSMT) |
| upload_time | 2024-02-28 03:13:07 |
| maintainer | |
| docs_url | None |
| author | hvppycoding |
| requires_python | |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# runrest
A wrapper for running [REST](https://github.com/cuhk-eda/REST), a reinforcement learning framework for constructing rectilinear Steiner Minimum tree (RSMT)
## How to use
```bash
runrest ./examples/input01.txt
```
### Example input file
x, y coordinates of the terminals are listed in the input file.
New line is used to seperate the nets.
`input01.txt:`
```text
5 0 0 2 4 3 1 4 6 5
```
### Result
The result will be printed to the console.
Or you can use the '--output' option to save the result to a file.
```text
3 1 3 2 0 2 0 4
```
It means the RSMT is constructed by the following edges:
`(3, 1), (3, 2), (0, 2), (0, 4)`
Plot of the output RSMT:
## License
READ THIS LICENSE AGREEMENT CAREFULLY BEFORE USING THIS PRODUCT. BY USING THIS
PRODUCT YOU INDICATE YOUR ACCEPTANCE OF THE TERMS OF THE FOLLOWING AGREEMENT.
THESE TERMS APPLY TO YOU AND ANY SUBSEQUENT LICENSEE OF THIS PRODUCT.
License Agreement for REST
Copyright (c) 2022, The Chinese University of Hong Kong
All rights reserved.
CU-SD LICENSE (adapted from the original BSD license) Redistribution of the any
code, with or without modification, are permitted provided that the conditions
below are met.
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name nor trademark of the copyright holder or the author may be
used to endorse or promote products derived from this software without
specific prior written permission.
4. Users are entirely responsible, to the exclusion of the author, for
compliance with (a) regulations set by owners or administrators of employed
equipment, (b) licensing terms of any other software, and (c) local,
national, and international regulations regarding use, including those
regarding import, export, and use of encryption software.
THIS FREE SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR OR ANY CONTRIBUTOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, EFFECTS OF UNAUTHORIZED OR MALICIOUS NETWORK ACCESS; PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
Raw data
{
"_id": null,
"home_page": "https://github.com/hvppycoding/runrest",
"name": "runrest",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "hvppycoding",
"author_email": "hvppycoding@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a0/d8/ff44f2374912e7d1906975d3049268869f4cb60d925f5c7035b0c32ae104/runrest-0.0.3.tar.gz",
"platform": null,
"description": "# runrest\n\nA wrapper for running [REST](https://github.com/cuhk-eda/REST), a reinforcement learning framework for constructing rectilinear Steiner Minimum tree (RSMT)\n\n## How to use\n\n```bash\nrunrest ./examples/input01.txt\n```\n\n### Example input file\n\nx, y coordinates of the terminals are listed in the input file.\nNew line is used to seperate the nets.\n\n`input01.txt:`\n\n```text\n5 0 0 2 4 3 1 4 6 5\n```\n\n### Result\n\nThe result will be printed to the console. \nOr you can use the '--output' option to save the result to a file. \n\n```text\n3 1 3 2 0 2 0 4\n```\n\nIt means the RSMT is constructed by the following edges: \n`(3, 1), (3, 2), (0, 2), (0, 4)`\n\nPlot of the output RSMT:\n\n\n\n## License\n\nREAD THIS LICENSE AGREEMENT CAREFULLY BEFORE USING THIS PRODUCT. BY USING THIS \nPRODUCT YOU INDICATE YOUR ACCEPTANCE OF THE TERMS OF THE FOLLOWING AGREEMENT. \nTHESE TERMS APPLY TO YOU AND ANY SUBSEQUENT LICENSEE OF THIS PRODUCT.\n\nLicense Agreement for REST\n\nCopyright (c) 2022, The Chinese University of Hong Kong\nAll rights reserved.\n\nCU-SD LICENSE (adapted from the original BSD license) Redistribution of the any \ncode, with or without modification, are permitted provided that the conditions \nbelow are met. \n\n1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n3. Neither the name nor trademark of the copyright holder or the author may be \n used to endorse or promote products derived from this software without \n specific prior written permission.\n\n4. Users are entirely responsible, to the exclusion of the author, for \n compliance with (a) regulations set by owners or administrators of employed \n equipment, (b) licensing terms of any other software, and (c) local, \n national, and international regulations regarding use, including those \n regarding import, export, and use of encryption software.\n\nTHIS FREE SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED \nWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF \nMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT \nSHALL THE AUTHOR OR ANY CONTRIBUTOR BE LIABLE FOR ANY DIRECT, INDIRECT, \nINCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT \nLIMITED TO, EFFECTS OF UNAUTHORIZED OR MALICIOUS NETWORK ACCESS; PROCUREMENT OF \nSUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \nINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN \nCONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) \nARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE \nPOSSIBILITY OF SUCH DAMAGE.\n",
"bugtrack_url": null,
"license": "",
"summary": "A wrapper for running REST, a reinforcement learning framework for constructing rectilinear Steiner Minimum tree (RSMT)",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/hvppycoding/runrest"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0d8ff44f2374912e7d1906975d3049268869f4cb60d925f5c7035b0c32ae104",
"md5": "20fb38ec0f5ad77b92e3e32db810d4e9",
"sha256": "d30a9dcb6d5b8b5d95c6eb6ec839a8d17452451f16f236957a4b37da09a62280"
},
"downloads": -1,
"filename": "runrest-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "20fb38ec0f5ad77b92e3e32db810d4e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13760,
"upload_time": "2024-02-28T03:13:07",
"upload_time_iso_8601": "2024-02-28T03:13:07.633732Z",
"url": "https://files.pythonhosted.org/packages/a0/d8/ff44f2374912e7d1906975d3049268869f4cb60d925f5c7035b0c32ae104/runrest-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-28 03:13:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hvppycoding",
"github_project": "runrest",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "runrest"
}
