Executables

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,41 +1,41 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: "[BUG]"
-labels: bug
-assignees: ''
-
----
-
-Describe the bug
-================
-A clear and concise description of what the bug is.
-
-To Reproduce
-============
-
-Steps to reproduce the behavior
--------------------------------
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-System information
-------------------
-Please complete the following information:
- - OS: [Hal]
- - Python version: [1.0]
- - Other details about your setup that could be relevant: [aetherpy branch]
-
-Screenshots
------------
-If applicable, add screenshots to help explain your problem.
-
-Expected behavior
-=================
-A clear and concise description of what you expected to happen.
-
-Additional context
-==================
-Add any other context about the problem here.
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+Describe the bug
+================
+A clear and concise description of what the bug is.
+
+To Reproduce
+============
+
+Steps to reproduce the behavior
+-------------------------------
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+System information
+------------------
+Please complete the following information:
+ - OS: [Hal]
+ - Python version: [1.0]
+ - Other details about your setup that could be relevant: [aetherpy branch]
+
+Screenshots
+-----------
+If applicable, add screenshots to help explain your problem.
+
+Expected behavior
+=================
+A clear and concise description of what you expected to happen.
+
+Additional context
+==================
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,26 +1,26 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: "[FEAT]"
-labels: enhancement
-assignees: ''
-
----
-
-Is your feature request related to a problem? Please describe.
-==============================================================
-A clear and concise description of what the problem is. For example:
-I'm always frustrated when [...]
-
-Describe the solution you'd like
-================================
-A clear and concise description of what you want to happen.
-
-Describe alternatives you've considered
-=======================================
-A clear and concise description of any alternative solutions or features
-you've considered.
-
-Additional context
-==================
-Add any other context or screenshots about the feature request here.
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEAT]"
+labels: enhancement
+assignees: ''
+
+---
+
+Is your feature request related to a problem? Please describe.
+==============================================================
+A clear and concise description of what the problem is. For example:
+I'm always frustrated when [...]
+
+Describe the solution you'd like
+================================
+A clear and concise description of what you want to happen.
+
+Describe alternatives you've considered
+=======================================
+A clear and concise description of any alternative solutions or features
+you've considered.
+
+Additional context
+==================
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/project-goal.md

@@ -1,22 +1,22 @@
----
-name: Project Goal
-about: A general project goal that is not a feature or a bug
-title: "[GOAL]"
-labels: ''
-assignees: ''
-
----
-
-Describe the goal
-==================
-Description of the goal, including it's aim and context.
-
-Provide a general outline
-=========================
-1. First step
-2. Second step
-3. Celebrate
-
-Benefits and downsides
-======================
-What are the benefits and downsides of this goal?
+---
+name: Project Goal
+about: A general project goal that is not a feature or a bug
+title: "[GOAL]"
+labels: ''
+assignees: ''
+
+---
+
+Describe the goal
+==================
+Description of the goal, including it's aim and context.
+
+Provide a general outline
+=========================
+1. First step
+2. Second step
+3. Celebrate
+
+Benefits and downsides
+======================
+What are the benefits and downsides of this goal?

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,43 +1,43 @@
-# Description
-
-Addresses # (issue)
-
-Please include a summary of the change and which issue is fixed. Please also
-include relevant motivation and context. List any dependencies that are required
-for this change.  Please see ``CONTRIBUTING.md`` for more guidelines.
-
-## Type of change
-
-Please delete options that are not relevant.
-
-- Bug fix (non-breaking change that fixes an issue)
-- New feature (non-breaking change that adds functionality)
-- Breaking change (fix or feature that would cause existing functionality
-  to not work as expected)
-- This change requires a documentation update
-
-
-# How Has This Been Tested?
-
-Please describe the tests that you ran to verify your changes. Provide
-instructions so we can reproduce.
-
-## Test configuration
-
-* Operating system: [e.g., Hal]
-* Compiler, version number: [e.g., Python 3.X, gcc version X.X]
-* Any details about your local setup that are relevant
-
-# Checklist:
-
-- [ ] Make sure you are merging into the `develop` (not `main`) branch
-- [ ] My code follows the style guidelines of this project
-- [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
-- [ ] My changes generate no new warnings
-- [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] New and existing unit tests pass locally with my changes
-- [ ] Any dependent changes have been merged and published in downstream modules
-- [ ] Add your name to the bottom of the creators list in the .zenodo.json file
-- [N/A] Add a note to `CHANGELOG.md`, summarizing the changes
+# Description
+
+Addresses # (issue)
+
+Please include a summary of the change and which issue is fixed. Please also
+include relevant motivation and context. List any dependencies that are required
+for this change.  Please see ``CONTRIBUTING.md`` for more guidelines.
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- Bug fix (non-breaking change that fixes an issue)
+- New feature (non-breaking change that adds functionality)
+- Breaking change (fix or feature that would cause existing functionality
+  to not work as expected)
+- This change requires a documentation update
+
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide
+instructions so we can reproduce.
+
+## Test configuration
+
+* Operating system: [e.g., Hal]
+* Compiler, version number: [e.g., Python 3.X, gcc version X.X]
+* Any details about your local setup that are relevant
+
+# Checklist:
+
+- [ ] Make sure you are merging into the `develop` (not `main`) branch
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] Add your name to the bottom of the creators list in the .zenodo.json file
+- [N/A] Add a note to `CHANGELOG.md`, summarizing the changes

