Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 405999f

Browse files
author
Alexandre Marquet
authored
Update Readme
Reorganization by adding section titles for examples and performance comparisons. Add details on requirements and installation under Linux.
1 parent 8e0905b commit 405999f

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

‎README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,31 @@ This implementation should be more suited to trellis having more transitions bet
1919
* Viterbi Volk (state parallelization): implements the classical Viterbi algorithm, but uses Volk to enable parallell processing of states (Add-Compare-Select is done on multiple states at the same time).
2020
This implementation should be more suited to trellis having states than transitions between states (it is the case of most error correcting codes).
2121

22+
# Installation
23+
24+
## Requirements
25+
26+
`gr-lazyviterbi` depends on:
27+
* GNURadio >= 3.8.0
28+
* Volk >= 2.0.0
29+
* cmake (same version as for GNURadio 3.8)
30+
31+
## Under linux
32+
33+
Within `gr-lazyviterbi` directory, and as a regular user:
34+
```sh
35+
$ mkdir build
36+
$ cd build
37+
$ cmake ..
38+
$ make -j4
39+
```
40+
A root:
41+
```sh
42+
# make install
43+
```
44+
45+
# Examples
46+
2247
One GRC example is provided in the examples/ directory:
2348
* `simple.grc` simple example showing how each decoder should be use in a typical flowgraph. You will have to populate the variable `base_dir`, and put the full path to the source folder of `gr-lazyviterbi` (for example: `/usr/local/src/gr-lazyviterbi`).
2449

@@ -35,6 +60,8 @@ The convolutional code used in this script can easily be changed by supplying it
3560
treillis in a FSM file (see gr-trellis documentation), to see what kind of speedup
3661
can be expected for a particular use case.
3762

63+
# Performance
64+
3865
There is no best implementation. Performance depends on the trellis, the SNR of the transmission, the processor in your computer.
3966
Bellow is bitrate comparisons for some trellis, using a computer equiped with an Intel core i5 775 (see `examples/bitrate_vs_ebn0.py` for details on simulation parameters).
4067

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /