Migrate to copier

.circleci/config.yml

@@ -36,15 +36,13 @@ jobs:
       version: <<parameters.version>>
     steps:
       - checkout
-      - run:
-          name: Install System Dependencies
-          command: sudo apt-get update && sudo apt-get install -y libsndfile1
+
       - run:
           name: install dependencies
           command: pip install ".[tests]"
       - run:
           name: Run tests
-          command: pytest
+          command: pytest tests
 
   ruff:
     parameters:
@@ -75,9 +73,7 @@ jobs:
       version: <<parameters.version>>
     steps:
       - checkout
-   #    - run:
-   #        name: Install System Dependencies
-   #        command: sudo apt-get update && sudo apt-get install -y libsndfile1 texlive-latex-extra dvipng
+
       - run:
           name: Sphinx
           command: |
@@ -96,7 +92,7 @@ jobs:
       version: <<parameters.version>>
     steps:
       - checkout
-
+      
       - run:
           name: install dependencies
           command: pip install ".[tests]"
@@ -106,7 +102,7 @@ jobs:
           name: Run tests
           command: pytest tests -W error::DeprecationWarning
 
-  test_pypi_publish:
+  test_package_build:
     parameters:
       version:
         description: "version tag"
@@ -117,9 +113,7 @@ jobs:
       version: <<parameters.version>>
     steps:
       - checkout
-    #  - run:
-    #      name: Install System Dependencies
-    #      command: sudo apt-get update && sudo apt-get install -y libsndfile1
+
       - run:
           name: install dependencies
           command: pip install ".[deploy]"
@@ -140,9 +134,7 @@ jobs:
       version: <<parameters.version>>
     steps:
       - checkout
-      - run:
-          name: Install System Dependencies
-          command: sudo apt-get update && sudo apt-get install -y libsndfile1
+
       - run:
           name: install dependencies
           command: pip install ".[deploy]"
@@ -153,6 +145,7 @@ jobs:
             twine check dist/*
             twine upload dist/*
 
+
 # Invoke jobs via workflows
 # See: https://circleci.com/docs/2.0/configuration-reference/#workflows
 workflows:
@@ -167,38 +160,44 @@ workflows:
                 - "3.12"
                 - "3.13"
                 - "3.14"
-
+                
       - ruff:
           matrix:
             parameters:
               version:
-                - "3.13"
+                - "3.14"
           requires:
             - build_and_test
 
       - test_documentation_build:
           matrix:
             parameters:
               version:
-                - "3.13"
+                - "3.14"
           requires:
             - build_and_test
 
       - test_deprecation_warnings:
           matrix:
             parameters:
               version:
-                - "3.13"
+                - "3.14"
           requires:
             - build_and_test
 
-      - test_pypi_publish:
+      - test_package_build:
           matrix:
             parameters:
               version:
-                - "3.13"
+                - "3.14"
           requires:
             - build_and_test
+          filters:
+            branches:
+              only:
+                - main
+                - develop
+
 
   test_and_publish:
     # Test and publish on new git version tags
@@ -212,7 +211,7 @@ workflows:
                 - "3.12"
                 - "3.13"
                 - "3.14"
-
+                
           filters:
             branches:
               ignore: /.*/
@@ -278,3 +277,4 @@ workflows:
             # only act on version tags
             tags:
               only: /^v[0-9]+(\.[0-9]+)*$/
+

.copier-answers.yml

