hughes2d 1.1.3__tar.gz

hughes2d-1.1.3/.github/workflows/auto-release.yml

@@ -0,0 +1,77 @@
+name: Auto-release
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    name: Create a new release
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Check if already released
+        id: check_release
+        run: |
+          CURRENT_COMMIT=$(git rev-parse HEAD)
+          echo "Current commit: $CURRENT_COMMIT"
+          if git tag --points-at $CURRENT_COMMIT | grep -q "^v"; then
+            echo "already_released=true" >> $GITHUB_OUTPUT
+            echo "This commit already has a release tag. Will skip release."
+            git tag --points-at $CURRENT_COMMIT
+          else
+            echo "already_released=false" >> $GITHUB_OUTPUT
+            echo "No release tag found. Proceeding with release."
+          fi
+
+      - name: Setup Python environment
+        if: steps.check_release.outputs.already_released == 'false'
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.13
+
+      - name: Install uv
+        if: steps.check_release.outputs.already_released == 'false'
+        uses: astral-sh/setup-uv@v7
+
+      - name: Ensure repo status is clean
+        if: steps.check_release.outputs.already_released == 'false'
+        run: git status
+
+      - name: Build package
+        if: steps.check_release.outputs.already_released == 'false'
+        run: uv build
+
+      - name: Publish package (trusted publishing)
+        if: steps.check_release.outputs.already_released == 'false'
+        run: uv publish --trusted-publishing always
+
+      - name: Get version number from uv
+        if: steps.check_release.outputs.already_released == 'false'
+        run: echo "VERSION_NUM = $(uv version --short)" >> $GITHUB_OUTPUT
+        id: version
+
+      - name: Create release in GitHub repo
+        if: steps.check_release.outputs.already_released == 'false'
+        uses: ncipollo/release-action@v1
+        with:
+          bodyFile: "docs/releases/v${{ steps.version.outputs.VERSION_NUM }}.md"
+          token: ${{ secrets.GITHUB_TOKEN }}
+          tag: v${{ steps.version.outputs.VERSION_NUM }}
+
+      - name: Ensure complete
+        if: steps.check_release.outputs.already_released == 'false'
+        run: echo "Auto-release complete!"

hughes2d-1.1.3/.github/workflows/draft-pdf.yml

@@ -0,0 +1,29 @@
+name: Draft PDF
+on:
+  push:
+    paths:
+      - paper.md
+      - paper.bib
+      - .github/workflows/draft-pdf.yml
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: paper.pdf

hughes2d-1.1.3/.github/workflows/run_tests.yml

@@ -0,0 +1,66 @@
+# This workflow will install Python dependencies, run tests and generate a coverage badge with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+# And for example of an integration with uv see: https://github.com/pyjanitor-devs/pyjanitor/tree/dev/.github/workflows
+
+name: Tests with pytest
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+          python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies without extras
+      run: |
+        uv sync
+        uv add pytest
+        
+    - name: Test with pytest without extras
+      run: |
+        #This only test the import errors when extras are not installed
+        uv run -m pytest test/test_Mesh2D_squareDomain_plots.py test/test_run_examples.py
+
+    - name: setup ffmpeg for matplotlib save testing
+      uses: FedericoCarboni/setup-ffmpeg@v3
+      id: setup-ffmpeg
+
+    - name: Test with all extras and generate .coverage
+      run: |
+        uv sync --all-extras
+        uv run coverage run -m pytest
+
+    - name: Run coveralls
+      run: |
+        uv run pip install coveralls
+        coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        
+        

hughes2d-1.1.3/.github/workflows/versioning.yml

