Setting up Chisel

We suggest a recipe for preparing the Chisel Environment, so please do that before executing the script provided below.

Dependencies and Tutorial Set-up

We provide a script that will automatically install all the dependencies and set the Chisel Tutorial up, thus putting you in the position to make the next step of the Chisel Learning Journey.

The script has been tested within the suggested Chisel Environment and it should work on any other Ubuntu-like OS. However, it is provided without a warranty and there will be no responsibility by the author nor the provider for any harm caused.

Please download it here, and run it as follows:

sudo ./setLearningJourney.sh

When run, it will inform you about all the details what will it (try to) do on your system and you will have a chance to pull back before it performs any action.

If you prefer not to run the script or you would like to follow the Chisel Learning Journey within a different environment, exact instructions to install Chisel3 are provided at the the original repo¹.

Testing Your System

Once the dependencies have been successfully installed and the tutorial repository obtained, please test if everything is fine, running (remaining inside the directory chisel-tutorial):

$ sbt run

That step is supposed to generate and test a simple block (Hello) that always outputs the number 42 (its value in hexadecimal being 0x2a). You should see [success] on the last line of output (from sbt) and PASSED on the line before indicating the block passed the testcase, as follows:

[info] Running hello.Hello 
[info] [0.011] Elaborating design...
[info] [0.270] Done elaborating.
Total FIRRTL Compile Time: 2238.9 ms
Total FIRRTL Compile Time: 27.6 ms
End of dependency graph
Circuit state created
[info] [0.010] SEED 1514026331022
test Hello Success: 1 tests passed in 6 cycles taking 0.036811 seconds
[info] [0.017] RAN 1 CYCLES PASSED
[success] Total time: 90 s, completed Dec 23, 2017 11:52:15 AM

Since this is the first time you are this, sbt will automatically download the appropriate versions of Chisel3 and Scala and cache them (usually in ~/.ivy2). That's why this first run might take a while.

Next Steps

Please, proceed to the next step, the Chisel Introductory Examples.

---

1) Don't get confused because those instructions mention Firrtl - as you will be building from the release branch of Chisel3, the required jar is taken care of by sbt, so just ignore that part for now.