fdsreader 1.11.7__tar.gz → 1.11.9__tar.gz

fdsreader-1.11.9/.gitattributes

@@ -0,0 +1 @@
+*.tgz filter=lfs diff=lfs merge=lfs -text

fdsreader-1.11.9/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,54 @@
+name: Bug report
+description: Report an error or unexpected behavior
+title: "[Bug]: "
+labels: [bug]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Welcome to the fdsreader GitHub repository!
+        We always appreciate feedback from our users.
+        Please fill out as many fields as possible to help us reproduce the bug 
+        more easily.
+
+        Thank you for using fdsreader!
+
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: |
+        Tell us how to reproduce this bug.
+        If possible, please include a minimal, fully reproducible example or a link to a Git repository.
+      placeholder: Put your code or a link here
+
+  - type: textarea
+    id: fds-version
+    attributes:
+      label: FDS version used
+      description: Please tell us what FDS version was used.
+      placeholder: Version 
+    validations:
+      required: true
+
+  - type: textarea
+    id: fdsreader-version
+    attributes:
+      label: fdsreader version used
+      description: Please tell us what fdsreader version was used.
+      placeholder: Version 
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "_Thanks for submitting this bug report!_"

fdsreader-1.11.9/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

fdsreader-1.11.9/.github/last_tested_fds_version.txt

@@ -0,0 +1 @@
+FDS-6.8.0

fdsreader-1.11.9/.github/workflows/ci.yml

@@ -0,0 +1,94 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - "fdsreader/**"
+      - "tests/**"
+      - "pyproject.toml"
+      - "docs/**"
+      - ".readthedocs.yaml"
+      - ".github/workflows/ci.yml"
+  pull_request:
+    paths:
+      - "fdsreader/**"
+      - "tests/**"
+      - "pyproject.toml"
+      - "docs/**"
+      - ".readthedocs.yaml"
+
+jobs:
+  changes:
+    runs-on: ubuntu-latest
+    outputs:
+      code: ${{ steps.filter.outputs.code }}
+      docs: ${{ steps.filter.outputs.docs }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            code:
+              - "fdsreader/**"
+              - "tests/**"
+              - "pyproject.toml"
+            docs:
+              - "docs/**"
+              - ".readthedocs.yaml"
+
+  lint:
+    needs: changes
+    if: needs.changes.outputs.code == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ruff
+      - run: ruff check fdsreader/
+      - run: ruff format --check fdsreader/
+
+  test:
+    needs: changes
+    if: needs.changes.outputs.code == 'true'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: Prepare test cases
+        run: cd tests/cases && for f in *.tgz; do tar -xzvf "$f"; done
+      - name: Run tests
+        run: pytest tests/ --cov=fdsreader --cov-report=xml --cov-report=term-missing
+      - name: Upload coverage
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+
+  docs-build:
+    needs: changes
+    if: needs.changes.outputs.docs == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: pip install -e ".[docs]"
+      - name: Build docs
+        run: sphinx-build --keep-going -b html docs/ docs/_build/html

fdsreader-1.11.9/.github/workflows/fds_compat.yml

@@ -0,0 +1,85 @@
+name: FDS Compatibility Check
+
+on:
+  workflow_dispatch:
+    inputs:
+      fds_version:
+        description: "FDS version tag (e.g. FDS-6.10.1) — leave empty for latest"
+        required: false
+  schedule:
+    - cron: "0 6 * * 1"  # Every Monday 06:00 UTC
+
+jobs:
+  detect-version:
+    runs-on: ubuntu-latest
+    outputs:
+      run_compat: ${{ steps.check.outputs.run_compat }}
+      fds_version: ${{ steps.check.outputs.fds_version }}
+    steps:
+      - uses: actions/checkout@v4
+      - id: check
+        run: |
+          if [ -n "${{ inputs.fds_version }}" ]; then
+            echo "fds_version=${{ inputs.fds_version }}" >> $GITHUB_OUTPUT
+            echo "run_compat=true" >> $GITHUB_OUTPUT
+          else
+            LATEST=$(gh api repos/firemodels/fds/releases/latest --jq '.tag_name')
+            LAST=$(cat .github/last_tested_fds_version.txt 2>/dev/null || echo "none")
+            echo "fds_version=$LATEST" >> $GITHUB_OUTPUT
+            if [ "$LATEST" != "$LAST" ]; then
+              echo "run_compat=true" >> $GITHUB_OUTPUT
+            else
+              echo "run_compat=false" >> $GITHUB_OUTPUT
+            fi
+          fi
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+  check-compat:
+    needs: detect-version
+    if: needs.detect-version.outputs.run_compat == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Download FDS
+        run: |
+          VERSION=${{ needs.detect-version.outputs.fds_version }}
+          ASSET_URL=$(gh api repos/firemodels/fds/releases/tags/${VERSION} --jq '.assets[] | select(.name | test("_lnx\\.sh$")) | .browser_download_url' | head -n1)
+          if [ -z "$ASSET_URL" ]; then
+            echo "No Linux installer asset found for release $VERSION" >&2
+            exit 1
+          fi
+          wget -q "$ASSET_URL" -O fds_install.sh
+          echo "" | bash fds_install.sh --prefix=$HOME/fds
+        env:
+          GH_TOKEN: ${{ github.token }}
+      - name: Run test simulations
+        run: |
+          FDS=$HOME/fds/bin/fds_openmp
+          for dir in tests/cases/fds_inputs/*.fds; do
+            name=$(basename "$dir" .fds)
+            mkdir -p /tmp/fds_out/$name
+            cd /tmp/fds_out/$name
+            $FDS "$GITHUB_WORKSPACE/$dir" || true
+            cd $GITHUB_WORKSPACE
+          done
+      - name: Install fdsreader and run tests
+        run: |
+          pip install ".[dev]"
+          cd tests/cases && for f in *.tgz; do tar -xzvf "$f"; done
+          cd ../..
+          pytest tests/ -v
+      - name: Update tracked FDS version
+        if: success()
+        run: |
+          echo "${{ needs.detect-version.outputs.fds_version }}" > .github/last_tested_fds_version.txt
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add .github/last_tested_fds_version.txt
+          git diff --staged --quiet || git commit -m "chore: update last tested FDS version to ${{ needs.detect-version.outputs.fds_version }}"
+          git push

fdsreader-1.11.9/.github/workflows/release.yml

@@ -0,0 +1,65 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.x"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-testpypi:
+    if: contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc')
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/fdsreader
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    if: "!contains(github.ref_name, 'a') && !contains(github.ref_name, 'b') && !contains(github.ref_name, 'rc')"
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fdsreader
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: |
+          gh release create '${{ github.ref_name }}' dist/** \
+            --repo '${{ github.repository }}' \
+            --generate-notes