Merge branch 'cookiecutter' into new_scattering_freefield

.circleci/config.yml

@@ -66,32 +66,34 @@ jobs:
           pip-dependency-file: requirements_dev.txt
       - run:
           name: Flake8
-          command: flake8 imkar
-
-#   test_examples:
-#     parameters:
-#       version:
-#         description: "version tag"
-#         default: "latest"
-#         type: string
-#     executor:
-#       name: python-docker
-#       version: <<parameters.version>>
-
-#     steps:
-#       - checkout
-#     #   - run:
-#     #       name: Install System Dependencies
-#     #       command: sudo apt-get update && sudo apt-get install -y libsndfile1
-#       - python/install-packages:
-#           pkg-manager: pip
-#           # app-dir: ~/project/package-directory/  # If you're requirements.txt isn't in the root directory.
-#           pip-dependency-file: requirements_dev.txt
-#       - run:
-#           name: Examples
-#           command: |
-#             pip install -e .
-#             pytest --nbmake examples/*.ipynb
+          command: flake8 imkar tests
+
+
+  test_documentation_build:
+    parameters:
+      version:
+        description: "version tag"
+        default: "latest"
+        type: string
+    executor:
+      name: python-docker
+      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
+      - python/install-packages:
+          pkg-manager: pip
+          # app-dir: ~/project/package-directory/  # If you're requirements.txt isn't in the root directory.
+          pip-dependency-file: requirements_dev.txt
+      - run:
+          name: Sphinx
+          command: |
+            pip install -e .
+            cd docs/
+            make html SPHINXOPTS="-W"
 
   test_pypi_publish:
     parameters:
@@ -128,9 +130,12 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.8"
-                - "3.9"
-                - "3.10"
+              - "3.8"
+              - "3.9"
+              - "3.10"
+              - "3.11"
+              - "3.12"
+
       - flake:
           matrix:
             parameters:
@@ -139,13 +144,14 @@ workflows:
           requires:
             - build_and_test
 
-    #   - test_examples:
-    #       matrix:
-    #         parameters:
-    #           version:
-    #             - "3.9"
-    #       requires:
-    #         - build_and_test
+
+      - test_documentation_build:
+          matrix:
+            parameters:
+              version:
+                - "3.9"
+          requires:
+            - build_and_test
 
 
 test_and_publish:
@@ -156,9 +162,12 @@ test_and_publish:
           matrix:
             parameters:
               version:
-                - "3.8"
-                - "3.9"
-                - "3.10"
+              - "3.8"
+              - "3.9"
+              - "3.10"
+              - "3.11"
+              - "3.12"
+
           filters:
             branches:
               ignore: /.*/
@@ -180,19 +189,19 @@ test_and_publish:
             tags:
               only: /^v[0-9]+(\.[0-9]+)*$/
 
-    #   - test_examples:
-    #       matrix:
-    #         parameters:
-    #           version:
-    #             - "3.9"
-    #       requires:
-    #         - build_and_test
-    #       filters:
-    #         branches:
-    #           ignore: /.*/
-    #         # only act on version tags
-    #         tags:
-    #           only: /^v[0-9]+(\.[0-9]+)*$/
+      - test_documentation_build:
+          matrix:
+            parameters:
+              version:
+                - "3.9"
+          requires:
+            - build_and_test
+          filters:
+            branches:
+              ignore: /.*/
+            # only act on version tags
+            tags:
+              only: /^v[0-9]+(\.[0-9]+)*$/
 
       - test_pypi_publish:
           matrix:
@@ -202,7 +211,7 @@ test_and_publish:
           requires:
             - build_and_test
             - flake
-            # - test_examples
+            - test_documentation_build
           filters:
             branches:
               ignore: /.*/

.editorconfig

@@ -10,6 +10,9 @@ insert_final_newline = true
 charset = utf-8
 end_of_line = lf
 
+[*.yml]
+indent_size = 2
+
 [*.bat]
 indent_style = tab
 end_of_line = crlf

.github/ISSUE_TEMPLATE.md

@@ -1,27 +1,18 @@
+## General
+
 * imkar version:
 * Python version:
 * Operating System:
+* Did you install pyfar via pip:
 
-### Description
+## Description
 
 Describe what you were trying to get done.
 Tell us what happened, what went wrong, and what you expected to happen.
 
-### What I Did
+## What I Did
 
 ```
 Paste the command(s) you ran and the output.
 If there was a crash, please include the traceback here.
 ```
-
-## Labels
-
-Label your issue to make it easier for us to assign and track:
-
-Use one of these labels:
-- **hot:** For bugs on the master branch
-- **bug:** For bugs not on the master branch
-- **enhancement:** For suggesting enhancements of current functionality
-- **feature:** For requesting new features
-- **documentation:** Everything related to docstrings and comments
-- **question:** General questions, e.g., regarding the general structure or future directions

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,14 +7,3 @@ Closes #
 -
 -
 -
-
-### Labels
-
-Label your issue to make it easier for us to assign and track:
-
-Use one of these labels:
-- **hot:** For bugs on the master branch
-- **bug:** For bugs not on the master branch
-- **enhancement:** For suggesting enhancements of current functionality
-- **feature:** For requesting new features
-- **documentation:** Everything related to docstrings and comments

.gitignore

@@ -8,7 +8,6 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-env/
 build/
 develop-eggs/
 dist/
@@ -24,6 +23,7 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+MANIFEST
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -37,7 +37,6 @@ pip-delete-this-directory.txt
 
 # Unit test / coverage reports
 htmlcov/
-.tox/
 .coverage
 .coverage.*
 .cache
@@ -54,6 +53,7 @@ coverage.xml
 # Django stuff:
 *.log
 local_settings.py
+db.sqlite3
 
 # Flask stuff:
 instance/
@@ -64,12 +64,14 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/_autosummary
 
 # PyBuilder
 target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
+*/.ipynb_checkpoints/*
 
 # pyenv
 .python-version
@@ -80,13 +82,14 @@ celerybeat-schedule
 # SageMath parsed files
 *.sage.py
 
-# dotenv
+# Environments
 .env
-
-# virtualenv
 .venv
+env/
 venv/
 ENV/
+env.bak/
+venv.bak/
 
 # Spyder project settings
 .spyderproject
@@ -101,6 +104,13 @@ ENV/
 # mypy
 .mypy_cache/
 
-# IDE settings
+# vs code
 .vscode/
 .idea/
+
+# macOS
+.DS_Store
+
+# workaround for failing test discovery in vscode
+tests/*/__init__.py
+tests/private/

.readthedocs.yml

@@ -9,8 +9,8 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.10"
-  apt_packages:
-    - libsndfile1
+  # apt_packages:
+  #   - libsndfile1
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx: