From b5ee3422922c61246e8885632aa8485b1bdb6a1b Mon Sep 17 00:00:00 2001 From: MohamedElgammal Date: Fri, 1 Dec 2023 09:35:24 -0500 Subject: [PATCH] Add documentation for Docker image of vtr8 and VTR master --- CHANGELOG.md | 7 +++++++ doc/src/vtr/get_vtr.rst | 10 ++++++++++ 2 files changed, 17 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d27fac3114a..ba313c7720d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -117,6 +117,13 @@ _The following are changes which have been implemented in the VTR master branch ### Deprecated * VPR's breadth-first router (use the timing-driven router, which provides supperiour QoR and Run-time) +### Docker Image + * A docker image is available for VTR 8.0 release on mohamedelgammal/vtr8:latest. You can run it using the following commands: +``` +$ sudo docker pull mohamedelgammal/vtr8:latest +$ sudo docker run -it mohamedelgammal/vtr8:latest +``` + ## v8.0.0-rc2 - 2019-08-01 ### Changed diff --git a/doc/src/vtr/get_vtr.rst b/doc/src/vtr/get_vtr.rst index 54f45a7b1bc..1318d4ffed2 100644 --- a/doc/src/vtr/get_vtr.rst +++ b/doc/src/vtr/get_vtr.rst @@ -31,6 +31,16 @@ The official VTR release is available from: https://verilogtorouting.org/download +VTR Docker Image +~~~~~~~~~~~~~~~~ +A docker image for VTR is available. This image provides all the required packages and python libraries required. However, this ease to compile and run comes at the cost of some runtime increase (<10%). To pull and run the docker image of latest VTR repository, you can run the following commands: + +.. code-block:: bash + + > sudo docker pull mohamedelgammal/vtr-master:latest + > sudo docker run -it mohamedelgammal/vtr-master:latest + + Release ~~~~~~~