Merge pull request #100 from zmoon/pre-commit

pre-commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,14 +1,14 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-
 ---
 
 **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 '....'
@@ -21,15 +21,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -1,7 +1,4 @@
 ---
 name: Custom issue template
 about: Describe this issue template's purpose here.
-
 ---
-
-

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,7 +1,6 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/dependabot.yaml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # .github/workflows
+    schedule:
+      interval: "monthly"

.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+name: Lint
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+  workflow_dispatch:
+
+jobs:
+  lint:
+    name: pre-commit
+    runs-on: ubuntu-latest
+    if: github.repository == 'noaa-oar-arl/monet'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.8"
+      - uses: pre-commit/action@v2.0.3

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.1.0"
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-docstring-first
+      - id: check-yaml
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: "v2.31.0"
+    hooks:
+      - id: pyupgrade
+        args: [--py36-plus]
+
+  - repo: https://github.com/PyCQA/isort
+    rev: "5.10.1"
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/psf/black
+    rev: "21.12b0"
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: "4.0.1"
+    hooks:
+      - id: flake8
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v2.5.1"
+    hooks:
+      - id: prettier

.readthedocs.yaml

@@ -1,11 +1,8 @@
-
 version: 2
 
-
 build:
   image: latest
 
-
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
@@ -19,7 +16,7 @@ formats:
 # Optionally set the version of Python and requirements required to build your docs
 python:
   version: 3.6
-#  setup_py_install: false
+  # setup_py_install: false
 
   install:
     - requirements: docs/requirements.txt

LICENSE

@@ -1,31 +1,31 @@
-PLEASE READ THIS SOFTWARE LICENSE ("LICENSE") CAREFULLY BEFORE USING THE 
-SOFTWARE. BY USING THE SOFTWARE, YOU ARE AGREEING TO BE BOUND BY ALL OF THE 
-TERMS OF THIS LICENSE. IF YOU DO NOT AGREE TO THE TERMS OF THIS LICENSE, 
+PLEASE READ THIS SOFTWARE LICENSE ("LICENSE") CAREFULLY BEFORE USING THE
+SOFTWARE. BY USING THE SOFTWARE, YOU ARE AGREEING TO BE BOUND BY ALL OF THE
+TERMS OF THIS LICENSE. IF YOU DO NOT AGREE TO THE TERMS OF THIS LICENSE,
 DO NOT USE THE SOFTWARE.
 
-Copyright © 2016 the National Oceanic and Atmospheric Administration Office of 
-Atmospheric Research Air Resources Laboratory ("NOAA OAR ARL"). 
+Copyright © 2016 the National Oceanic and Atmospheric Administration Office of
+Atmospheric Research Air Resources Laboratory ("NOAA OAR ARL").
 All rights reserved. Developed by NOAA ARL https://www.arl.noaa.gov.
 
-Redistribution and use of the Software in source and binary forms, with or 
-without modification, is permitted provided that the following conditions 
+Redistribution and use of the Software in source and binary forms, with or
+without modification, is permitted provided that the following conditions
 are met:
 
-- Neither the names of NOAA's Air Resources Laboratory nor the names of its 
-  sponsors or contributors may be used to endorse or promote products derived 
+- Neither the names of NOAA's Air Resources Laboratory nor the names of its
+  sponsors or contributors may be used to endorse or promote products derived
   from this Software without specific prior written permission.
 
-- Redistributions of source code must retain the above copyright notices, this 
+- Redistributions of source code must retain the above copyright notices, this
   list of conditions, and the disclaimer below.
 
-- Redistributions in binary form must reproduce the above copyright notice, this 
-  list of conditions, and the disclaimer below in the documentation and/or other 
+- Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions, and the disclaimer below in the documentation and/or other
   materials provided with the distribution.
 
-THIS 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 
-CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, INDIRECT, 
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES OR OTHER LIABILITY, 
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 
+THIS 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
+CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 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 WITH THE SOFTWARE.

README.md

@@ -1,4 +1,3 @@
-
 ## Introduction to the Model and ObservatioN Evaluation Toolkit (MONET)
 
 Please read the docs at [ReadTheDocs](https://monet-arl.readthedocs.io)
@@ -8,8 +7,9 @@ This is the start to an MONET verification package. Currently, it handles CMAQ 4
 Please refer to the [publication](http://www.mdpi.com/2073-4433/8/11/210) and the [ReadTheDocs](https://monet-arl.readthedocs.io/en/develop/) for more detail.
 
 ### Note for data I/O
-Note that as of version 2.1.5 MONET has been split into two repositories, MONET and MONETIO. This was done to simplify the build process for each repository and allow each to develop independently.  
+
+Note that as of version 2.1.5 MONET has been split into two repositories, MONET and MONETIO. This was done to simplify the build process for each repository and allow each to develop independently.
 
 #### Reference
 
-Baker, Barry; Pan, Li.	2017. "Overview of the Model and Observation Evaluation Toolkit (MONET) Version 1.0 for Evaluating Atmospheric Transport Models." Atmosphere 8, no. 11: 210.
+Baker, Barry; Pan, Li. 2017. "Overview of the Model and Observation Evaluation Toolkit (MONET) Version 1.0 for Evaluating Atmospheric Transport Models." Atmosphere 8, no. 11: 210.

docs/Makefile

@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/style.css

@@ -1,22 +1,23 @@
 @import url("theme.css");
 
-.wy-side-nav-search>a img.logo,
-.wy-side-nav-search .wy-dropdown>a img.logo {
-  width: 12rem
+.wy-side-nav-search > a img.logo,
+.wy-side-nav-search .wy-dropdown > a img.logo {
+  width: 12rem;
 }
 
 .wy-side-nav-search {
   background-color: #eee;
 }
 
-.wy-side-nav-search>div.version {
+.wy-side-nav-search > div.version {
   display: none;
 }
 
 .wy-nav-top {
   background-color: #eee;
 }
 
-nav.wy-nav-top > a, i.fa-bars {
-  color: #404040;  /* this is the body text color */
+nav.wy-nav-top > a,
+i.fa-bars {
+  color: #404040; /* this is the body text color */
 }

docs/_templates/layout.html

@@ -1,2 +1,2 @@
-{% extends "!layout.html" %}
-{% set css_files = css_files + ["_static/style.css"] %}
+{% extends "!layout.html" %} {% set css_files = css_files +
+["_static/style.css"] %}