bootstrap template

.bumpversion.cfg

@@ -0,0 +1,8 @@
+[bumpversion]
+current_version = 0.0.1
+tag = True
+commit = False
+
+[bumpversion:file:./pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"

.codecov.yaml

@@ -0,0 +1,17 @@
+# Based on pydata/xarray
+codecov:
+    require_ci_to_pass: no
+
+coverage:
+    status:
+        project:
+            default:
+                # Require 1% coverage, i.e., always succeed
+                target: 1
+        patch: false
+        changes: false
+
+comment:
+    layout: diff, flags, files
+    behavior: once
+    require_base: no

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab

.flake8

@@ -0,0 +1,44 @@
+# Can't yet be moved to the pyproject.toml due to https://github.com/PyCQA/flake8/issues/234
+[flake8]
+max-line-length = 120
+ignore =
+    # line break before a binary operator -> black does not adhere to PEP8
+    W503
+    # line break occured after a binary operator -> black does not adhere to PEP8
+    W504
+    # line too long -> we accept long comment lines; black gets rid of long code lines
+    E501
+    # whitespace before : -> black does not adhere to PEP8
+    E203
+    # missing whitespace after ,', ';', or ':' -> black does not adhere to PEP8
+    E231
+    # continuation line over-indented for hanging indent -> black does not adhere to PEP8
+    E126
+    # E266 too many leading '#' for block comment -> this is fine for indicating sections
+    E262
+    # Do not assign a lambda expression, use a def -> lambda expression assignments are convenient
+    E731
+    # allow I, O, l as variable names -> I is the identity matrix, i, j, k, l is reasonable indexing notation
+    E741
+    # Missing docstring in public package
+    D104
+    # ... imported but unused
+    F401
+    # Missing docstring in public module
+    D100
+    # Missing docstring in __init__
+    D107
+    # Do not perform function calls in argument defaults.
+    B008
+    # line break before binary operator
+    W503
+    # Missing docstring in magic method
+    D105
+    # whitespace before ':'
+    E203
+    # format string does contain unindexed parameters
+    P101
+exclude = .git,__pycache__,build,docs/_build,dist
+per-file-ignores =
+    tests/*: D
+    */__init__.py: F401

.github/workflows/build.yaml

@@ -0,0 +1,23 @@
+name: Check Build
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    package:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - name: Set up Python 3.10
+              uses: actions/setup-python@v2
+              with:
+                  python-version: "3.10"
+            - name: Install build dependencies
+              run: python -m pip install --upgrade pip wheel twine build
+            - name: Build package
+              run: python -m build
+            - name: Check package
+              run: twine check --strict dist/*.whl

.github/workflows/pre-commit.yaml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+    pull_request:
+    push:
+        branches: [main]
+
+jobs:
+    pre-commit:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-python@v2
+            - uses: pre-commit/[email protected]

.github/workflows/test.yaml

@@ -0,0 +1,62 @@
+name: Test
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    test:
+        runs-on: ${{ matrix.os }}
+        defaults:
+            run:
+                shell: bash -e {0} # -e to fail on error
+
+        strategy:
+            fail-fast: false
+            matrix:
+                python: ["3.8", "3.10"]
+                os: [ubuntu-latest]
+
+        env:
+            OS: ${{ matrix.os }}
+            PYTHON: ${{ matrix.python }}
+
+        steps:
+            - uses: actions/checkout@v2
+            - name: Set up Python ${{ matrix.python }}
+              uses: actions/setup-python@v2
+              with:
+                  python-version: ${{ matrix.python }}
+
+            - name: Get pip cache dir
+              id: pip-cache-dir
+              run: |
+                  echo "::set-output name=dir::$(pip cache dir)"
+            - name: Restore pip cache
+              uses: actions/cache@v2
+              with:
+                  path: ${{ steps.pip-cache-dir.outputs.dir }}
+                  key: pip-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml') }}
+                  restore-keys: |
+                      pip-${{ runner.os }}-${{ env.pythonLocation }}-
+            - name: Install test dependencies
+              run: |
+                  python -m pip install --upgrade pip wheel
+                  pip install codecov
+            - name: Install dependencies
+              run: |
+                  pip install ".[dev,test]"
+            - name: Test
+              env:
+                  MPLBACKEND: agg
+                  PLATFORM: ${{ matrix.os }}
+                  DISPLAY: :42
+              run: |
+                  pytest -v --cov --color=yes
+            - name: Upload coverage
+              env:
+                  CODECOV_NAME: ${{ matrix.python }}-${{ matrix.os }}
+              run: |
+                  codecov --required --flags=unittests

.gitignore

@@ -0,0 +1,24 @@
+# Temp files
+.DS_Store
+*~
+
+# Compiled files
+__pycache__/
+
+# Distribution / packaging
+/build/
+/dist/
+/*.egg-info/
+
+# Tests and coverage
+/.pytest_cache/
+/.cache/
+/data/
+
+# docs
+/docs/generated/
+/docs/_build/
+
+# IDEs
+/.idea/
+/.vscode/

.pre-commit-config.yaml

@@ -0,0 +1,75 @@
+fail_fast: false
+default_language_version:
+    python: python3
+default_stages:
+    - commit
+    - push
+minimum_pre_commit_version: 2.16.0
+repos:
+    - repo: https://github.com/psf/black
+      rev: 22.6.0
+      hooks:
+          - id: black
+    - repo: https://github.com/pre-commit/mirrors-prettier
+      rev: v2.7.1
+      hooks:
+          - id: prettier
+    - repo: https://github.com/asottile/blacken-docs
+      rev: v1.12.1
+      hooks:
+          - id: blacken-docs
+    - repo: https://github.com/pre-commit/mirrors-autopep8
+      rev: v1.6.0
+      hooks:
+          - id: autopep8
+            args: [-i]
+    - repo: https://github.com/PyCQA/isort
+      rev: 5.10.1
+      hooks:
+          - id: isort
+    - repo: https://github.com/asottile/yesqa
+      rev: v1.3.0
+      hooks:
+          - id: yesqa
+            additional_dependencies:
+                - flake8-tidy-imports
+                - flake8-docstrings
+                - flake8-rst-docstrings
+                - flake8-comprehensions
+                - flake8-bugbear
+                - flake8-blind-except
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.3.0
+      hooks:
+          - id: detect-private-key
+          - id: check-ast
+          - id: end-of-file-fixer
+          - id: mixed-line-ending
+            args: [--fix=lf]
+          - id: trailing-whitespace
+          - id: check-case-conflict
+    - repo: https://github.com/myint/autoflake
+      rev: v1.4
+      hooks:
+          - id: autoflake
+            args:
+                - --in-place
+                - --remove-all-unused-imports
+                - --remove-unused-variable
+                - --ignore-init-module-imports
+    - repo: https://github.com/PyCQA/flake8
+      rev: 4.0.1
+      hooks:
+          - id: flake8
+            additional_dependencies:
+                - flake8-tidy-imports
+                - flake8-docstrings
+                - flake8-rst-docstrings
+                - flake8-comprehensions
+                - flake8-bugbear
+                - flake8-blind-except
+    - repo: https://github.com/asottile/pyupgrade
+      rev: v2.34.0
+      hooks:
+          - id: pyupgrade
+            args: [--py3-plus, --py38-plus, --keep-runtime-typing]

.readthedocs.yaml

@@ -0,0 +1,15 @@
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+version: 2
+build:
+    os: ubuntu-20.04
+    tools:
+        python: "3.10"
+sphinx:
+    configuration: docs/conf.py
+    fail_on_warning: true
+python:
+    install:
+        - method: pip
+          path: .
+          extra_requirements:
+              - doc

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog][],
+and this project adheres to [Semantic Versioning][].
+
+[keep a changelog]: https://keepachangelog.com/en/1.0.0/
+[semantic versioning]: https://semver.org/spec/v2.0.0.html
+
+## [Unreleased]
+
+### Added
+
+-   Basic tool, preprocessing and plotting functions

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, Gregor Sturm
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.