Update PPT version

.copier-answers.yml

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

.github/ISSUE_TEMPLATE/1-bug_report.md

@@ -13,5 +13,5 @@ assignees: ''
 Please check the following:
 
 - [ ] I have described the situation in which the bug arose, including what code was executed, information about my environment, and any applicable data others will need to reproduce the problem.
-- [ ] I have included available evidence of the unexpected behavior (including error messages, screenshots, and/or plots) as well as a descriprion of what I expected instead.
-- [ ] If I have a solution in mind, I have provided an explanation and/or pseudocode and/or task list.
+- [ ] I have included available evidence of the unexpected behavior (including error messages, screenshots, and/or plots) as well as a description of what I expected instead.
+- [ ] If I have a solution in mind, I have provided an explanation and/or pseudocode and/or task list.

.github/ISSUE_TEMPLATE/2-feature_request.md

@@ -7,12 +7,12 @@ assignees: ''
 
 ---
 
-** Feature request**
+**Feature request**
 
 
 **Before submitting**
 Please check the following:
 
 - [ ] I have described the purpose of the suggested change, specifying what I need the enhancement to accomplish, i.e. what problem it solves.
 - [ ] I have included any relevant links, screenshots, environment information, and data relevant to implementing the requested feature, as well as pseudocode for how I want to access the new functionality.
-- [ ] If I have ideas for how the new feature could be implemented, I have provided explanations and/or pseudocode and/or task lists for the steps.
+- [ ] If I have ideas for how the new feature could be implemented, I have provided explanations and/or pseudocode and/or task lists for the steps.

.github/workflows/asv-main.yml

@@ -1,7 +1,6 @@
 # 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:
@@ -10,66 +9,38 @@ on:
 
 env:
   PYTHON_VERSION: "3.10"
-  WORKING_DIR: ${{ github.workspace }}/benchmarks
+  ASV_VERSION: "0.6.4"
+  WORKING_DIR: ${{github.workspace}}/benchmarks
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{github.workflow}}-${{github.ref}}
   cancel-in-progress: true
 
 jobs:
-
-  setup-python:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Cache Python ${{ env.PYTHON_VERSION }}
-        uses: actions/cache@main
-        with:
-          path: ~/.cache/pip
-          key: python-${{ env.PYTHON_VERSION }}
-
-      - name: Set up Python ${{ env.PYTHON_VERSION }}
-        uses: actions/setup-python@main
-        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 }}
-
+        working-directory: ${{env.WORKING_DIR}}
     steps:
+      - name: Set up Python ${{env.PYTHON_VERSION}}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{env.PYTHON_VERSION}}
       - name: Checkout main branch of the repository
         uses: actions/checkout@main
         with:
           fetch-depth: 0
-
-      - name: Cache Python ${{ env.PYTHON_VERSION }}
-        uses: actions/cache@main
-        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
-
+        run: pip install "asv[virtualenv]==${{env.ASV_VERSION}}"
       - 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
@@ -78,24 +49,20 @@ jobs:
               --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
+          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
+          folder: ${{env.WORKING_DIR}}/_html

.github/workflows/asv-nightly.yml

@@ -1,59 +1,44 @@
 # 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:
+  pull_request:
+    branches: [ main ]
   schedule:
     - cron: 45 6 * * *
   workflow_dispatch:
 
 env:
   PYTHON_VERSION: "3.10"
-  WORKING_DIR: ${{ github.workspace }}/benchmarks
+  ASV_VERSION: "0.6.4"
+  WORKING_DIR: ${{github.workspace}}/benchmarks
   NIGHTLY_HASH_FILE: nightly-hash
 
 jobs:
-
   asv-nightly:
     runs-on: ubuntu-latest
-
     defaults:
       run:
-        working-directory: ${{ env.WORKING_DIR }}
-
+        working-directory: ${{env.WORKING_DIR}}
     steps:
+      - name: Set up Python ${{env.PYTHON_VERSION}}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{env.PYTHON_VERSION}}
       - name: Checkout main branch of the repository
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-
-      - name: Cache Python ${{ env.PYTHON_VERSION }}
-        uses: actions/cache@v4
-        with:
-          path: ~/.cache/pip
-          key: python-${{ env.PYTHON_VERSION }}
-
-      - name: Set up Python ${{ env.PYTHON_VERSION }}
-        uses: actions/setup-python@v5
-        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
-
+        run: pip install "asv[virtualenv]==${{env.ASV_VERSION}}"
       - 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
@@ -62,32 +47,28 @@ jobs:
               --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@v4
         with:
-          path: ${{ env.WORKING_DIR }}
-          key: nightly-results-${{ steps.nightly-dates.outputs.yesterday }}
-
+          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          
+          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@v4
         with:
-          path: ${{ env.WORKING_DIR }}
-          key: nightly-results-${{ steps.nightly-dates.outputs.today }}
+          path: ${{env.WORKING_DIR}}
+          key: nightly-results-${{steps.nightly-dates.outputs.today}}

.github/workflows/asv-pr.yml

@@ -11,76 +11,60 @@ on:
   workflow_dispatch:
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{github.workflow}}-${{github.ref}}
   cancel-in-progress: true
 
 env:
   PYTHON_VERSION: "3.10"
