Merge branch 'master' into python-wrapper

Signed-off-by: Kevin Vu te Laar <vu.te@rwth-aachen.de>

Author: Kevin Vu te Laar

.clang-format

@@ -7,3 +7,18 @@ BasedOnStyle: LLVM
 # Disable automatic line-breaks in comments
 # as this breaks SPDX headers
 ReflowComments: false
+
+# Regroup #include directives to villas - std - other
+IncludeBlocks: Regroup
+IncludeIsMainRegex: / # disable main header heuristic
+IncludeCategories:
+  - Regex: '^<villas/'
+    Priority: 3
+    CaseSensitive: true
+  - Regex: '^<[[:lower:]_]+>$'
+    Priority: 1
+    CaseSensitive: true
+  - Regex: '^<.*>$'
+    Priority: 2
+  - Regex: '^".*"$'
+    Priority: 4

.envrc

@@ -2,3 +2,5 @@
 # SPDX-License-Identifier: Apache-2.0
 
 use flake
+pre-commit install
+pre-commit install -t prepare-commit-msg

.git-blame-ignore-revs

@@ -19,3 +19,6 @@ b1e8cd81da9a3e3d27db27d49d265afc53e0ce4d
 
 # Update Steffens mail address in common/
 6427fae1e4ca0467e09688d56cec0dcd7d5e600d
+
+# Apply uniform #include style to all files
+817393134850845ea1237621b6b0f41e133f9829