.github/workflows/main.yml

@@ -1,62 +1,62 @@
-# This workflow will install Python dependencies, run tests and lint with a
-# variety of Python versions. For more information see:
-# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
-name: Pytest with Flake8
-
-on: [push, pull_request]
-
-jobs:
-  build:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.8", "3.9", "3.10"]
-        numpy_ver: ["latest"]
-        include:
-          - python-version: "3.7"
-            numpy_ver: "1.18"
-            os: ubuntu-latest
-
-    name: Python ${{ matrix.python-version }} on ${{ matrix.os }} with numpy ${{ matrix.numpy_ver }}
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up ffmpeg
-      uses: FedericoCarboni/setup-ffmpeg@v1
-      id: setup-ffmpeg
-      with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Install standard dependencies and aetherpy
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        python setup.py install
-
-    - name: Install requirements for testing setup
-      run: pip install -r test_requirements.txt
-
-    - name: Install NEP29 dependencies
-      if: ${{ matrix.numpy_ver != 'latest'}}
-      run: |
-        pip install --no-binary :numpy: numpy==${{ matrix.numpy_ver }}
-
-    - name: Test PEP8 compliance
-      run: flake8 . --count --select=D,E,F,H,W --show-source --statistics
-
-    - name: Evaluate complexity
-      run: flake8 . --count --exit-zero --max-complexity=10 --statistics
-
-    - name: Test with pytest
-      run: pytest --cov=aetherpy/
-
-    - name: Publish results to coveralls
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: coveralls --rcfile=setup.cfg --service=github
+# This workflow will install Python dependencies, run tests and lint with a
+# variety of Python versions. For more information see:
+# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Pytest with Flake8
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.8", "3.9", "3.10"]
+        numpy_ver: ["latest"]
+        include:
+          - python-version: "3.7"
+            numpy_ver: "1.18"
+            os: ubuntu-latest
+
+    name: Python ${{ matrix.python-version }} on ${{ matrix.os }} with numpy ${{ matrix.numpy_ver }}
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up ffmpeg
+      uses: FedericoCarboni/setup-ffmpeg@v1
+      id: setup-ffmpeg
+      with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install standard dependencies and aetherpy
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        python setup.py install
+
+    - name: Install requirements for testing setup
+      run: pip install -r test_requirements.txt
+
+    - name: Install NEP29 dependencies
+      if: ${{ matrix.numpy_ver != 'latest'}}
+      run: |
+        pip install --no-binary :numpy: numpy==${{ matrix.numpy_ver }}
+
+    - name: Test PEP8 compliance
+      run: flake8 . --count --select=D,E,F,H,W --show-source --statistics
+
+    - name: Evaluate complexity
+      run: flake8 . --count --exit-zero --max-complexity=10 --statistics
+
+    - name: Test with pytest
+      run: pytest --cov=aetherpy/
+
+    - name: Publish results to coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: coveralls --rcfile=setup.cfg --service=github