Skip to content

Rework Getting Started guide #125

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

Merged
merged 3 commits into from
Jul 4, 2025
Merged

Rework Getting Started guide #125

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e63fc9f
fix: Move note about example configs to the beginning of the page
stv0g Jul 3, 2025
e5c867e
fix: Fix whitespaces in Getting Started guide
stv0g Jul 3, 2025
7b03a1e
fix: Extend Getting Started guide with more details about lab excercises
stv0g Jul 3, 2025
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
32 changes: 18 additions & 14 deletions docs/node/guides/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,16 @@ The [installation](installation.md) page lists several ways to install VILLASnod

For this guide, we recommend to use the [VILLASnode Docker image](../installation.md#docker) on your workstation.

::: note
We provide a set of example configuration files at [github.com/VILLASframework/node/etc](https://github.com/VILLASframework/node/tree/master/etc).

Please download these files or clone the VILLASnode Git repository to C:\VILLASnode so they can be used in the following labs.
:::

To open an interactive terminal in the VILLASnode Docker container run:

```shell
docker run --privileged --tty --interactive --entrypoint bash --volume C:\path\to\configs:/configs -p 80:80 registry.git.rwth-aachen.de/acs/public/villas/node
docker run --privileged --tty --interactive --entrypoint bash --volume C:\VILLASnode\etc:/configs -p 80:80 registry.git.rwth-aachen.de/acs/public/villas/node
```

For some lab exercises two interactive shells are required. To open a second shell, run the following command:
Expand All @@ -43,7 +49,7 @@ Before we start to use the VILLASnode tools, we will introduce some terminology:

<figure align="center">
<img alt="A two site scenario with VILLASfpga." src="/img/VILLASnode_large.svg" width="75%" />
<figcaption>A two site scenario with VILLASfpga.</figcaption>
<figcaption>A two site scenario with VILLASfpga.</figcaption>
</figure>

## Tools
Expand All @@ -57,18 +63,20 @@ VILLASnode is a collection of command line tools which follow the [Unix philosop

In this guide we will show the following tools:

| Tool | Purpose |
| :---- | :---- |
| [`villas node`](../usage/villas-node.md) | The main VILLASnode daemon. |
| [`villas signal`](../usage/villas-signal.md) | A signal generator for testing and training purposes. |
| [`villas pipe`](../usage/villas-pipe.md) | Send / receive _samples_ to / from _nodes_ via [standard IO streams](https://en.wikipedia.org/wiki/Standard_streams). |
| [`villas hook`](../usage/villas-hook.md) | Filter or manipulate _samples_ provided via [standard IO streams](https://en.wikipedia.org/wiki/Standard_streams). |
| Tool | Purpose |
| :---- | :---- |
| [`villas node`](../usage/villas-node.md) | The main VILLASnode daemon. |
| [`villas signal`](../usage/villas-signal.md) | A signal generator for testing and training purposes. |
| [`villas pipe`](../usage/villas-pipe.md) | Send / receive _samples_ to / from _nodes_ via [standard IO streams](https://en.wikipedia.org/wiki/Standard_streams). |
| [`villas hook`](../usage/villas-hook.md) | Filter or manipulate _samples_ provided via [standard IO streams](https://en.wikipedia.org/wiki/Standard_streams). |

A complete list of available tools and commandline options can be found on the [usage](../usage/index.md) page.

## Lab assignments {#labs}

To get you started quickly, we prepared a series of small demos which you can try yourself.
To help you get started quickly, we have prepared a series of small demos that you can try yourself. They are designed to introduce you step by step to the concepts and features of VILLASnode.

These laboratory exercises use configuration files that are included in the example configurations directory at C:\VILLASnode\etc\labs.

- [**Lab1**](lab1.md): Signal generation
- [**Lab2**](lab2.md): A simple configuration file
Expand All @@ -88,10 +96,6 @@ To get you started quickly, we prepared a series of small demos which you can tr
- [**Lab16**](lab16.md): Visualize simulation data with InfluxDB and Grafana
- [**Lab17**](lab17.md): RTDS-RTDS Co-simulation

:::note
All configurations files are available here: https://github.com/VILLASframework/node/tree/master/etc/labs
:::

## Video

This webinar was recorded during the preparation of the RT-SuperLab demonstration.
Expand All @@ -105,5 +109,5 @@ This video presents an outdated version of VILLASnode!
:::

<video controls width="100%" align="center">
<source src="https://videos.fein-aachen.org/VILLASnode_Webinar_2017_05_08.mp4" type="video/mp4" />
<source src="https://videos.fein-aachen.org/VILLASnode_Webinar_2017_05_08.mp4" type="video/mp4" />
</video>