@@ -0,0 +1,35 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: ea3148d
+_src_path: https://github.com/pyfar/template-pyfar-package
+apt_packages: ''
+author: The pyfar developers
+copyright_statement: 2021-2023, Marco Berzborn; 2023, The pyfar developers
+dependencies: pyfar>=0.8.0,numpy>=1.14.0,scipy>=1.5.0,matplotlib
+docs_custom_import: ''
+git_username: pyfar
+gitignore_custom: ''
+intersphinx_mapping:
+- numpy
+- scipy
+- matplotlib
+- pyfar
+keywords: acoustics,pyfar
+license: MIT
+logo_path_gallery: resources/logos/pyfar_logos_fixed_size_pyrato.png
+manifest_custom: ''
+minimum_python_version: '3.11'
+project_getting_started: 'The pyfar workshop(https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
+    gives an overview of the most important pyfar functionality and is a good starting
+    point. It is part of the pyfar example gallery(https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html)
+    that also contains more specific and in-depth examples that can be executed interactively
+    without a local installation by clicking the mybinder.org button on the respective
+    example. The pyrato documentation(https://pyrato.readthedocs.io) gives a detailed
+    and complete overview of pyrato. All these information are available from pyfar.org(https://pyfar.org).
+
+    '
+project_long_description: ''
+project_short_description: Collection of functions commonly used in room acoustics.
+project_slug: pyrato
+ruff_ignore: .git,docs,examples/,tests/test_data
+use_pypi_deployment_with_ci: true
+version: 1.0.0

.editorconfig

@@ -21,4 +21,4 @@ end_of_line = crlf
 insert_final_newline = false
 
 [Makefile]
-indent_style = tab
+indent_style = tab

.github/workflows/add_to_project.yml

@@ -0,0 +1,19 @@
+name : add_to_project
+
+on :
+  pull_request:
+    types:
+      - opened
+  issues:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add issue or pull request to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v1
+        with:
+          project-url: https://github.com/orgs/pyfar/projects/3
+          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}

.github/workflows/check_modified_history.yml

@@ -0,0 +1,26 @@
+name : modified_history_check
+
+on :
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  check-history:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Check if HISTORY.rst was modified or created
+        run: |
+          git diff origin/${{ github.base_ref }} HEAD \
+            --diff-filter=AMR \
+            --name-only \
+            -- HISTORY.rst | grep -q . || {
+              echo "ERROR: HISTORY.rst was not modified"
+              exit 1
+            }
+

.github/workflows/has_version_milestone.yml

@@ -4,8 +4,8 @@ on:
   pull_request:
     types:
       - opened
-      - labeled
-      - unlabeled
+      - milestoned
+      - demilestoned
       - synchronize
 
 jobs:

.gitignore

@@ -120,4 +120,9 @@ docs/header.rst
 docs/_static/favicon.ico
 docs/_static/header.rst
 docs/_static/css/custom.css
+docs/_static/js/custom.js
+docs/resources/logos/pyfar_logos_fixed_size_pyfar.png
 docs/resources/logos/pyfar_logos_fixed_size_pyrato.png
+
+# custom
+

.readthedocs.yml

@@ -1,27 +1,29 @@
 # .readthedocs.yml
-# Read the Docs configuration file
+# Read the Docs configuration file for Sphinx projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
 version: 2
 
+# Set the OS, Python version and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.14"
-  apt_packages:
-   - libsndfile1
+    python: 3.14
 
-# Build documentation in the docs/ directory with Sphinx
+
+# Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: docs/conf.py
 
-# Optionally build your docs in additional formats such as PDF
+# Optionally build your docs in additional formats such as PDF and ePub
 formats:
   - pdf
 
-# Optionally set the version of Python and requirements required to build your docs
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
     - method: pip
-      path: ".[docs]"
+      path: ".[docs]"

CONTRIBUTING.rst

@@ -1,3 +1,4 @@
+
 .. highlight:: shell
 
 ============
@@ -21,7 +22,7 @@ The best place for this is https://github.com/pyfar/pyrato/issues.
 Fix Bugs or Implement Features
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Look through https://github.com/pyfar/pyrato/issues for bugs or feature request
+Look through https://github.com/pyfar/pyrato/issues for bugs or feature requests
 and contact us or comment if you are interested in implementing.
 
 Write Documentation
@@ -34,7 +35,9 @@ articles, and such.
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `pyrato` for local development using the command-line interface. Note that several alternative user interfaces exist, e.g., the Git GUI, `GitHub Desktop <https://desktop.github.com/>`_, extensions in `Visual Studio Code <https://code.visualstudio.com/>`_ ...
+Ready to contribute? Here's how to set up `pyrato` for local development using the command-line interface.
+Note that several alternative user interfaces exist, e.g., the Git GUI, `GitHub Desktop <https://desktop.github.com/>`_,
+extensions in `Visual Studio Code <https://code.visualstudio.com/>`_ ...
 
 1. `Fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo/>`_ the `pyrato` repo on GitHub.
 2. Clone your fork locally and cd into the pyrato directory::
@@ -60,7 +63,8 @@ Ready to contribute? Here's how to set up `pyrato` for local development using t
     $ ruff check
     $ pytest
 
-   ruff must pass without any warnings for `./pyrato` and `./tests` using the default or a stricter configuration. Ruff ignores a couple of PEP Errors (see `./pyproject.toml`). If necessary, adjust your linting configuration in your IDE accordingly.
+   ruff must pass without any warnings for `./pyrato` and `./tests` using the default or a stricter
+   configuration. Ruff ignores a couple of PEP Errors (see `./pyproject.toml`). If necessary, adjust your linting configuration in your IDE accordingly.
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -71,4 +75,4 @@ Ready to contribute? Here's how to set up `pyrato` for local development using t
 7. Submit a pull request on the develop branch through the GitHub website.
 
 
-.. _general contributing guidelines: https://pyfar-gallery.readthedocs.io/en/latest/contribute/index.html
+.. _general contributing guidelines: https://pyfar-gallery.readthedocs.io/en/latest/contribute/index.html

LICENSE

@@ -1,23 +1,21 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2021-2023, Marco Berzborn - Institute of Technical Acoustics
-Copyright (c) 2023, The pyfar developers
+Copyright (c) 2021-2023, Marco Berzborn; 2023, The pyfar developers
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.