Merge branch 'develop' into feature/macOS_M1_support

Author: IshaanDesai

.github/workflows/build_and_test.yaml

@@ -27,7 +27,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        UBUNTU_VERSION: [noble, jammy, focal]
+        UBUNTU_VERSION: [noble, jammy]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.github/workflows/docker.yaml

@@ -6,7 +6,7 @@ jobs:
   build-and-push:
     strategy:
       matrix:
-        ubuntu-version: [noble, jammy, focal]
+        ubuntu-version: [noble, jammy]
 
     runs-on: ubuntu-latest
 

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## latest
 
+- Remove Ubuntu 20.04 from testing and Docker support https://github.com/DataAnalyticsEngineering/FANS/pull/51
+- Add support for `--version` command line argument for checking the version of FANS
 - Modify way to provide micro structure in JSON input https://github.com/DataAnalyticsEngineering/FANS/pull/43
 - Add conda package for FANS https://github.com/DataAnalyticsEngineering/FANS/pull/39
 - Introduce system for checking compiler flags: `avx2` & `fma` https://github.com/DataAnalyticsEngineering/FANS/pull/34

CMakeLists.txt

@@ -187,6 +187,13 @@ set_property(TARGET FANS_FANS PROPERTY PUBLIC_HEADER
         include/material_models/J2Plasticity.h
 )
 
+# version.h is generated and added to the build include directory
+configure_file(
+    "${PROJECT_SOURCE_DIR}/include/version.h.in"
+    "${PROJECT_BINARY_DIR}/include/version.h" @ONLY
+)
+target_include_directories(FANS_main PRIVATE "${PROJECT_BINARY_DIR}/include")
+
 # ##############################################################################
 # SOURCES
 # ##############################################################################

README.md

@@ -167,7 +167,7 @@ FANS is also available as a conda-package on [conda-forge](https://anaconda.org/
 It can be installed via
 
 ```bash
-conda install fans
+conda install conda-forge::fans
 ```
 
 exposing the executable `FANS`.

docker/README.md

@@ -5,7 +5,7 @@ We provide a set of docker images for different use cases on our [Dockerhub prof
 - **fans-ci**: Contains the minimum tools to build FANS (including dev packages of dependencies with the required headers), but does not include FANS itself. Meant for a CI workflow.
 - **fans-dev**: Based upon fans-ci, but offers a non-root user (`fans`) and handling of UID and GID to not mess up permissions when volume mounting into the container. Meant as an quick to setup build environment for FANS.
 
-Both images are built for linux/amd64 and linux/arm64 as well as for the three most recent Ubuntu LTS versions (focal, jammy, noble). The Ubuntu version can be selected through tags, e.g. `fans-dev:focal`; `noble` is equivalent to the `latest` tag. The architecture is selected automatically depending on your host platform.
+Both images are built for linux/amd64 and linux/arm64 as well as for the three most recent Ubuntu LTS versions (jammy and noble). The Ubuntu version can be selected through tags, e.g. `fans-dev:jammy`; `noble` is equivalent to the `latest` tag. The architecture is selected automatically depending on your host platform.
 
 ## Set up a Container
 

include/version.h.in

@@ -0,0 +1,9 @@
+#ifndef VERSION_H
+#define VERSION_H
+
+#define PROJECT_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
+#define PROJECT_VERSION_MINOR @PROJECT_VERSION_MINOR@
+#define PROJECT_VERSION_PATCH @PROJECT_VERSION_PATCH@
+#define PROJECT_VERSION       "@PROJECT_VERSION@"
+
+#endif // VERSION_H

src/main.cpp

@@ -3,6 +3,9 @@
 #include "setup.h"
 #include "solver.h"
 
+// Version
+#include "version.h"
+
 template <int howmany>
 void runSolver(Reader &reader, const char *output_file_basename)
 {
@@ -32,6 +35,11 @@ void runSolver(Reader &reader, const char *output_file_basename)
 
 int main(int argc, char *argv[])
 {
+    if (argc > 1 && string(argv[1]) == "--version") {
+        cout << "FANS version " << PROJECT_VERSION << endl;
+        return 0;
+    }
+
     if (argc != 3) {
         fprintf(stderr, "USAGE: %s [input file basename] [output file basename]\n", argv[0]);
         return 10;