Merge pull request #21 from camposandro/main

Update project template version

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: v1.4.4
+_commit: v1.4.6-4-gc5b6541
 _src_path: gh:lincc-frameworks/python-project-template
 author_email: [email protected]
 author_name: Sandro Campos

.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.gitattributes

@@ -0,0 +1,24 @@
+# For explanation of this file and uses see
+# https://git-scm.com/docs/gitattributes
+# https://developer.lsst.io/git/git-lfs.html#using-git-lfs-enabled-repositories
+# https://lincc-ppt.readthedocs.io/en/latest/practices/git-lfs.html
+#
+# Used by https://github.com/lsst/afwdata.git
+# *.boost filter=lfs diff=lfs merge=lfs -text
+# *.dat filter=lfs diff=lfs merge=lfs -text
+# *.fits filter=lfs diff=lfs merge=lfs -text
+# *.gz filter=lfs diff=lfs merge=lfs -text
+#
+# apache parquet files
+# *.parq	filter=lfs diff=lfs merge=lfs -text
+#
+# sqlite files
+# *.sqlite3	filter=lfs diff=lfs merge=lfs -text
+#
+# gzip files
+# *.gz	filter=lfs diff=lfs merge=lfs -text
+#
+# png image files
+# *.png	filter=lfs diff=lfs merge=lfs -text
+
+.git_archival.txt export-subst

.github/workflows/asv-main.yml

@@ -1,6 +1,7 @@
 # This workflow will run benchmarks with airspeed velocity (asv), 
 # store the new results in the "benchmarks" branch and publish them
 # to a dashboard on GH Pages.
+
 name: Run ASV benchmarks for main
 
 on:
@@ -16,69 +17,85 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+
   setup-python:
     runs-on: ubuntu-latest
+
     steps:
-    - name: Cache Python ${{ env.PYTHON_VERSION }}
-      uses: actions/cache@v3
-      with:
-        path: ~/.cache/pip
-        key: python-${{ env.PYTHON_VERSION }}
-    - name: Set up Python ${{ env.PYTHON_VERSION }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ env.PYTHON_VERSION }}
+      - name: Cache Python ${{ env.PYTHON_VERSION }}
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: python-${{ env.PYTHON_VERSION }}
+
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: "${{ env.PYTHON_VERSION }}"
+
   asv-main:
     runs-on: ubuntu-latest
     needs: setup-python
+
     permissions:
       contents: write
+
     defaults:
       run:
         working-directory: ${{ env.WORKING_DIR }}
+
     steps:
-    - name: Checkout main branch of the repository
-      uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-    - name: Cache Python ${{ env.PYTHON_VERSION }}
-      uses: actions/cache@v3
-      with:
-        path: ~/.cache/pip
-        key: python-${{ env.PYTHON_VERSION }}
-    - name: Install dependencies
-      run: |
-        sudo apt-get update
-        python -m pip install --upgrade pip
-        pip install asv==0.6.1 virtualenv tabulate
-    - name: Configure git
-      run: |
-        git config user.name "github-actions[bot]"
-        git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
-    - name: Create ASV machine config file
-      run: asv machine --machine gh-runner --yes
-    - name: Fetch previous results from the "benchmarks" branch
-      run: |
-        if git ls-remote --exit-code origin benchmarks > /dev/null 2>&1; then
-          git merge origin/benchmarks \
-            --allow-unrelated-histories \
-            --no-commit
-          mv ../_results .
-        fi
-    - name: Run ASV for the main branch
-      run: asv run ALL --skip-existing --verbose
-    - name: Submit new results to the "benchmarks" branch
-      uses: JamesIves/github-pages-deploy-action@v4
-      with:
-        branch: benchmarks
-        folder: ${{ env.WORKING_DIR }}/_results
-        target-folder: _results
-    - name: Generate dashboard HTML
-      run: |
-        asv show
-        asv publish
-    - name: Deploy to Github pages
-      uses: JamesIves/github-pages-deploy-action@v4
-      with:
-        branch: gh-pages
-        folder: ${{ env.WORKING_DIR }}/_html
+      - name: Checkout main branch of the repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Cache Python ${{ env.PYTHON_VERSION }}
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: python-${{ env.PYTHON_VERSION }}
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          python -m pip install --upgrade pip
+          pip install asv==0.6.1 virtualenv tabulate
+
+      - name: Configure git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Create ASV machine config file
+        run: asv machine --machine gh-runner --yes
+
+      - name: Fetch previous results from the "benchmarks" branch
+        run: |
+          if git ls-remote --exit-code origin benchmarks > /dev/null 2>&1; then
+            git merge origin/benchmarks \
+              --allow-unrelated-histories \
+              --no-commit
+            mv ../_results .
+          fi
+
+      - name: Run ASV for the main branch
+        run: asv run ALL --skip-existing --verbose || true
+
+      - name: Submit new results to the "benchmarks" branch
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: benchmarks
+          folder: ${{ env.WORKING_DIR }}/_results
+          target-folder: _results
+
+      - name: Generate dashboard HTML
+        run: |
+          asv show
+          asv publish
+
+      - name: Deploy to Github pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: ${{ env.WORKING_DIR }}/_html

.github/workflows/asv-nightly.yml

@@ -1,6 +1,7 @@
 # This workflow will run daily at 06:45.
 # It will run benchmarks with airspeed velocity (asv)
 # and compare performance with the previous nightly build.
+
 name: Run benchmarks nightly job
 
 on:
@@ -14,66 +15,79 @@ env:
   NIGHTLY_HASH_FILE: nightly-hash
 
 jobs:
