Pre commit with black (#424)

* Saved new PDF of paper * added an ran pre-commit * Saved new PDF of paper * install pre-commit format for toml file * added flake and toml checks to pre-commit * run flake8 * Saved new PDF of paper * formatted wit flake * Saved new PDF of paper --------- Co-authored-by: vergauwenthomas <[email protected]>
vergauwenthomas · Jan 25, 2024 · 1175284 · 1175284
1 parent fdadffd
commit 1175284
Show file tree

Hide file tree

Showing 377 changed files with 11,088 additions and 8,819 deletions.
diff --git a/.github/workflows/main_workflow.yml b/.github/workflows/main_workflow.yml
@@ -331,4 +331,3 @@ jobs:
              package_build
              documentation_requirements
              titan_requirements
-
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,31 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: check-yaml
+    -   id: check-toml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.12.0
+  hooks:
+  - id: pretty-format-toml
+    args: [--autofix]
+
+#- repo: https://github.com/pycqa/flake8
+#  rev: 6.1.0
+#  hooks:
+#  - id: flake8
+#    additional_dependencies: ['flake8-alphabetize', 'flake8-rst-docstrings']
+#    args: ['--config=setup.cfg']
+
+ci:
+  autofix_commit_msg: |
+    [pre-commit.ci] auto fixes from pre-commit.com hooks
+
+    for more information, see https://pre-commit.ci
+  autofix_prs: true
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -6,7 +6,7 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools: {python: "3.10"}
   jobs:
     pre_create_environment:
@@ -21,4 +21,4 @@ build:
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
-  fail_on_warning: true
+  fail_on_warning: true
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -92,7 +92,7 @@ Make sure you have this software installed before proceeding.
   git checkout name-of-your-bugfix-or-feature
   ```
  Now you can make local changes.
- 
+
 4. Test your changes locally. The [build_and_test.sh](https://github.com/vergauwenthomas/MetObs_toolkit/blob/master/deploiment/build_and_test.sh) script builds the package and runs a series of tests. All tests must be successful before your contributions can be merged in the dev branch.
 
   ```
@@ -126,4 +126,4 @@ After the code review, and all review marks are resolved, your contributions wil
 For general support or questions, you can refer them to @vergauwenthomas, or by mail to ([email protected]).
 
 ## Acknowledgement
-This file is inspired by the [RavenPy](https://github.com/CSHS-CWRA/RavenPy) project. Thank you for the inspiration!”. 
+This file is inspired by the [RavenPy](https://github.com/CSHS-CWRA/RavenPy) project. Thank you for the inspiration!”.
diff --git a/docs/MetObs_documentation.rst b/docs/MetObs_documentation.rst
@@ -14,4 +14,4 @@ the MetObs toolkit to be used by a user.
    metobs_toolkit.dataset
    metobs_toolkit.station
    metobs_toolkit.analysis
-   metobs_toolkit.modeldata
+   metobs_toolkit.modeldata
diff --git a/docs/_build/.doctrees/_autosummary/metobs_toolkit.doctree b/docs/_build/.doctrees/_autosummary/metobs_toolkit.doctree
diff --git a/...uild/.doctrees/_autosummary/metobs_toolkit.plotting_functions.correlation_scatter.doctree b/...uild/.doctrees/_autosummary/metobs_toolkit.plotting_functions.correlation_scatter.doctree
diff --git a/docs/_build/.doctrees/_autosummary/metobs_toolkit.plotting_functions.geospatial_plot.doctree b/docs/_build/.doctrees/_autosummary/metobs_toolkit.plotting_functions.geospatial_plot.doctree
diff --git a/docs/_build/.doctrees/_autosummary/metobs_toolkit.plotting_functions.timeseries_plot.doctree b/docs/_build/.doctrees/_autosummary/metobs_toolkit.plotting_functions.timeseries_plot.doctree
diff --git a/docs/_build/.doctrees/environment.pickle b/docs/_build/.doctrees/environment.pickle
diff --git a/docs/_build/.doctrees/index.doctree b/docs/_build/.doctrees/index.doctree
diff --git a/docs/_build/MetObs_documentation.html b/docs/_build/MetObs_documentation.html
@@ -11,7 +11,7 @@
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
         <script src="_static/documentation_options.js?v=d45e8c67"></script>
@@ -24,19 +24,19 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="metobs_toolkit.dataset_settings_updater" href="_autosummary/metobs_toolkit.dataset_settings_updater.html" />
-    <link rel="prev" title="JOSS publication figures creator" href="paper/paper_figures.html" /> 
+    <link rel="prev" title="JOSS publication figures creator" href="paper/paper_figures.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-          
-          
+
+
           <a href="index.html">
-            
+
               <img src="_static/logo_small.svg" class="logo" alt="Logo"/>
           </a>
 <div role="search">
@@ -94,7 +94,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <section id="metobs-toolkit-documentation-for-users">
 <h1>MetObs toolkit Documentation for Users<a class="headerlink" href="#metobs-toolkit-documentation-for-users" title="Link to this heading"></a></h1>
 <p>Here you can find the documentation on the classes, functions, and methods in
@@ -137,7 +137,7 @@ <h1>MetObs toolkit Documentation for Users<a class="headerlink" href="#metobs-to
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
+
 
 </footer>
         </div>
@@ -148,7 +148,7 @@ <h1>MetObs toolkit Documentation for Users<a class="headerlink" href="#metobs-to
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>
diff --git a/docs/_build/MetObs_documentation_full.html b/docs/_build/MetObs_documentation_full.html
@@ -11,7 +11,7 @@
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
         <script src="_static/documentation_options.js?v=d45e8c67"></script>
@@ -24,19 +24,19 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="metobs_toolkit" href="_autosummary/metobs_toolkit.html" />
-    <link rel="prev" title="metobs_toolkit.modeldata.Modeldata" href="_autosummary/metobs_toolkit.modeldata.Modeldata.html" /> 
+    <link rel="prev" title="metobs_toolkit.modeldata.Modeldata" href="_autosummary/metobs_toolkit.modeldata.Modeldata.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-          
-          
+
+
           <a href="index.html">
-            
+
               <img src="_static/logo_small.svg" class="logo" alt="Logo"/>
           </a>
 <div role="search">
@@ -90,7 +90,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <section id="metobs-toolkit-documentation-for-developers">
 <h1>MetObs toolkit Documentation for developers<a class="headerlink" href="#metobs-toolkit-documentation-for-developers" title="Link to this heading"></a></h1>
 <p>Here you can find the documentation on all classes, functions, and methods in
@@ -122,7 +122,7 @@ <h1>MetObs toolkit Documentation for developers<a class="headerlink" href="#meto
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
+
 
 </footer>
         </div>
@@ -133,7 +133,7 @@ <h1>MetObs toolkit Documentation for developers<a class="headerlink" href="#meto
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>
diff --git a/docs/_build/_autosummary/metobs_toolkit.analysis.Analysis.html b/docs/_build/_autosummary/metobs_toolkit.analysis.Analysis.html
@@ -11,7 +11,7 @@
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
         <script src="../_static/documentation_options.js?v=d45e8c67"></script>
@@ -24,19 +24,19 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="metobs_toolkit.modeldata" href="metobs_toolkit.modeldata.html" />
-    <link rel="prev" title="metobs_toolkit.analysis.get_seasons" href="metobs_toolkit.analysis.get_seasons.html" /> 
+    <link rel="prev" title="metobs_toolkit.analysis.get_seasons" href="metobs_toolkit.analysis.get_seasons.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-          
-          
+
+
           <a href="../index.html">
-            
+
               <img src="../_static/logo_small.svg" class="logo" alt="Logo"/>
           </a>
 <div role="search">
@@ -119,7 +119,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <section id="metobs-toolkit-analysis-analysis">
 <h1>metobs_toolkit.analysis.Analysis<a class="headerlink" href="#metobs-toolkit-analysis-analysis" title="Link to this heading"></a></h1>
 <dl class="py class">
@@ -527,7 +527,7 @@ <h1>metobs_toolkit.analysis.Analysis<a class="headerlink" href="#metobs-toolkit-
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
+
 
 </footer>
         </div>
@@ -538,7 +538,7 @@ <h1>metobs_toolkit.analysis.Analysis<a class="headerlink" href="#metobs-toolkit-
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>
diff --git a/docs/_build/_autosummary/metobs_toolkit.analysis.filter_data.html b/docs/_build/_autosummary/metobs_toolkit.analysis.filter_data.html
@@ -11,7 +11,7 @@
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
         <script src="../_static/documentation_options.js?v=d45e8c67"></script>
@@ -24,19 +24,19 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="metobs_toolkit.analysis.get_seasons" href="metobs_toolkit.analysis.get_seasons.html" />
-    <link rel="prev" title="metobs_toolkit.analysis" href="metobs_toolkit.analysis.html" /> 
+    <link rel="prev" title="metobs_toolkit.analysis" href="metobs_toolkit.analysis.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-          
-          
+
+
           <a href="../index.html">
-            
+
               <img src="../_static/logo_small.svg" class="logo" alt="Logo"/>
           </a>
 <div role="search">
@@ -119,7 +119,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <section id="metobs-toolkit-analysis-filter-data">
 <h1>metobs_toolkit.analysis.filter_data<a class="headerlink" href="#metobs-toolkit-analysis-filter-data" title="Link to this heading"></a></h1>
 <dl class="py function">
@@ -172,7 +172,7 @@ <h1>metobs_toolkit.analysis.filter_data<a class="headerlink" href="#metobs-toolk
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
+
 
 </footer>
         </div>
@@ -183,7 +183,7 @@ <h1>metobs_toolkit.analysis.filter_data<a class="headerlink" href="#metobs-toolk
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>
diff --git a/docs/_build/_autosummary/metobs_toolkit.analysis.get_seasons.html b/docs/_build/_autosummary/metobs_toolkit.analysis.get_seasons.html
@@ -11,7 +11,7 @@
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
         <script src="../_static/documentation_options.js?v=d45e8c67"></script>
@@ -24,19 +24,19 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="metobs_toolkit.analysis.Analysis" href="metobs_toolkit.analysis.Analysis.html" />
-    <link rel="prev" title="metobs_toolkit.analysis.filter_data" href="metobs_toolkit.analysis.filter_data.html" /> 
+    <link rel="prev" title="metobs_toolkit.analysis.filter_data" href="metobs_toolkit.analysis.filter_data.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-          
-          
+
+
           <a href="../index.html">
-            
+
               <img src="../_static/logo_small.svg" class="logo" alt="Logo"/>
           </a>
 <div role="search">
@@ -119,7 +119,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <section id="metobs-toolkit-analysis-get-seasons">
 <h1>metobs_toolkit.analysis.get_seasons<a class="headerlink" href="#metobs-toolkit-analysis-get-seasons" title="Link to this heading"></a></h1>
 <dl class="py function">
@@ -168,7 +168,7 @@ <h1>metobs_toolkit.analysis.get_seasons<a class="headerlink" href="#metobs-toolk
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
+
 
 </footer>
         </div>
@@ -179,7 +179,7 @@ <h1>metobs_toolkit.analysis.get_seasons<a class="headerlink" href="#metobs-toolk
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -331,4 +331,3 @@ jobs:
		package_build
		documentation_requirements
		titan_requirements