Linting

docs/builddocs.sh

@@ -21,4 +21,4 @@ make html
 
 echo ""
 echo -e "-- ${GRN}Building Docs Complete${NC} --"
-echo -e "See ${YEL}sphinx_doc/_build/html/${NC} for sphinx html files"
+echo -e "See ${YEL}sphinx_doc/_build/html/${NC} for sphinx html files"

docs/requirement_docs.txt

@@ -2,4 +2,4 @@ recommonmark
 sphinx>=1.4
 sphinx-argparse
 sphinx_rtd_theme
-sphinx-gallery
+sphinx-gallery

docs/sphinx_doc/Makefile

@@ -222,4 +222,4 @@ pseudoxml:
 dummy:
 	$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
 	@echo
-	@echo "Build finished. Dummy builder generates no files."
+	@echo "Build finished. Dummy builder generates no files."

docs/sphinx_doc/conf.py

@@ -1,9 +1,10 @@
 # -*- coding: utf-8 -*-
 #
 # import os
-import sys
+
+
 # sys.path.insert(0, os.path.abspath('.'))
-#sys.path.append("../breathe")
+# sys.path.append("../breathe")
 
 # -- General configuration ------------------------------------------------
 
@@ -14,49 +15,49 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [ 'sphinx.ext.mathjax']
+extensions = ["sphinx.ext.mathjax"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-#breathe_projects = {"NDSL": "../doxygen_output/xml/"}
-#breathe_default_project = "NDSL"
+templates_path = ["_templates"]
+# breathe_projects = {"NDSL": "../doxygen_output/xml/"}
+# breathe_default_project = "NDSL"
 
-#fortran_src ='../../Source/Src_2d/'
-#fortran_ext =[' 'F90']
+# fortran_src ='../../Source/Src_2d/'
+# fortran_ext =[' 'F90']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 #
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project   = u'NDSL'
-copyright = u' '
-author    = u'NOAA/NASA NDSL development team'
+project = u"NDSL"
+copyright = u" "
+author = u"NOAA/NASA NDSL development team"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'0.1'
+version = u"0.1"
 # The full version, including alpha/beta/rc tags.
-release = u'0.1'
+release = u"0.1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'en'
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -70,7 +71,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -92,7 +93,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -104,15 +105,15 @@
 todo_include_todos = False
 
 numfig = True
-numfig_format = {'figure': '%s', 'table': '%s', 'code-block': '%s'}
+numfig_format = {"figure": "%s", "table": "%s", "code-block": "%s"}
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-#html_theme = 'nature'
-html_theme = 'sphinx_rtd_theme'
+# html_theme = 'nature'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -146,7 +147,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['static']
+html_static_path = ["static"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -226,23 +227,20 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'ndsl document'
+htmlhelp_basename = "ndsl document"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -252,8 +250,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'NDSL.tex', u'NDSL Documentation',
-     author, 'manual'),
+    (master_doc, "NDSL.tex", u"NDSL Documentation", author, "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -293,10 +290,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'ndsl', u'NDSL Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "ndsl", u"NDSL Documentation", [author], 1)]
 
 # If true, show URL addresses after external links.
 #
@@ -309,9 +303,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'ndsl', u'NDSL Documentation',
-     author, 'NDSL', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "ndsl",
+        u"NDSL Documentation",
+        author,
+        "NDSL",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -328,4 +328,4 @@
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #
-# texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False

docs/sphinx_doc/dace.rst

@@ -1,9 +1,9 @@
 Dace
 ============
 
-DaCe is a parallel programming framework developed at Scalable Parallel Computing Laboratory (SPCL), DaCe is a high level intermediate representation (IR) that parses most of the Python/NumPy semantcs, and Fortran programming languages in the frontend to DaCe IR, and then optimizes the IR by passes/transformations, the DaCe IRs then used by the backend codegen to generate highly efficient C++ code for high-performance CPU, GPU, and FPGA hardware devices. 
+DaCe is a parallel programming framework developed at Scalable Parallel Computing Laboratory (SPCL), DaCe is a high level intermediate representation (IR) that parses most of the Python/NumPy semantcs, and Fortran programming languages in the frontend to DaCe IR, and then optimizes the IR by passes/transformations, the DaCe IRs then used by the backend codegen to generate highly efficient C++ code for high-performance CPU, GPU, and FPGA hardware devices.
 
 DaCe IR uses the Stateful Dataflow multiGraphs (SDFG) data-centric intermediate representation: A transformable, interactive representation of code based on data movement. Since the input code and the SDFG are separate, it is possible to optimize a program without changing its source, so that it stays readable. On the other hand, the used optimizations are customizable and user-extensible, so they can be written once and reused in many applications. With data-centric parallel programming, we enable direct knowledge transfer of performance optimization, regardless of the application or the target processor.
 
 For more detailed document about DaCe, please refer to the following link:
-https://spcldace.readthedocs.io/en/latest/index.html
+https://spcldace.readthedocs.io/en/latest/index.html

docs/sphinx_doc/docker.rst

@@ -20,4 +20,4 @@ Then build the `pace` docker image at the top level:
 
     $ make build
 
-.. _`Docker Desktop`: https://www.docker.com/
+.. _`Docker Desktop`: https://www.docker.com/

docs/sphinx_doc/gt4py.rst

@@ -1,7 +1,7 @@
-Gt4py 
+Gt4py
 ==========
 
 pace-physics includes the Python implementation of GFS physics built using the GT4Py domain-specific language.
 Currently, only GFDL cloud microphysics is integrated into Pace.
 Additional physics schemes (NOAH land surface, GFS sea ice, scale-aware mass-flux shallow convection, hybrid eddy-diffusivity mass-flux PBL and free atmospheric turbulence, and rapid radiative transfer model) have been ported indendepently and are available in the `physics-standalone`_ repository.
-Additional work is required to integrate these schemes.
+Additional work is required to integrate these schemes.

docs/sphinx_doc/index.rst

@@ -24,4 +24,4 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`

docs/sphinx_doc/make.bat

@@ -278,4 +278,4 @@ if "%1" == "dummy" (
 	goto end
 )
 
-:end
+:end

docs/sphinx_doc/overview.rst

@@ -123,4 +123,4 @@ Install Pace with different NDSL backend:
 
       $ pip3 install -r requirements_dev.txt -c constraints.txt
 
-  - There are also separate requirements files which can be installed for linting (`requirements_lint.txt`) and building documentation   (`requirements_docs.txt`).
+  - There are also separate requirements files which can be installed for linting (`requirements_lint.txt`) and building documentation   (`requirements_docs.txt`).

docs/sphinx_doc/program_guid.rst

@@ -1,4 +1,4 @@
 Program Guide
 =============
 
-This page will include general introductory information about NDSL, including external links to docs.
+This page will include general introductory information about NDSL, including external links to docs.

docs/sphinx_doc/test.rst

@@ -62,4 +62,4 @@ We suggest reading the Makefile for a full list of translate test targets. Check
 
     $ make test_savepoint
 
-.. _`fv3gfs-fortran`: https://github.com/ai2cm/fv3gfs-fortran/tree/master/tests/serialized_test_data_generation
+.. _`fv3gfs-fortran`: https://github.com/ai2cm/fv3gfs-fortran/tree/master/tests/serialized_test_data_generation

docs/sphinx_doc/testing.rst

@@ -62,4 +62,4 @@ We suggest reading the Makefile for a full list of translate test targets. Check
 
     $ make test_savepoint
 
-.. _`fv3gfs-fortran`: https://github.com/ai2cm/fv3gfs-fortran/tree/master/tests/serialized_test_data_generation
+.. _`fv3gfs-fortran`: https://github.com/ai2cm/fv3gfs-fortran/tree/master/tests/serialized_test_data_generation