Skip to content

Add Usage instructions from Tycho Compiler readme #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LakshyAAAgrawal wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Usage instructions from Tycho Compiler readme #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 30 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,41 @@ cd streamblocks-tycho
mvn -DskipTests install
```

### 5. StreamBlocks Platforms
### 5. Usage
After installation, StreamBlocks Tycho can be used as
```
tychoc --source-path <path to directory containing source files> --target-path <path to directory for target files> <entities like actor names>
```
#### Example
##### Compilation
Consider the following example. The following actor reads two streams of numbers and produces a stream that is the pairwise sum of two incoming streams.
```
actor Add () uint(size=8) X, uint(size=8) Y ==> uint(size=8) Z :
action X:[x], Y:[y] ==> Z:[x + y] end
end
```
The above snippet is saved to the file ```source/arith.cal```, then, to compile:
```
tychoc --source-path source --target-path target Add
```
##### Usage of compilation output
The C code generated by the Tycho compiler can be compiled to an executable by
```
cc target/*.c -o Add
```
Given two input files ```in-1``` and ```in-2``` the pairwise sum of their byte streams using the ```Add``` actor in file named ```out``` by running:
```
./Add in-1 in-2 out
```

### 6. StreamBlocks Platforms
The StreamBlocks dataflow compiler has a code generator for multicore platforms and another one for reconfigurable computing using High-Level synthesis.
The repository for those code-generators are located at the following link : [streamblocks-platforms](https://github.com/streamblocks/streamblocks-platforms/blob/master/README.md).

### 6. Original Tycho dataflow compiler repository
### 7. Original Tycho dataflow compiler repository

Tycho dataflow compiler compiler was developed by Lund University and the original repository is located [here](https://bitbucket.org/dataflow/dataflow/).

### 7. Support
### 8. Support

If you have an issue with StreamBlocks-Tycho dataflow compiler please create a new issue in this repository.