+
   asv-nightly:
     runs-on: ubuntu-latest
+
     defaults:
       run:
         working-directory: ${{ env.WORKING_DIR }}
+
     steps:
-    - name: Checkout main branch of the repository
-      uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-    - name: Cache Python ${{ env.PYTHON_VERSION }}
-      uses: actions/cache@v3
-      with:
-        path: ~/.cache/pip
-        key: python-${{ env.PYTHON_VERSION }}
-    - name: Set up Python ${{ env.PYTHON_VERSION }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ env.PYTHON_VERSION }}
-    - name: Install dependencies
-      run: |
-        sudo apt-get update
-        python -m pip install --upgrade pip
-        pip install asv==0.6.1 virtualenv
-    - name: Configure git
-      run: |
-        git config user.name "github-actions[bot]"
-        git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
-    - name: Create ASV machine config file
-      run: asv machine --machine gh-runner --yes
-    - name: Fetch previous results from the "benchmarks" branch
-      run: |
-        if git ls-remote --exit-code origin benchmarks > /dev/null 2>&1; then
-          git merge origin/benchmarks \
-            --allow-unrelated-histories \
-            --no-commit
-          mv ../_results .
-        fi
-    - name: Get nightly dates under comparison
-      id: nightly-dates
-      run: |
-        echo "yesterday=$(date -d yesterday +'%Y-%m-%d')" >> $GITHUB_OUTPUT
-        echo "today=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
-    - name: Use last nightly commit hash from cache
-      uses: actions/cache@v3
-      with:
-        path: ${{ env.WORKING_DIR }}
-        key: nightly-results-${{ steps.nightly-dates.outputs.yesterday }}
-    - name: Run comparison of main against last nightly build
-      run: |
-        HASH_FILE=${{ env.NIGHTLY_HASH_FILE }}
-        CURRENT_HASH=${{ github.sha }}
-        if [ -f $HASH_FILE ]; then          
-          PREV_HASH=$(cat $HASH_FILE)
-          asv continuous $PREV_HASH $CURRENT_HASH --verbose || true
-          asv compare $PREV_HASH $CURRENT_HASH --sort ratio --verbose
-        fi
-        echo $CURRENT_HASH > $HASH_FILE
-    - name: Update last nightly hash in cache
-      uses: actions/cache@v3
-      with:
-        path: ${{ env.WORKING_DIR }}
-        key: nightly-results-${{ steps.nightly-dates.outputs.today }}
+      - name: Checkout main branch of the repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Cache Python ${{ env.PYTHON_VERSION }}
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: python-${{ env.PYTHON_VERSION }}
+
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: "${{ env.PYTHON_VERSION }}"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          python -m pip install --upgrade pip
+          pip install asv==0.6.1 virtualenv
+
+      - name: Configure git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Create ASV machine config file
+        run: asv machine --machine gh-runner --yes
+
+      - name: Fetch previous results from the "benchmarks" branch
+        run: |
+          if git ls-remote --exit-code origin benchmarks > /dev/null 2>&1; then
+            git merge origin/benchmarks \
+              --allow-unrelated-histories \
+              --no-commit
+            mv ../_results .
+          fi
+
+      - name: Get nightly dates under comparison
+        id: nightly-dates
+        run: |
+          echo "yesterday=$(date -d yesterday +'%Y-%m-%d')" >> $GITHUB_OUTPUT
+          echo "today=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
+
+      - name: Use last nightly commit hash from cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.WORKING_DIR }}
+          key: nightly-results-${{ steps.nightly-dates.outputs.yesterday }}
+
+      - name: Run comparison of main against last nightly build
+        run: |
+          HASH_FILE=${{ env.NIGHTLY_HASH_FILE }}
+          CURRENT_HASH=${{ github.sha }}
+          if [ -f $HASH_FILE ]; then          
+            PREV_HASH=$(cat $HASH_FILE)
+            asv continuous $PREV_HASH $CURRENT_HASH --verbose || true
+            asv compare $PREV_HASH $CURRENT_HASH --sort ratio --verbose
+          fi
+          echo $CURRENT_HASH > $HASH_FILE
+
+      - name: Update last nightly hash in cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.WORKING_DIR }}
+          key: nightly-results-${{ steps.nightly-dates.outputs.today }}

benchmarks/benchmarks.py

@@ -1,7 +1,7 @@
-import benchmarking_asv as bench
+from benchmarking_asv import example_module
 
 
-class TimeSuite: # pylint: disable=too-few-public-methods
+class TimeSuite:  # pylint: disable=too-few-public-methods
     """An example benchmark that times the performance of various kinds
     of iterating over dictionaries in Python."""
 
@@ -15,23 +15,23 @@ def setup(self):
 
     def time_keys(self):
         """Time first method."""
-        bench.example_module.run_time_computation()
+        example_module.run_time_computation()
 
     def time_iterkeys(self):
         """Time second method."""
-        bench.example_module.run_time_computation()
+        example_module.run_time_computation()
 
     def time_range(self):
         """Time third method."""
-        bench.example_module.run_time_computation()
+        example_module.run_time_computation()
 
     def time_xrange(self):
         """Time fourth method."""
-        bench.example_module.run_time_computation()
+        example_module.run_time_computation()
 
 
-class MemSuite: # pylint: disable=too-few-public-methods
+class MemSuite:  # pylint: disable=too-few-public-methods
     """An example benchmark that times memory consumption."""
 
     def mem_list(self):
-        return bench.example_module.run_mem_computation()
+        return example_module.run_mem_computation()