FourCIPP 0.28.0__tar.gz

fourcipp-0.28.0/.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = src/fourcipp/version.py

fourcipp-0.28.0/.github/workflows/check_code.yaml

@@ -0,0 +1,42 @@
+name: Code quality
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  fourcipp-code-check:
+    name: Code check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up virtual environment
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-update-conda: true
+          conda-remove-defaults: true
+          activate-environment: fourcipp
+          python-version: 3.12
+      - name: Install requirements
+        shell: bash -el {0}
+        run: |
+          conda activate fourcipp
+          pip install -e .[dev,safe]
+          pip install pre-commit
+      - name: Run code-checks
+        shell: bash -el {0}
+        run: |
+          conda activate fourcipp
+          if [ "${GITHUB_REF}" = "refs/heads/main" ]; then
+            SKIP=no-commit-to-branch pre-commit run --all-files
+          else
+            pre-commit run --all-files
+          fi

fourcipp-0.28.0/.github/workflows/publish_pypi.yaml

@@ -0,0 +1,35 @@
+name: Build and upload to PyPI
+
+on:
+  push:
+    tags:
+      # Build and publish wheel for each new version of FourCIPP
+      - "v[0-9]*.[0-9]*.[0-9]*"
+
+jobs:
+  build_dist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Build sdist and wheel
+        run: pipx run build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  upload_pypi:
+    needs: build_dist
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          name: dist
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

fourcipp-0.28.0/.github/workflows/run_testsuite.yaml

@@ -0,0 +1,79 @@
+name: Testsuite
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+  schedule:
+    - cron: "30 5 * * *" # Run after metadata file update
+
+jobs:
+  run_pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.13"]
+    defaults:
+      run:
+        shell: bash -l {0}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up virtual environment
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-update-conda: true
+          conda-remove-defaults: true
+          activate-environment: fourcipp
+          python-version: ${{ matrix.python-version }}
+      - name: Install requirements
+        shell: bash -el {0}
+        run: |
+          conda activate fourcipp
+          pip install -e .[dev,safe]
+      - name: Run pytest
+        shell: bash -el {0}
+        run: |
+          conda activate fourcipp
+          pytest --color=yes -v --performance-tests --no-cov
+          cat timings.md >> $GITHUB_STEP_SUMMARY
+
+  run_pytest_with_4C:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/4c-multiphysics/4c:main
+    defaults:
+      run:
+        shell: bash -l {0}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up virtual environment
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-update-conda: true
+          conda-remove-defaults: true
+          activate-environment: fourcipp
+          python-version: 3.13
+      - name: Install requirements
+        shell: bash -el {0}
+        run: |
+          conda activate fourcipp
+          pip install -e .[dev,safe]
+      - name: Run pytest using 4C_docker_main config
+        run: |
+          fourcipp switch-config-profile 4C_docker_main
+          pytest --color=yes -v
+      - name: Run pytest using default config
+        # For this job coverage is turned off, otherwise the checks would fail.
+        # Coverage is done in the 4C docker job, as here 4C test input files are available.
+        run: |
+          fourcipp switch-config-profile default
+          pytest --color=yes -v --no-cov

fourcipp-0.28.0/.github/workflows/tag_version.yaml

