|
|
|
Prerequisites
|
|
|
|
--
|
|
|
|
This project has been developed (and tested) under Debian 10, thus we can not guarantee it will work with another distribution.
|
|
|
|
|
|
|
|
To use this project, you must install:
|
|
|
|
* [Java 9](https://www.oracle.com/java/java9.html)
|
|
|
|
* [sbt](https://www.scala-sbt.org/) (scala interactive building tool)
|
|
|
|
* **verilator** (see [Chisel](https://github.com/freechipsproject/chisel3/blob/master/SETUP.md) for more informations)
|
|
|
|
* [Vivado](https://www.xilinx.com/products/design-tools/vivado.html) (version *2017.3*, *2018.3* and *2019.1* were tested)
|
|
|
|
|
|
|
|
## Running QECE
|
|
|
|
|
|
|
|
### Local installation
|
|
|
|
|
|
|
|
Currently, one can only use QECE by **locally installing it**.
|
|
|
|
To run the transformations on your own project, you hence need to take a few steps:
|
|
|
|
|
|
|
|
* clone this project, and chose the version/tag you want to use
|
|
|
|
* publish your transformations on your environment, using `sbt publishLocal` (local publication generates the `scaladoc` in `target/scala-2.12/api/index.html`)
|
|
|
|
* in the project in which you want to use this library, update the `build.sbt` with `libraryDependencies += "fr.tima" %% "qece" % "<myVersion>"`
|
|
|
|
* local publication generates the scaladoc in
|
|
|
|
* you can access to the different classes with `import qece.<package>.<Class>`
|
|
|
|
|
|
|
|
**N.B.:** You may have to reload/update your `sbt` project.
|
|
|
|
|
|
|
|
### Remote installation
|
|
|
|
|
|
|
|
We are planning on deploying the project to **sonatype** in order to allow to retrieve the library from a remote repository.
|
|
|
|
However, there is currently some limitations that prevent us from doing so.
|
|
|
|
|
|
|
|
## Using QECE
|
|
|
|
|
|
|
|
First of all, you can take a look at the [API](application-programming-interface) to check how to integrate QECE in your project.
|
|
|
|
|
|
|
|
Moreover, QECE has been used in a **chisel-based** benchmark [here](https://gricad-gitlab.univ-grenoble-alpes.fr/tima/sls/projects/qece-benchmark), and you can check how it is done.
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
|
|
|
|
Go back to [home](home). |
|
|
|
\ No newline at end of file |