.github/workflows/paper.yaml

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: 2025 OPAL-RT Germany GmbH
+# SPDX-License-Identifier: Apache-2.0
+
+---
+name: Draft PDF
+
+on:
+  push:
+    paths:
+        - paper/**
+        - .github/workflows/paper.yaml
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Build draft PDF
+      uses: openjournals/openjournals-draft-action@v1.0
+      with:
+        journal: joss
+        paper-path: paper/paper.md
+
+    - name: Upload
+      uses: actions/upload-artifact@v4
+      with:
+        name: paper
+        path: paper/paper.pdf

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
     rev: v5.0.0
     hooks:
       - id: trailing-whitespace
-        exclude: \.patch$
+        exclude: \.patch$|^paper\.md$
       - id: end-of-file-fixer
         exclude: \.(svg|patch)$
       - id: check-ast
@@ -19,6 +19,7 @@ repos:
         exclude: .devcontainer/devcontainer\.json
       - id: check-toml
       - id: check-added-large-files
+        exclude: ^paper\.md$
       - id: pretty-format-json
         # black has its own mind of formatting Jupyter notebooks
         exclude: \.ipynb$|^.devcontainer/devcontainer\.json$|package-lock\.json$
@@ -54,4 +55,13 @@ repos:
     rev: "v0.13.0"
     hooks:
       - id: markdownlint
+        exclude: ^paper\.md$
         args: [-r, "~MD013,~MD033,~MD024"]
+
+  - repo: local
+    hooks:
+      - id: dco-hook
+        name: check DCO
+        entry: ./tools/pre-commit-dco-hook.sh
+        language: script
+        stages: [prepare-commit-msg]

CITATION.cff

@@ -0,0 +1,56 @@
+# SPDX-FileCopyrightText: 2025 OPAL-RT Germany GmbH
+# SPDX-License-Identifier: Apache-2.0
+cff-version: "1.2.0"
+authors:
+- family-names: Vogel
+  given-names: Steffen
+  orcid: "https://orcid.org/0000-0003-3384-6750"
+- family-names: Eiling
+  given-names: Niklas
+  orcid: "https://orcid.org/0000-0002-7011-9846"
+- family-names: Pitz
+  given-names: Manuel
+  orcid: "https://orcid.org/0000-0002-6252-2029"
+- family-names: Bach
+  given-names: Alexandra
+  orcid: "https://orcid.org/0009-0005-7385-4642"
+- family-names: Stevic
+  given-names: Marija
+- family-names: Monti
+  given-names: Prof. Antonello
+  orcid: "https://orcid.org/0000-0003-1914-9801"
+doi: 10.5281/zenodo.16917994
+message: If you use this software, please cite our article in the
+  Journal of Open Source Software.
+preferred-citation:
+  authors:
+  - family-names: Vogel
+    given-names: Steffen
+    orcid: "https://orcid.org/0000-0003-3384-6750"
+  - family-names: Eiling
+    given-names: Niklas
+    orcid: "https://orcid.org/0000-0002-7011-9846"
+  - family-names: Pitz
+    given-names: Manuel
+    orcid: "https://orcid.org/0000-0002-6252-2029"
+  - family-names: Bach
+    given-names: Alexandra
+    orcid: "https://orcid.org/0009-0005-7385-4642"
+  - family-names: Stevic
+    given-names: Marija
+  - family-names: Monti
+    given-names: Prof. Antonello
+    orcid: "https://orcid.org/0000-0003-1914-9801"
+  date-published: 2025-08-29
+  doi: 10.21105/joss.08401
+  issn: 2475-9066
+  issue: 112
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 8401
+  title: "VILLASnode: An Open-Source Real-time Multi-protocol Gateway"
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.08401"
+  volume: 10
+title: "VILLASnode: An Open-Source Real-time Multi-protocol Gateway"

CMakeLists.txt

@@ -7,15 +7,15 @@
 cmake_minimum_required(VERSION 3.15)
 
 project(villas-node
-    VERSION 0.0.0
-    DESCRIPTION "VILLASnode"
+    VERSION 1.0.1
+    DESCRIPTION "Open-Source Real-time Multi-protocol Gateway"
     HOMEPAGE_URL "https://www.fein-aachen.org/projects/villas-node/"
     LANGUAGES C CXX
 )
 
 # Some more project settings
 set(PROJECT_AUTHOR "Steffen Vogel")
-set(PROJECT_COPYRIGHT "2014-2021, Institute for Automation of Complex Power Systems, RWTH Aachen University")
+set(PROJECT_COPYRIGHT "2014-2025 The VILLASframework Authors")
 
 # Several CMake settings/defaults
 set(CMAKE_C_STANDARD 11)
@@ -48,7 +48,6 @@ include(FindPkgConfig)
 include(CheckIncludeFile)
 include(FeatureSummary)
 include(GNUInstallDirs)
-include(GetVersion)
 include(FindSymbol)
 include(CMakeDependentOption)
 
@@ -76,19 +75,17 @@ find_package(Lua)
 find_package(LibDataChannel)
 find_package(re)
 find_package(OpenDSSC)
+find_package(FileSystem)
+find_package(Criterion)
 
 # Check for tools
+find_program(PROTOBUFC_COMPILER NAMES protoc-c)
+find_program(PROTOBUF_COMPILER NAMES protoc)
 find_program(PASTE NAMES paste)
 if(NOT PASTE)
     message(SEND_ERROR "GNU paste is missing. Please install coreutils")
 endif()
 
-# Check programs
-find_program(PROTOBUFC_COMPILER NAMES protoc-c)
-find_program(PROTOBUF_COMPILER NAMES protoc)
-
-# Build without any GPL-code
-option(WITHOUT_GPL "Build VILLASnode without any GPL code" OFF)
 
 set(ENV{PKG_CONFIG_PATH} "$ENV{PKG_CONFIG_PATH}:/usr/local/lib/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/share/pkgconfig:/usr/lib64/pkgconfig")
 
@@ -157,7 +154,15 @@ else()
     set(FOUND_FPGA_SUBMODULES OFF)
 endif()
 
+if(CXX17_FILESYSTEM)
+    set(STDCXX_FS_NOT_FOUND OFF)
+else()
+    set(STDCXX_FS_NOT_FOUND ON)
+endif()
+
 # Build options
+cmake_dependent_option(WITHOUT_GPL          "Build VILLASnode without any GPL code"                 OFF                "" ON)
+cmake_dependent_option(WITH_GHC_FS          "Build using ghc::filesystem, a drop in replacement for std::filesystem"  ON "STDCXX_FS_NOT_FOUND" OFF)
 cmake_dependent_option(WITH_DEFAULTS        "Defaults for non required build options"               ON                 "" OFF)
 
 cmake_dependent_option(WITH_API             "Build with remote control API"                         "${WITH_DEFAULTS}" "" OFF)
@@ -206,7 +211,7 @@ cmake_dependent_option(WITH_NODE_WEBSOCKET  "Build with websocket node-type"
 cmake_dependent_option(WITH_NODE_ZEROMQ     "Build with zeromq node-type"                           "${WITH_DEFAULTS}" "LIBZMQ_FOUND; NOT WITHOUT_GPL" OFF)
 cmake_dependent_option(WITH_NODE_OPENDSS    "Build with opendss node-type"                          "${WITH_DEFAULTS}" "OpenDSSC_FOUND" OFF)
 
-# set a default for the build type
+# Set a default for the build type
 if("${CMAKE_BUILD_TYPE}" STREQUAL "")
     set(CMAKE_BUILD_TYPE "Debug")
 endif()
@@ -227,8 +232,10 @@ else()
     add_compile_options(-Wno-error)
 endif()
 
-# Get version info and buildid from Git
-GetVersion(${PROJECT_SOURCE_DIR} "CMAKE_PROJECT")
+if(WITH_GHC_FS)
+    find_package(ghc_filesystem 1.5.14 REQUIRED)
+    include_directories($<TARGET_PROPERTY:ghcFilesystem::ghc_filesystem,INTERFACE_INCLUDE_DIRECTORIES>)
+endif()
 
 if(WITH_FPGA)
     add_subdirectory(fpga)
@@ -314,19 +321,11 @@ add_feature_info(NODE_ZEROMQ            WITH_NODE_ZEROMQ            "Build with
 
 if(TOPLEVEL_PROJECT)
     feature_summary(WHAT ALL VAR FEATURES)
-    message(STATUS "Building ${CMAKE_PROJECT_DESCRIPTION}:")
+    message(STATUS "Building ${PROJECT_NAME}:")
     message(STATUS "${FEATURES}")
 
-    if(FOUND_GIT_VERSION)
-        message(STATUS "  VERSION:         ${CMAKE_PROJECT_VERSION}")
-        message(STATUS "  RELEASE:         ${CMAKE_PROJECT_RELEASE}")
-        message(STATUS "  GIT_REV:         ${CMAKE_PROJECT_GIT_REV}")
-        message(STATUS "  GIT_BRANCH:      ${CMAKE_PROJECT_GIT_BRANCH}")
-        message(STATUS "  VARIANT:         ${CMAKE_PROJECT_VARIANT}")
-        message(STATUS "  BUILD_ID:        ${CMAKE_PROJECT_BUILD_ID}")
-        message(STATUS "  BUILD_DATE:      ${CMAKE_PROJECT_BUILD_DATE}")
-    endif()
 
+    message(STATUS "  VERSION:         ${CMAKE_PROJECT_VERSION}")
     message(STATUS "  ARCH:            ${CMAKE_SYSTEM_PROCESSOR}")
     message(STATUS "  OS:              ${CMAKE_SYSTEM_NAME}")
 endif()

LICENSE

@@ -58,7 +58,7 @@ APPENDIX: How to apply the Apache License to your work.
 
 To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
 
-Copyright [yyyy] [name of copyright owner]
+Copyright 2014-2025 The VILLASframework Authors
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

LICENSES/Apache-2.0.txt

@@ -58,7 +58,7 @@ APPENDIX: How to apply the Apache License to your work.
 
 To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
 
-Copyright [yyyy] [name of copyright owner]
+Copyright 2014-2025 The VILLASframework Authors
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

LICENSES/BSD-1-Clause.txt

@@ -1,7 +1,7 @@
-Copyright (c) <year> <owner>. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Copyright (c) 2014-2025 The VILLASframework Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.