@@ -0,0 +1,65 @@
+name: Auto Tag Versioning
+
+on:
+  workflow_run:
+    workflows: ["Testsuite"]
+    types:
+      - completed
+
+jobs:
+  tag:
+    # only tag versions after a new commit to main and after successful testing (not after scheduled/cron testing)
+    if: github.event.workflow_run.event == 'push' && github.event.workflow_run.head_branch == 'main' && github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.PAT_4C_BOT_MERGE_TO_MAIN }}
+
+      - name: Get latest tag
+        id: get_tag
+        run: |
+          latest=$(git tag --list 'v[0-9]*.[0-9]*.[0-9]*' | sort -V | tail -n1)
+          echo "Latest tag: $latest"
+          echo "latest_tag=$latest" >> "$GITHUB_OUTPUT"
+
+      - name: Check if commit is already tagged
+        id: check_tag
+        run: |
+          tag=$(git tag --points-at HEAD | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' || true)
+          if [ -n "$tag" ]; then
+            echo "This commit is already tagged with $tag. Skipping auto-tag."
+            echo "skip=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "No version tag on this commit. Proceeding."
+            echo "skip=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Compute next version tag
+        if: steps.check_tag.outputs.skip != 'true'
+        id: new_tag
+        run: |
+          latest="${{ steps.get_tag.outputs.latest_tag }}"
+          version="${latest#v}"
+          IFS='.' read -r major minor patch <<< "$version"
+          minor=$((minor + 1))
+          new_tag="v${major}.${minor}.0"
+          echo "New tag: $new_tag"
+          echo "tag=$new_tag" >> "$GITHUB_OUTPUT"
+
+      - name: Configure Git user
+        if: steps.check_tag.outputs.skip != 'true'
+        run: |
+          git config user.name "4C-Bot"
+          git config user.email "207683181+4C-Bot@users.noreply.github.com"
+
+      - name: Create and push new tag
+        if: steps.check_tag.outputs.skip != 'true'
+        run: |
+          git tag ${{ steps.new_tag.outputs.tag }}
+          git push origin ${{ steps.new_tag.outputs.tag }}

fourcipp-0.28.0/.github/workflows/update_4C_metadata_schema_file.yaml

@@ -0,0 +1,90 @@
+name: Update 4C metadata and schema file
+
+on:
+  schedule:
+    - cron: "0 5 * * *" # run each night at 5AM. Current nightly 4C test should be completed by then
+
+jobs:
+  update-4C-metadata-schema-file:
+    name: Update 4C metadata and schema file
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.PAT_4C_BOT_MERGE_TO_MAIN }}
+      - name: Pull latest metadata file from 4C
+        uses: dawidd6/action-download-artifact@v9
+        with:
+          repo: 4C-multiphysics/4C
+          github_token: ${{ secrets.ORGANIZATION_TOKEN }}
+          workflow: nightly_tests.yml
+          workflow_conclusion: completed
+          name: clang18_build-metadata
+          path: clang18_build-metadata
+      - name: Pull latest schema file from 4C
+        uses: dawidd6/action-download-artifact@v9
+        with:
+          repo: 4C-multiphysics/4C
+          github_token: ${{ secrets.ORGANIZATION_TOKEN }}
+          workflow: nightly_tests.yml
+          workflow_conclusion: completed
+          name: clang18_build-schema
+          path: clang18_build-schema
+      # Format new files with pre-commit (this needs to be done before the files are hashed to ensure that both are formatted)
+      - name: Set up virtual environment
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-update-conda: true
+          conda-remove-defaults: true
+          activate-environment: fourcipp
+          python-version: 3.12
+      - name: Install requirements
+        shell: bash -el {0}
+        run: |
+          conda activate fourcipp
+          pip install -e .[dev,safe]
+          pip install pre-commit
+      # files need to be specified because they are not yet staged and therefore pre-commit cannot find them
+      # pre-commit hook is run twice to not fail if the first run fails (due to formatting files)
+      - name: Run pre-commit, i.e., format files
+        shell: bash -el {0}
+        run: |
+          conda activate fourcipp
+          SKIP=no-commit-to-branch pre-commit run --files clang18_build-metadata/4C_metadata.yaml clang18_build-schema/4C_schema.json || SKIP=no-commit-to-branch pre-commit run --files clang18_build-metadata/4C_metadata.yaml clang18_build-schema/4C_schema.json
+      # Compare the hashes
+      - name: Check if metadata file has changed and overwrite old file if necessary
+        run: |
+          set -euo pipefail
+          hash_current=$(grep -v 'commit_hash' src/fourcipp/config/4C_metadata.yaml | sha256sum | awk '{print $1}')
+          hash_new=$(grep -v 'commit_hash' clang18_build-metadata/4C_metadata.yaml | sha256sum | awk '{print $1}')
+
+          echo "Current metadata file hash: $hash_current"
+          echo "New metadata file hash:     $hash_new"
+
+          if [ "$hash_current" != "$hash_new" ]; then
+              mv clang18_build-metadata/4C_metadata.yaml src/fourcipp/config/4C_metadata.yaml
+              mv clang18_build-schema/4C_schema.json src/fourcipp/config/4C_schema.json
+              rm -r clang18_build-metadata
+              rm -r clang18_build-schema
+
+              echo "metadata_file_changed=true" >> $GITHUB_ENV
+          else
+              echo "metadata_file_changed=false" >> $GITHUB_ENV
+          fi
+      # Commit and push changes
+      - name: Get 4C hash for commit message
+        if: env.metadata_file_changed == 'true'
+        run: echo "fourc_commit_hash=$(awk '/commit_hash:/ {print $2}' src/fourcipp/config/4C_metadata.yaml)" >> $GITHUB_ENV
+      - name: Commit and push changes
+        if: env.metadata_file_changed == 'true'
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Nightly update of 4C metadata and schema file (4C commit hash: ${{ env.fourc_commit_hash }})"
+          branch: main
+          push_options: --force
+          commit_options: "--no-verify"
+          commit_user_name: 4C-Bot
+          commit_user_email: 207683181+4C-Bot@users.noreply.github.com
+          commit_author: 4C-Bot <207683181+4C-Bot@users.noreply.github.com>

fourcipp-0.28.0/.gitignore

@@ -0,0 +1,323 @@
+# Manually added files & folder
+
+# FourCIPP version file
+src/fourcipp/version.py
+
+# FourCIPP config file
+src/fourcipp/config/config.yaml
+
+# Automatically created section
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,macos,linux,windows,visualstudiocode,pycharm
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,macos,linux,windows,visualstudiocode,pycharm
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# All stuff in the .idea folder is usually not useful to share, as it contains
+# user-specific or machine-specific settings.
+.idea/
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/python,macos,linux,windows,visualstudiocode,pycharm