VILLASnode/README.md

# <img src="doc/pictures/villas_node.png" width=40 /> VILLASnode

[![build status](https://git.rwth-aachen.de/acs/public/villas/node/badges/master/pipeline.svg)](https://git.rwth-aachen.de/acs/public/villas/node/-/pipelines/)

This is VILLASnode, a gateway for processing and forwardning simulation data between real-time simulators.
VILLASnode is a client/server application to connect simulation equipment and software such as:

 - OPAL-RT RT-LAB,
 - RTDS GTFPGA cards,
 - RTDS GTWIF cards,
 - Simulink,
 - LabView,
 - and FPGA models

by using protcols such as:

 - IEEE 802.2 Ethernet / IP / UDP,
 - ZeroMQ & nanomsg,
 - MQTT & AMQP
 - WebSockets
 - Shared Memory
 - Files
 - IEC 61850 Sampled Values / GOOSE
 - Analog/Digital IO via Comedi drivers
 - Infiniband (ibverbs)

It's designed with a focus on very low latency to achieve real-time exchange of simulation data.
VILLASnode is used in distributed- and co-simulation scenarios and developed for the field of power grid simulation at the EON Energy Research Center in Aachen, Germany.

## Documentation

User documentation is available here: <https://villas.fein-aachen.org/docs/>

## License

This project is released under the terms of the [Apache 2.0 license](LICENSE).

We kindly ask all academic publications employing components of VILLASframework to cite one of the following papers:

- A. Monti et al., "[A Global Real-Time Superlab: Enabling High Penetration of Power Electronics in the Electric Grid](https://ieeexplore.ieee.org/document/8458285/)," in IEEE Power Electronics Magazine, vol. 5, no. 3, pp. 35-44, Sept. 2018.
- S. Vogel, M. Mirz, L. Razik and A. Monti, "[An open solution for next-generation real-time power system simulation](http://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=8245739&isnumber=8244404)," 2017 IEEE Conference on Energy Internet and Energy System Integration (EI2), Beijing, 2017, pp. 1-6.

For other licensing options please consult [Prof. Antonello Monti](mailto:amonti@eonerc.rwth-aachen.de).

- SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
- SPDX-FileCopyrightText: 2023 OPAL-RT Germany GmbH
- SPDX-License-Identifier: Apache-2.0

## Contact

[![EONERC ACS Logo](doc/pictures/eonerc_logo.png)](http://www.acs.eonerc.rwth-aachen.de)

- Steffen Vogel <post@steffenvogel.de>
- Marija Stevic <mstevic@eonerc.rwth-aachen.de>

[Institute for Automation of Complex Power Systems (ACS)](http://www.acs.eonerc.rwth-aachen.de)  
[EON Energy Research Center (EONERC)](http://www.eonerc.rwth-aachen.de)  
[RWTH University Aachen, Germany](http://www.rwth-aachen.de)
added logo to README 2017-04-25 15:23:46 +02:00			`# <img src="doc/pictures/villas_node.png" width=40 /> VILLASnode`
use markdown for build status and added coverage 2016-10-01 12:16:15 +02:00
ci: fix build badge Signed-off-by: Steffen Vogel <post@steffenvogel.de> 2022-12-07 10:49:54 +01:00			`[![build status](https://git.rwth-aachen.de/acs/public/villas/node/badges/master/pipeline.svg)](https://git.rwth-aachen.de/acs/public/villas/node/-/pipelines/)`
change S2SS -> VILLASndoe 2016-08-14 21:58:54 +02:00
Merge branch 'develop' of git.rwth-aachen.de:acs/VILLASnode into develop 2016-08-29 00:10:20 -04:00			`This is VILLASnode, a gateway for processing and forwardning simulation data between real-time simulators.`
several updates to documentation structure 2017-03-12 16:52:42 -03:00			`VILLASnode is a client/server application to connect simulation equipment and software such as:`
change S2SS -> VILLASndoe 2016-08-14 21:58:54 +02:00
Update README.md 2017-06-27 09:32:19 +02:00			`- OPAL-RT RT-LAB,`
several updates to documentation structure 2017-03-12 16:52:42 -03:00			`- RTDS GTFPGA cards,`
Update README.md 2017-06-27 09:32:19 +02:00			`- RTDS GTWIF cards,`
several updates to documentation structure 2017-03-12 16:52:42 -03:00			`- Simulink,`
			`- LabView,`
Update README.md 2017-06-27 09:32:19 +02:00			`- and FPGA models`

			`by using protcols such as:`

			`- IEEE 802.2 Ethernet / IP / UDP,`
update README 2018-06-30 01:30:06 +02:00			`- ZeroMQ & nanomsg,`
			`- MQTT & AMQP`
Update README.md 2017-06-27 09:32:19 +02:00			`- WebSockets`
			`- Shared Memory`
			`- Files`
update README 2018-06-30 01:30:06 +02:00			`- IEC 61850 Sampled Values / GOOSE`
			`- Analog/Digital IO via Comedi drivers`
			`- Infiniband (ibverbs)`
Update README.md 2017-06-27 09:32:19 +02:00
update README 2018-06-30 01:30:06 +02:00			`It's designed with a focus on very low latency to achieve real-time exchange of simulation data.`
several updates to documentation structure 2017-03-12 16:52:42 -03:00			`VILLASnode is used in distributed- and co-simulation scenarios and developed for the field of power grid simulation at the EON Energy Research Center in Aachen, Germany.`
change S2SS -> VILLASndoe 2016-08-14 21:58:54 +02:00
move more documetnation to new repo 2017-05-06 18:37:55 +02:00			`## Documentation`
Update of link to the prebuild documentation hosted on Octopus 2 2016-08-30 16:25:41 +02:00
Fix link to documentation in README Signed-off-by: Steffen Vogel <steffen.vogel@opal-rt.com> 2023-07-06 11:05:34 +02:00			`User documentation is available here: <https://villas.fein-aachen.org/docs/>`
Update of link to the prebuild documentation hosted on Octopus 2 2016-08-30 16:25:41 +02:00
added copyright, license and contact info to README 2017-04-26 10:00:55 +02:00			`## License`

relicense VILLASnode to Apache 2.0 2022-07-04 18:20:03 +02:00			`This project is released under the terms of the [Apache 2.0 license](LICENSE).`
added copyright, license and contact info to README 2017-04-26 10:00:55 +02:00
added note to cite our paper 2018-09-20 11:18:15 +02:00			`We kindly ask all academic publications employing components of VILLASframework to cite one of the following papers:`

			`- A. Monti et al., "[A Global Real-Time Superlab: Enabling High Penetration of Power Electronics in the Electric Grid](https://ieeexplore.ieee.org/document/8458285/)," in IEEE Power Electronics Magazine, vol. 5, no. 3, pp. 35-44, Sept. 2018.`
			`- S. Vogel, M. Mirz, L. Razik and A. Monti, "[An open solution for next-generation real-time power system simulation](http://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=8245739&isnumber=8244404)," 2017 IEEE Conference on Energy Internet and Energy System Integration (EI2), Beijing, 2017, pp. 1-6.`

added copyright, license and contact info to README 2017-04-26 10:00:55 +02:00			`For other licensing options please consult [Prof. Antonello Monti](mailto:amonti@eonerc.rwth-aachen.de).`

Add missing RWTH copyright to main README.md Signed-off-by: Steffen Vogel <steffen.vogel@opal-rt.com> 2023-09-05 12:42:12 +02:00			`- SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University`
added note to cite our paper 2018-09-20 11:18:15 +02:00			`- SPDX-FileCopyrightText: 2023 OPAL-RT Germany GmbH`
several updates to documentation structure 2017-03-12 16:52:42 -03:00			`- SPDX-License-Identifier: Apache-2.0`
Make project REUSE compliant And various other cleanups and harmonizations Signed-off-by: Steffen Vogel <steffen.vogel@opal-rt.com> 2023-08-31 11:25:01 +02:00
change S2SS -> VILLASndoe 2016-08-14 21:58:54 +02:00			`## Contact`

			`[![EONERC ACS Logo](doc/pictures/eonerc_logo.png)](http://www.acs.eonerc.rwth-aachen.de)`

update mail address 2022-03-15 09:18:01 -04:00			`- Steffen Vogel <post@steffenvogel.de>`
Merge branch 'develop' of git.rwth-aachen.de:acs/VILLASnode into develop 2016-08-29 00:10:20 -04:00			`- Marija Stevic <mstevic@eonerc.rwth-aachen.de>`

added copyright, license and contact info to README 2017-04-26 10:00:55 +02:00			`[Institute for Automation of Complex Power Systems (ACS)](http://www.acs.eonerc.rwth-aachen.de)`
			`[EON Energy Research Center (EONERC)](http://www.eonerc.rwth-aachen.de)`
			`[RWTH University Aachen, Germany](http://www.rwth-aachen.de)`