-  WORKING_DIR: ${{ github.workspace }}/benchmarks
-  ARTIFACTS_DIR: ${{ github.workspace }}/artifacts
+  ASV_VERSION: "0.6.4"
+  WORKING_DIR: ${{github.workspace}}/benchmarks
+  ARTIFACTS_DIR: ${{github.workspace}}/artifacts
 
 jobs:
-  setup-python:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Cache Python ${{ env.PYTHON_VERSION }}
-      uses: actions/cache@v4
-      with:
-        path: ~/.cache/pip
-        key: python-${{ env.PYTHON_VERSION }}
-    - name: Set up Python ${{ env.PYTHON_VERSION }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ env.PYTHON_VERSION }}
   asv-pr:
     runs-on: ubuntu-latest
-    needs: setup-python
     defaults:
       run:
-        working-directory: ${{ env.WORKING_DIR }}
+        working-directory: ${{env.WORKING_DIR}}
     steps:
+    - name: Set up Python ${{env.PYTHON_VERSION}}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{env.PYTHON_VERSION}}
     - name: Checkout PR branch of the repository
       uses: actions/checkout@v4
       with:
         fetch-depth: 0
     - name: Display Workflow Run Information
       run: |
-        echo "Workflow Run ID: ${{ github.run_id }}"
-    - name: Cache Python ${{ env.PYTHON_VERSION }}
-      uses: actions/cache@v4
-      with:
-        path: ~/.cache/pip
-        key: python-${{ env.PYTHON_VERSION }}
+        echo "Workflow Run ID: ${{github.run_id}}"
     - name: Install dependencies
-      run: |
-        sudo apt-get update
-        python -m pip install --upgrade pip
-        pip install asv==0.6.1 virtualenv tabulate lf-asv-formatter
+      run: pip install "asv[virtualenv]==${{env.ASV_VERSION}}" lf-asv-formatter
     - name: Make artifacts directory
-      run: mkdir -p ${{ env.ARTIFACTS_DIR }}
+      run: mkdir -p ${{env.ARTIFACTS_DIR}}
     - name: Save pull request number
-      run: echo ${{ github.event.pull_request.number }} > ${{ env.ARTIFACTS_DIR }}/pr
+      run: echo ${{github.event.pull_request.number}} > ${{env.ARTIFACTS_DIR}}/pr
     - name: Get current job logs URL
       uses: Tiryoh/gha-jobid-action@v1
       id: jobs
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        job_name: ${{ github.job }}
+        github_token: ${{secrets.GITHUB_TOKEN}}
+        job_name: ${{github.job}}
     - name: Create ASV machine config file
       run: asv machine --machine gh-runner --yes
     - name: Save comparison of PR against main branch
       run: |
-        git remote add upstream https://github.com/${{ github.repository }}.git
+        git remote add upstream https://github.com/${{github.repository}}.git
         git fetch upstream
         asv continuous upstream/main HEAD --verbose || true
         asv compare upstream/main HEAD --sort ratio --verbose | tee output
-        python -m lf_asv_formatter --asv_version "$(echo asv --version)"
+        python -m lf_asv_formatter --asv_version "$(asv --version | awk '{print $2}')"
         printf "\n\nClick [here]($STEP_URL) to view all benchmarks." >> output
-        mv output ${{ env.ARTIFACTS_DIR }}
+        mv output ${{env.ARTIFACTS_DIR}}
       env:
-        STEP_URL: "${{ steps.jobs.outputs.html_url }}#step:11:1"
+        STEP_URL: ${{steps.jobs.outputs.html_url}}#step:10:1
     - name: Upload artifacts (PR number and benchmarks output)
       uses: actions/upload-artifact@v4
       with:
         name: benchmark-artifacts
-        path: ${{ env.ARTIFACTS_DIR }}
+        path: ${{env.ARTIFACTS_DIR}}

.initialize_new_project.sh

@@ -44,6 +44,7 @@ python -m pip install -e . > /dev/null
 
 echo "Installing developer dependencies in local environment"
 python -m pip install -e .'[dev]' > /dev/null
+if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi
 
 echo "Installing pre-commit"
 pre-commit install > /dev/null

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
     # This hook should always pass. It will print a message if the local version 
     # is out of date.
   - repo: https://github.com/lincc-frameworks/pre-commit-hooks
-    rev: v0.1.1
+    rev: v0.1.2
     hooks:
       - id: check-lincc-frameworks-template-version
         name: Check template version

.setup_dev.sh

@@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null
 
 echo "Installing developer dependencies in local environment"
 python -m pip install -e .'[dev]' > /dev/null
+if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi
 
 echo "Installing pre-commit"
 pre-commit install > /dev/null

docs/requirements.txt

@@ -1,8 +1,10 @@
+
+ipykernel
+ipython
+jupytext
+nbconvert
+nbsphinx
 sphinx
-sphinx-rtd-theme
 sphinx-autoapi
 sphinx-copybutton
-nbsphinx
-ipython
-jupytext
-jupyter
+sphinx-rtd-theme