From f7291c455006b94fae5b9cdc0b831b3496d6cad5 Mon Sep 17 00:00:00 2001 From: Kutalmis Bercin Date: Thu, 6 Jun 2024 09:25:03 +0100 Subject: [PATCH] SUBMODULE: add data-community plugin (fixes #3146) SUBMODULE: update turbulence-community plugin ENH: README: add info to differentiate the modules from the plugins --- .gitmodules | 3 +++ modules/README.md | 9 +++++++-- plugins/README.md | 9 +++++++-- plugins/data-community | 1 + plugins/turbulence-community | 2 +- 5 files changed, 19 insertions(+), 5 deletions(-) create mode 160000 plugins/data-community diff --git a/.gitmodules b/.gitmodules index d15f331dd6..d60f805332 100644 --- a/.gitmodules +++ b/.gitmodules @@ -20,3 +20,6 @@ [submodule "turbulence-community"] path = plugins/turbulence-community url = https://gitlab.com/openfoam/community/tc-turbulence/turbulence-community.git +[submodule "plugins/data-community"] + path = plugins/data-community + url = https://gitlab.com/openfoam/community/sig-data-modelling/data-community.git diff --git a/modules/README.md b/modules/README.md index 0dc15e01df..866a1e88e2 100644 --- a/modules/README.md +++ b/modules/README.md @@ -1,12 +1,17 @@ [[_TOC_]] -## OpenFOAM Modules +## OpenFOAM modules This directory is a location for additional OpenFOAM components or tools to placed and have them built as part of the normal OpenFOAM build process. It is assumed that each subdirectory contain an appropriate `Allwmake` (or `Allwmake.override`) file. +The primary distinction between `modules` and `plugins` is that `modules` are +mainly maintained and released by OpenFOAM developers, whereas `plugins` are an +open and welcoming area for add-ons, predominantly maintained and driven by +OpenFOAM community members and groups. + ### How to use On the first use, you need to register the submodules, and then update them. @@ -91,7 +96,7 @@ To build the doxygen information for the components, it is also necessary to link the directories to the doc/ subdirectory. This is a purely manual operation. -### Developer Information +### Developer information #### Build locations diff --git a/plugins/README.md b/plugins/README.md index 46e44b7c7d..037100b986 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -1,12 +1,17 @@ [[_TOC_]] -## OpenFOAM Plugins +## OpenFOAM plugins This directory is a location for additional OpenFOAM components or tools to placed and have them built as part of the normal OpenFOAM build process. It is assumed that each subdirectory contain an appropriate `Allwmake` (or `Allwmake.override`) file. +The primary distinction between `modules` and `plugins` is that `modules` are +mainly maintained and released by OpenFOAM developers, whereas `plugins` are an +open and welcoming area for add-ons, predominantly maintained and driven by +OpenFOAM community members and groups. + ### How to use On the first use, you need to register the submodules, and then update them. @@ -88,7 +93,7 @@ To build the doxygen information for the components, it is also necessary to link the directories to the doc/ subdirectory. This is a purely manual operation. -### Developer Information +### Developer information #### Build locations diff --git a/plugins/data-community b/plugins/data-community new file mode 160000 index 0000000000..cfb50e6b1a --- /dev/null +++ b/plugins/data-community @@ -0,0 +1 @@ +Subproject commit cfb50e6b1a182bda5f25d5690f26a23fc8d22c8f diff --git a/plugins/turbulence-community b/plugins/turbulence-community index 06b391bb47..4dbaff2c56 160000 --- a/plugins/turbulence-community +++ b/plugins/turbulence-community @@ -1 +1 @@ -Subproject commit 06b391bb475f0386342b6f9b7fe5496ae87e464f +Subproject commit 4dbaff2c56cacd3b5170cfd2899f003b1dc5832a