@@ -0,0 +1,94 @@
+#Based on the auto-release action of pyjanitor: https://github.com/pyjanitor-devs/pyjanitor/blob/dev/.github/workflows/auto-release.yml
+
+name: Auto-versioning
+
+on:
+  # Manual release for minor/major versions.
+  # To cut a new release, navigate to the Actions section of the repo
+  # and select this workflow (Auto-release) on the right hand side.
+  # Then, click "Run workflow" and select major, minor, or patch.
+  workflow_dispatch:
+    inputs:
+      version_name:
+        description: "One of major, minor, or patch"
+        required: true
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+      change_log_note:
+        description: "The changelog entry for the version"
+        required: true
+        type: string
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  version:
+    name: Create a new version
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Setup Python environment
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.13
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Set version name
+        run: echo "VERSION_NAME=${{ github.event.inputs.version_name }}" >> $GITHUB_ENV
+
+      - name: Dry run uv version bump
+        run: uv version --bump ${{ env.VERSION_NAME }} --dry-run --short
+
+      - name: Store new version number
+        run: echo "version_number=$(uv version --bump ${{ env.VERSION_NAME }} --dry-run --short | tr -d ' \n')" >> $GITHUB_ENV
+
+      - name: Display new version number
+        run: |
+          echo "version_name: ${{ env.VERSION_NAME }}"
+          echo "version_number: v${{ env.version_number }}"
+
+      - name: Ensure repo status is clean
+        run: git status
+
+      - name: Configure Git
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+
+      - name: Run uv version bump
+        run: uv version --bump ${{ env.VERSION_NAME }} --frozen
+
+      - name: Update CHANGELOG
+        run: sed -i "1s;^;\n## [${{ env.version_number }}] - ($(date +'%d/%m/%Y'))\n\n${{ github.event.inputs.change_log_note }};" CHANGELOG.md
+
+      - name: Update doc
+        run: sed -i "s|version = .*|version = '${{ env.version_number }}'|" docs/source/conf.py
+
+      - name: Update __init__.py
+        run: sed -i "s|__version__ = .*|__version__ = '${{ env.version_number }}'|" src/hughes2d/__init__.py
+        
+      - name: Commit version bump and create tag
+        run: |
+          git add pyproject.toml CHANGELOG.md docs/source/conf.py src/hughes2d/__init__.py
+          git commit -m "Bump version to ${{ env.version_number }}"
+          git tag v${{ env.version_number }}
+
+      - name: Ensure tag creation
+        run: git tag | grep ${{ env.version_number }}
+
+      - name: Push changes with tags
+        run: |
+          git push && git push --tags
+
+      - name: Ensure complete
+        run: echo "Auto-versioning complete!"

hughes2d-1.1.3/.gitignore

@@ -0,0 +1,15 @@
+#Untrack pyc and pycache folder
+
+*.pyc
+**/__pycache__/
+
+#Untrack data files
+
+*.csv
+*.json
+
+#Untrack rendered files
+
+*.png
+*.mp4
+*.svg

hughes2d-1.1.3/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.15.10
+    hooks:
+    # Run the linter.
+    -   id: ruff-check
+        types_or: [ python, pyi, pyproject ]
+        args: [ --fix ]
+    # Run the formatter.
+    -   id: ruff-format
+        types_or: [ python, pyi ]
+
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-toml
+    -   id: check-added-large-files
+
+-   repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.11.7
+    hooks:
+    -   id: uv-lock

hughes2d-1.1.3/.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: "2"
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+sphinx:
+  configuration: docs/source/conf.py
+
+formats:
+  - pdf
+  - epub

hughes2d-1.1.3/AUTHORS

@@ -0,0 +1,4 @@
+# Creation, code and development
+
+- Théo Girard (Laboratoire Jacques-Louis Lions, Université Paris cité)
+<theo.girard@math.cnrs.fr>.

hughes2d-1.1.3/CHANGELOG.md

@@ -0,0 +1,24 @@
+
+## [1.1.3] - (16/04/2026)
+
+- Setup of auto-versioning
+## [1.1.2] - (14/04/2026)
+
+- Fixing example 08/time-slices
+- Fixing the warning due to the use of the deprecated datetime.utcnow() in the default filenames
+- The default file format for pictures is now svg instead of png in save_time_slices()
+
+## [1.1.1] - (25/12/2025)
+
+- Adding AUTHORS, LICENCE files
+- Adding "Citation" section in both documentation and README
+
+## [1.1.0] - (04/12/2025)
+
+- Paper.md now detail both the models and numerical schemes.
+- The README.md and documentation usage.rst now present how to create a simple domain, mesh and how to run simple simulations.
+- python version (>=3.10) --> (>=3.11) because of the use of **typing.Self** for type hint of special methods *__add__* and *__mult__* of CellValueMap and VertexValueMap objects.
+
+## [1.0.0] - (27/10/2025)
+
+_First release._

hughes2d-1.1.3/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to Hughes2d
+
+Thanks for your interest and for taking contribution into consideration for the Hughes2d package !!!
+Below are a few information about how to contribute to this project.
+
+
+
+#### Table of contents
+* [Useful links and contact](#useful-links-and-contact)
+* [Setting up the environment](https://github.com/TheoRGirard/hughes2d/README.md)
+* [How to submit changes](#how-to-submit-changes)
+* [How to report a bug](#how-to-report-a-bug)
+
+
+## Useful links and contact
+
+* [documentation](https://hughes2d.readthedocs.io/en/latest/index.html)
+* [bugs and known issues]
+* Contact: theo.girard\\@\math.cnrs.fr
+
+## How to submit changes 
+If you want to, you're welcome to submit changes to the Hughes2d via a pull request. 
+You should expect an answer within the 3 next weeks in the worst case scenario.
+
+## How to report a bug
+Feel free to report a bug using the issue section of the github repo.