From 0a17c391dbd6d1ca600a17284f3c3edbd940e12c Mon Sep 17 00:00:00 2001 From: fAndreuzzi Date: Sun, 21 Jul 2024 13:49:23 +0200 Subject: [PATCH] black stuff --- .github/workflows/testing_pr.yml | 2 +- docs/source/conf.py | 173 +++++++++--------- pydmd/preprocessing/randomized.py | 2 +- tests/test_bopdmd.py | 2 +- tests/test_xyinput.py | 2 +- .../tutorial20/costs-tutorial_real-data.ipynb | 2 +- 6 files changed, 95 insertions(+), 88 deletions(-) diff --git a/.github/workflows/testing_pr.yml b/.github/workflows/testing_pr.yml index eeff3da1f..34d558919 100644 --- a/.github/workflows/testing_pr.yml +++ b/.github/workflows/testing_pr.yml @@ -46,7 +46,7 @@ jobs: - uses: actions/checkout@v4.1.7 - name: Install black run: | - pip install black[jupyter]==24.2.0 + pip install black[jupyter]==24.4.2 - name: Run black formatter on PyDMD source code run: | diff --git a/docs/source/conf.py b/docs/source/conf.py index 2acaae943..4eb581fde 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,61 +22,63 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath("../..")) import pydmd # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.4' +needs_sphinx = "1.4" if needs_sphinx > sphinx.__display_version__: - message = 'This project needs at least Sphinx v{0!s}'.format(needs_sphinx) + message = "This project needs at least Sphinx v{0!s}".format(needs_sphinx) raise VersionRequirementError(message) # 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.autodoc', - 'sphinx.ext.autosummary', - 'sphinx.ext.coverage', - 'sphinx.ext.graphviz', - 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.coverage', - 'sphinx.ext.viewcode', - 'sphinx.ext.imgmath', - 'sphinx.ext.ifconfig', - 'sphinx.ext.mathjax', + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.coverage", + "sphinx.ext.graphviz", + "sphinx.ext.doctest", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.coverage", + "sphinx.ext.viewcode", + "sphinx.ext.imgmath", + "sphinx.ext.ifconfig", + "sphinx.ext.mathjax", ] -intersphinx_mapping = {'python': ('http://docs.python.org/2', None), - 'numpy': ('http://docs.scipy.org/doc/numpy/', None), - 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None), - 'matplotlib': ('http://matplotlib.sourceforge.net/', None)} +intersphinx_mapping = { + "python": ("http://docs.python.org/2", None), + "numpy": ("http://docs.scipy.org/doc/numpy/", None), + "scipy": ("http://docs.scipy.org/doc/scipy/reference/", None), + "matplotlib": ("http://matplotlib.sourceforge.net/", None), +} # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # 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' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'PyDMD' +project = "PyDMD" copyright = pydmd.__copyright__ author = pydmd.__author__ # autoclass -autoclass_content = 'both' +autoclass_content = "both" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -96,9 +98,9 @@ # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -106,7 +108,7 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -117,13 +119,13 @@ # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# 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 = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. keep_warnings = False @@ -145,72 +147,72 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -#html_theme = 'bizstyle' +# html_theme = 'bizstyle' 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 # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # 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 # directly to the root of the documentation. -html_extra_path = ['_tutorials'] +html_extra_path = ["_tutorials"] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = "%b %d, %Y" # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = True @@ -218,84 +220,83 @@ # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' +# html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} +# html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' +# html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'pydmddoc' +htmlhelp_basename = "pydmddoc" # -- 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', + # 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', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'pydmd.tex', u'pydmd Documentation', - u'PyDMD contributors', 'manual'), + ( + master_doc, + "pydmd.tex", + "pydmd Documentation", + "PyDMD contributors", + "manual", + ), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'pydmd', u'pydmd Documentation', - [author], 1) -] +man_pages = [(master_doc, "pydmd", "pydmd Documentation", [author], 1)] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -304,19 +305,25 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'pydmd', u'pydmd Documentation', - author, 'pydmd', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "pydmd", + "pydmd Documentation", + author, + "pydmd", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False diff --git a/pydmd/preprocessing/randomized.py b/pydmd/preprocessing/randomized.py index 9aff3e3d2..38a3a9f50 100644 --- a/pydmd/preprocessing/randomized.py +++ b/pydmd/preprocessing/randomized.py @@ -53,7 +53,7 @@ def _pre( power_iters: int, test_matrix: np.ndarray, seed: int, - **kwargs + **kwargs, ): Q = compute_rqb( X, diff --git a/tests/test_bopdmd.py b/tests/test_bopdmd.py index 1b5cd30fb..725eaa86b 100644 --- a/tests/test_bopdmd.py +++ b/tests/test_bopdmd.py @@ -30,7 +30,7 @@ def ode_sys(zt, z): [t_eval[0], t_eval[-1]], [1.0, 0.1], t_eval=t_eval, - **integrator_keywords + **integrator_keywords, ) return sol.y diff --git a/tests/test_xyinput.py b/tests/test_xyinput.py index 281aad81e..9576af156 100644 --- a/tests/test_xyinput.py +++ b/tests/test_xyinput.py @@ -30,7 +30,7 @@ def ode_sys(zt, z): [t_eval[0], t_eval[-1]], [1.0, 0.1], t_eval=t_eval, - **integrator_keywords + **integrator_keywords, ) return sol.y diff --git a/tutorials/tutorial20/costs-tutorial_real-data.ipynb b/tutorials/tutorial20/costs-tutorial_real-data.ipynb index 449390cc1..378c2abb2 100644 --- a/tutorials/tutorial20/costs-tutorial_real-data.ipynb +++ b/tutorials/tutorial20/costs-tutorial_real-data.ipynb @@ -676,7 +676,7 @@ " ds_data.time.values,\n", " ds_data.z.values,\n", " xr_low_frequency,\n", - " **plot_kwargs_lf\n", + " **plot_kwargs_lf,\n", " )\n", " ax.set_title(\"Low frequency: window = {}s\".format(m._window_length))\n", " ax.set_ylabel(\"Height (m)\")\n",