Skip to content
Snippets Groups Projects
Commit 95ed9c2b authored by Steffen Vogel's avatar Steffen Vogel :santa_tone2:
Browse files

fix more references

parent efb23ecc
No related branches found
No related tags found
No related merge requests found
Showing
with 42 additions and 47 deletions
......@@ -51,7 +51,6 @@ echo ADMIN_USER: admin
echo ADMIN_PASS: $(kubectl get secret --namespace villas villas-web -o jsonpath="{.data.password}" | base64 --decode)
```
## Access the application
@todo: Add explanation how to access ingress
@todo Add explanation how to access Ingress
......@@ -4,13 +4,13 @@
### Bitstreams
@todo: Create a list of available bitstreams
@todo Create a list of available bitstreams
@todo: Add instructions on how to flash a bitstream.
@todo Add instructions on how to flash a bitstream.
### Indentify PCIexpress device
@todo: Describe the usage of `lspci`
@todo Describe the usage of `lspci`
## Kernel
......@@ -18,7 +18,7 @@
VILLASfpga requires a recent Linux kernel with version > 4.x.x
@todo: Find the lowest supported kernel version.
@todo Find the lowest supported kernel version.
### Command Line
......@@ -26,7 +26,7 @@ VILLASfpga uses the VFIO subsystem to access the FPGA hardware.
VFIO requires an IOMMU.
@todo: Describe the necessary changes to the bootloader/Grub.
@todo Describe the necessary changes to the bootloader/Grub.
### Modules
......@@ -39,4 +39,4 @@ If not
## Run VILLASfpga without Super-User privileges
@todo
\ No newline at end of file
@todo
......@@ -2,7 +2,7 @@
The `average` hook calculates arithmetic mean over a set of signals and insert it as a new value to the samples.
# Implementation
# Implementation {#node-hook-type-average-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/average.cpp
......@@ -15,6 +15,6 @@ https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/average.
The signal offset at which the average signal should be inserted.
## Example
# Example {#node-hook-type-average-example}
@include node/etc/examples/hooks/average.conf
......@@ -2,7 +2,7 @@
The `cast` hook casts the data-type of signals and can set a new name and unit to the casted signal.
# Implementation
# Implementation {#node-hook-type-cast-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/cast.cpp
......@@ -19,6 +19,6 @@ The the type of the casted signal.
## new_type (string) {#node-config-hook-cast-new_type}
## Example
# Example {#node-hook-type-cast-implementation}
@include node/etc/examples/hooks/cast.conf
......@@ -2,7 +2,7 @@
The `decimate` hook reduces the sampling rate by periodically discarding samples.
# Implementation
# Implementation {#node-hook-type-decimate-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/decimate.cpp
......@@ -13,6 +13,6 @@ https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/decimate
The decimation ratio. A value of 4 will skip every, but the 4th sample in a row.
## Example
# Example {#node-hook-type-cast-implementation}
@include node/etc/examples/hooks/decimate.conf
......@@ -2,7 +2,7 @@
The `drop` hook will discard samples which a received with repeating or reordered sequence numbers.
# Implementation
# Implementation {#node-hook-type-drop-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/drop.cpp
......
......@@ -2,7 +2,7 @@
The `dump` hook will print a detailed dump of each processes samples to the standard output.
# Implementation
# Implementation {#node-hook-type-dump-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/dump.cpp
......@@ -11,6 +11,6 @@ https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/dump.cpp
The `dump` hook has no configurable options.
## Example
# Example {#node-hook-type-dump-example}
@include node/etc/examples/hooks/dump.conf
# Dynamic Phasor calculation / DFT {#node-hook-type-dp}
# Implementation
# Implementation {#node-hook-type-dp-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/dp.cpp
# Configuration {#node-config-hook-dp}
## Example
# Example {#node-hook-type-dp-example}
@include node/etc/examples/hooks/dp.conf
# Energy Based Metric calculation {#node-hook-type-ebm}
# Implementation
# Implementation {#node-hook-type-ebm-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/ebm.cpp
# Configuration {#node-config-hook-ebm}
## Example
# Example {#node-hook-type-ebm-example}
@include node/etc/examples/hooks/ebm.conf
......@@ -2,13 +2,11 @@
The `fix` hook checks each sample and adds missing metadata such as timestamps or sequence numbers.
# Implementation
# Implementation {#node-hook-type-fix-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/fix.cpp
# Configuration {#node-config-hook-fix}
## Example
@include node/etc/examples/hooks/fix.conf
The `drop` hook is a built-in hook. It is active by default and does not require any further options.
# Calculate Jitter {#node-hook-type-jitter_calc}
# Implementation
# Implementation {#node-hook-type-jitter_calc-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/jitter_calc.cpp
# Configuration {#node-config-hook-jitter_calc}
## Example
# Example {#node-hook-type-jitter_calc-implementation}
@include node/etc/examples/hooks/jitter_calc.conf
......@@ -3,7 +3,7 @@
The `limit_rate` hook discards samples in order to limit the sample rate to a certain rate.
The decission whether a sample is discarded or not is based on its timestamp.
# Implementation
# Implementation {#node-hook-type-limit_rate-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/limit_rate.cpp
......@@ -12,6 +12,6 @@ https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/limit_ra
## rate (float) {#node-config-hook-limit_rate-rate}
## Example
# Example {#node-hook-type-limit_rate-example}
@include node/etc/examples/hooks/limit_rate.conf
......@@ -5,11 +5,11 @@ The `lua` hook allows for the evaluation arbitrary Lua expressions.
Take a look at some example Lua scripts used by this hook here:
https://git.rwth-aachen.de/acs/public/villas/node/-/tree/master/lua/hooks
# Prerequisites {#node-prereq-node-lua}
# Prerequisites {#node-hook-type-lua-prereq}
This hook requires [Lua](https://www.lua.org/) (>= 5.1).
# Implementation
# Implementation {#node-hook-type-lua-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/lua.cpp
......@@ -83,10 +83,10 @@ Note you can access the current sample using the global Lua variable `smp`.
The Lua hook will pass the complete hook configuration to the `prepare()` Lua function.
So you can add arbitrary settings here which are then consumed by the Lua script.
## Example
# Example {#node-hook-type-lua-example}
@include node/etc/examples/hooks/lua.conf
# Example Lua script
# Example Lua script {#node-hook-type-lua-example-script}
@include node/lua/hooks/test.lua
......@@ -17,6 +17,6 @@ https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/print.cp
## prefix (string) {#node-config-hook-print-prefix}
## Example
# Example {#node-hook-type-print-example}
@include node/etc/examples/hooks/print.conf
......@@ -2,7 +2,7 @@
The `restart` hook tries to detect starts/restarts of simulation cases by looking for wrap-arounds in sequence numbers.
# Implementation
# Implementation {#node-hook-type-restart-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/restart.cpp
......
......@@ -3,7 +3,7 @@
The `scale` hook modifies sample signals by a gain factor and optionally ads an offset.
First the original signal value is multiplied by the gain, then the offset is added.
# Implementation
# Implementation {#node-hook-type-scale-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/scale.cpp
......@@ -22,6 +22,6 @@ The offset which is added to the signal after gain.
The gain which is mulitplied to the signal before the offset is added.
## Example
# Example {#node-hook-type-scale-example}
@include node/etc/examples/hooks/scale.conf
# Shift sequence numbers {#node-hook-type-shift_seq}
# Implementation
# Implementation {#node-hook-type-shift_seq-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/shift_seq.cpp
......@@ -11,6 +11,6 @@ https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/shift_se
The offset which is added to the sequence number of each processed sample.
## Example
# Example {#node-hook-type-shift_seq-example}
@include node/etc/examples/hooks/shift_seq.conf
# Shift timestamps {#node-hook-type-shift_ts}
# Implementation
# Implementation {#node-hook-type-shift_ts-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/shift_ts.cpp
......@@ -11,6 +11,6 @@ https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/shift_ts
## offset (float) {#node-config-hook-shift_ts-offset}
## Example
# Example {#node-hook-type-shift_ts-example}
@include node/etc/examples/hooks/shift_ts.conf
......@@ -3,7 +3,7 @@
The `skip_first` hook discards the first samples of a simulation case.
It can either drop the first `n` samples or drop the first `n` seconds of a case.
# Implementation
# Implementation {#node-hook-type-skip_first-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/skip_first.cpp
......@@ -16,6 +16,6 @@ The configuration consists of two options which are exclusive:
## seconds (integer) {#node-config-hook-skip_first-seconds}
## Example
# Example {#node-hook-type-skip_first-implementation}
@include node/etc/examples/hooks/average.conf
......@@ -34,7 +34,7 @@ For each of the metrics the following moments / attrbributes are collected:
| `stddev` | float | The standard deviation across all collected values. |
| `total` | integer | The total number of collected values. |
# Implementation
# Implementation {#node-hook-type-stats-implementation}
The source code of the hook is available here:
https://git.rwth-aachen.de/acs/public/villas/node/blob/master/lib/hooks/stats.cpp
......@@ -63,6 +63,6 @@ Include full dumps of the histogram buckets into the output.
The file where you want to write the report to.
If omitted, stdout (the terminal) will be used.
## Example
# Example {#node-hook-type-stats-example}
@include node/etc/examples/hooks/stats.conf
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment