Merge pull request #15 from precice/dumux-adapter-v1.0.0

Release v1.0.0

.github/issue_template.md

@@ -0,0 +1,28 @@
+## Description
+
+<!--
+Please describe the problem/feature request. Please also describe what you want
+to achieve.
+--->
+
+### Environment
+
+<!--
+Please provide information about the operating system and relevant versions of
+the software.
+
+Example:
+Ubuntu 20.04 LTS, preCICE 2.3.0, DuMuX 3.4, DuMuX-preCICE 0.1
+--->
+
+## Steps to reproduce
+
+<!-- Please describe the steps one has to execture to reproduce the problem. --->
+
+### Expected behavior
+
+<!-- What outcome did you expect? --->
+
+### Actual behavior
+
+<!-- What was the actual outcome? --->

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+## Description
+
+<!--
+Please describe shortly what this merge request is doing and why
+it is needed. If there is an related issue, please mention it here.
+-->
+
+## Checklist
+
+<!--
+Please make sure to go over all points on the checklist and
+mark them as checked.
+-->
+
+- [ ] I made sure that the source files are formatted properly.
+- [ ] I added my changes to the changelog (`CHANGELOG.md`)
+- [ ] I updated the documentation.
+
+<!--
+If the pull request adds new content, please check the points
+below. Otherwise remove the following lines.
+-->
+
+- [ ] I added a test for the new feature.

.github/workflows/build-and-test-dumux-master.yml

@@ -0,0 +1,48 @@
+name: Build and test (DuMuX master)
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+      - main
+
+jobs:
+  build-and-test-dumux-master:
+    strategy:
+      max-parallel: 1
+      matrix:
+        precice_version: [2.4.0, 2.5.0]
+        dune_version: [2.8]
+    container:
+      image: precice/dune-precice:${{ matrix.dune_version }}-${{ matrix.precice_version }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Print python3 version
+      run: python3 --version
+    - name: Print python3 version (/usr/bin/env python3)
+      run: /usr/bin/env python3 --version
+    - name: Build DuMuX master
+      run: |
+        ls -lah
+        git clone --depth 1 https://git.iws.uni-stuttgart.de/dumux-repositories/dumux.git -b master
+        ls -lah
+        export DUNE_CONTROL_PATH=${DUNE_CONTROL_PATH}:${PWD}/dumux/dune.module
+        dunecontrol --opts=/opt/DUMUX/cmake-test.opts --only=dumux all
+    - name: Check out code
+      uses: actions/checkout@v3
+      with:
+        path: dumux-precice
+    - name: Build code
+      run: |
+        ls -lah
+        export DUNE_CONTROL_PATH=${PWD}/dumux:${PWD}/dumux-precice:${DUNE_CONTROL_PATH}
+        echo $DUNE_CONTROL_PATH
+        dunecontrol --only=dumux-precice --opts=./dumux-precice/test/cmake-test.opts all
+        cd dumux-precice/build-cmake/
+        make -j2 build_tests
+    - name: Run tests
+      run: |
+        export DUNE_CONTROL_PATH=${PWD}/dumux:${PWD}/dumux-precice:${DUNE_CONTROL_PATH}
+        cd dumux-precice/build-cmake/
+        export PYTHONPATH=${PWD}/dumux/bin/testing:${PYTHONPATH}
+        CTEST_OUTPUT_ON_FAILURE=1 ctest -j1

.github/workflows/build-and-test.yml

@@ -0,0 +1,40 @@
+name: Build and test
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+      - main
+
+jobs:
+  build-and-test:
+    strategy:
+      max-parallel: 2
+      matrix:
+        dumux_version: [3.4, 3.5]
+        precice_version: [2.3.0, 2.4.0, 2.5.0]
+    container:
+      image: precice/dumux-precice:${{ matrix.dumux_version }}-${{ matrix.precice_version }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Print python3 version
+      run: python3 --version
+    - name: Print python3 version (/usr/bin/env python3)
+      run: /usr/bin/env python3 --version
+    - name: Check out code
+      uses: actions/checkout@v3
+      with:
+        path: dumux-precice
+    - name: Build code
+      run: |
+        ls -lah
+        export DUNE_CONTROL_PATH=${PWD}/dumux-precice:${DUNE_CONTROL_PATH}
+        echo $DUNE_CONTROL_PATH
+        dunecontrol --only=dumux-precice --opts=./dumux-precice/test/cmake-test.opts all
+        cd dumux-precice/build-cmake/
+        make -j2 build_tests
+    - name: Run tests
+      run: |
+        export DUNE_CONTROL_PATH=${PWD}/dumux-precice:${DUNE_CONTROL_PATH}
+        cd dumux-precice/build-cmake/
+        CTEST_OUTPUT_ON_FAILURE=1 ctest -j1

.github/workflows/build-docker-containers.yml

@@ -0,0 +1,73 @@
+name: Build and upload Docker containers
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - develop
+    paths:
+      - 'docker/**'
+      - '.github/workflows/build-docker-containers.yml'
+
+jobs:
+  build-and-release-docker-image:
+    name: Builds a Docker container for testing the DuMuX preCICE adapter
+    runs-on: ubuntu-latest
+    env:
+        dockerhub_username: precice
+    strategy:
+      matrix:
+        dumux_version: [3.4, 3.5]
+        precice_version: [2.3.0, 2.4.0, 2.5.0]
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ env.dockerhub_username }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push Dockerfile
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          context: "{{defaultContext}}:docker"
+          file: "./dockerfile.slim"
+          tags: ${{ env.dockerhub_username }}/dumux-precice:${{ matrix.dumux_version }}-${{ matrix.precice_version }}
+          build-args: |
+            DUNE_VERSION=2.8
+            PRECICEUBUNTU=focal
+            DUMUX_VERSION=${{ matrix.dumux_version }}
+            PRECICE_VERSION=${{ matrix.precice_version }}
+  build-dune-precice:
+    name: Builds a Docker container for testing the DuMuX preCICE adapter (DUNE and preCICE)
+    runs-on: ubuntu-latest
+    env:
+        dockerhub_username: precice
+    strategy:
+      matrix:
+        dune_version: [2.8]
+        precice_version: [2.3.0, 2.4.0, 2.5.0]
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ env.dockerhub_username }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push Dockerfile
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          context: "{{defaultContext}}:docker"
+          file: "./dockerfile_dune-precice.slim"
+          tags: ${{ env.dockerhub_username }}/dune-precice:${{ matrix.dune_version }}-${{ matrix.precice_version }}
+          build-args: |
+            DUNE_VERSION=#{{ matrix.dune_version }}
+            PRECICEUBUNTU=focal
+            PRECICE_VERSION=${{ matrix.precice_version }}

.github/workflows/style-checking.yml

@@ -0,0 +1,35 @@
+name: Style checking
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+      - main
+
+jobs:
+  markdown_linting:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v2
+    - name: Run mdl
+      uses: actionshub/markdownlint@main
+  python_linting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8.10'
+      - name: "Install style checker"
+        run: pip install --user black
+      - name: "Run style check"
+        run: black --check .
+  cpp_linting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run format check
+        run: |
+          sudo apt-get install clang-format-10
+          ./scripts/format/run-clang-format.sh

.gitignore

@@ -1,5 +1,5 @@
 # build system clutter
-build-*
+build-*/
 Testing
 
 # auto-saved files