Merge pull request #23 from ColmTalbot/formatting

Add auto-formatting and pre-commits

Author: ColmTalbot

.git-blame-ignore-revs

@@ -0,0 +1,3 @@
+# .git-blame-ignore-revs
+# add pre-commits
+73de5cd8b6c155d48ccd45e52449278e6c00657e

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+repos:
+-   repo: https://github.com/ambv/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+        language_version: python3
+-   repo: https://github.com/ambv/black
+    rev: 22.10.0
+    hooks:
+      - id: black-jupyter
+        language_version: python3
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    -   id: check-merge-conflict # prevent committing files with merge conflicts
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.2.2
+    hooks:
+    -   id: codespell # Spellchecker
+        args: [-L, "nd,hist", "--skip", "*.ipynb"]
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
+    hooks:
+    -   id: isort # sort imports alphabetically and separates import into sections
+        args: [-w=88, -m=3, --tc, -sp=setup.cfg ]
+-   repo: local
+    hooks:
+    -   id: flynt
+        name: flynt
+        entry: flynt
+        args: [--fail-on-change]
+        types: [python]
+        language: python
+        additional_dependencies:
+            - flynt
+-   repo: https://github.com/ColmTalbot/nbstrip
+    rev: v0.1.1
+    hooks:
+    -   id: nbstrip
+        args: [-i, -v]

bin/generate_gamma_data.py

@@ -30,10 +30,9 @@
     label_1 = f"{ell1}{m1}"
     for ell2, m2 in lms:
         label_2 = f"{ell2}{m2}"
-        gammalmlm = np.array([
-            angles.analytic_gamma((ell1, m1), (ell2, m2), ell)
-            for ell in range(2, 21)
-        ])
+        gammalmlm = np.array(
+            [angles.analytic_gamma((ell1, m1), (ell2, m2), ell) for ell in range(2, 21)]
+        )
         delta_m = m1 - m2
         new[str(delta_m)][label_1 + label_2] = np.real(gammalmlm)
 for key in new:

docs/conf.py

@@ -18,8 +18,10 @@
 #
 import os
 import sys
+
 import gwmemory
-sys.path.insert(0, os.path.abspath('../'))
+
+sys.path.insert(0, os.path.abspath("../"))
 
 # -- General configuration ------------------------------------------------
 
@@ -30,34 +32,39 @@
 # 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.mathjax', 'numpydoc',
-              'nbsphinx', 'sphinx.ext.autosummary']
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
+    "numpydoc",
+    "nbsphinx",
+    "sphinx.ext.autosummary",
+]
 
 # 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', '.txt']
+source_suffix = [".rst", ".md", ".txt"]
 # source_suffix = '.txt'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'GWMemory'
-copyright = u'2018, Colm Talbot'
-author = u'Colm Talbot'
+project = "GWMemory"
+copyright = "2018, Colm Talbot"
+author = "Colm Talbot"
 
 
 # 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.
-fullversion = gwmemory.__version__.split(':')[0]
-version = '.'.join(fullversion.split('.')[:2])
+fullversion = gwmemory.__version__.split(":")[0]
+version = ".".join(fullversion.split(".")[:2])
 # The full version, including alpha/beta/rc tags.
 release = fullversion
 
@@ -71,10 +78,10 @@
 # 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', 'requirements.txt']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "requirements.txt"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -85,7 +92,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+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
@@ -96,28 +103,28 @@
 # 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"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
 # This is required for the alabaster theme
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
-        'donate.html',
+    "**": [
+        "about.html",
+        "navigation.html",
+        "relations.html",  # needs 'show_related': True theme option to display
+        "searchbox.html",
+        "donate.html",
     ]
 }
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'gwmemorydoc'
+htmlhelp_basename = "gwmemorydoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -126,15 +133,12 @@
     # 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',
@@ -144,19 +148,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'gwmemory.tex', u'GWMemory Documentation',
-     u'Colm Talbot', 'manual'),
+    (master_doc, "gwmemory.tex", "GWMemory Documentation", "Colm Talbot", "manual"),
 ]
 
 
 # -- 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, 'GWMemory', u'GWMemory Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "GWMemory", "GWMemory Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -165,9 +165,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'GWMemory', u'GWMemory Documentation',
-     author, 'Colm Talbot', 'Arbitrary gravitational-wave memory waveforms.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "GWMemory",
+        "GWMemory Documentation",
+        author,
+        "Colm Talbot",
+        "Arbitrary gravitational-wave memory waveforms.",
+        "Miscellaneous",
+    ),
 ]
 
 numpydoc_show_class_members = False

examples/Comparison.ipynb

@@ -105,13 +105,19 @@
     "for ii, mode in enumerate(modes):\n",
     "    gwmem = h_mem[mode]\n",
     "    sxsmem = h_mem_sxs[mode]\n",
-    "    overlap = np.vdot(gwmem, sxsmem) / np.vdot(gwmem, gwmem) ** 0.5 / np.vdot(sxsmem, sxsmem) ** 0.5\n",
+    "    overlap = (\n",
+    "        np.vdot(gwmem, sxsmem)\n",
+    "        / np.vdot(gwmem, gwmem) ** 0.5\n",
+    "        / np.vdot(sxsmem, sxsmem) ** 0.5\n",
+    "    )\n",
     "\n",
     "    ax = axes[ii // 3, ii % 3]\n",
     "    ax.plot(times, gwmem.real, label=\"GWMemory\")\n",
     "    ax.plot(times_sxs, sxsmem.real, linestyle=\":\", label=\"SXS\")\n",
     "    ax.annotate(f\"Mode: ({mode[0]}, {mode[1]})\", (0.03, 0.75), xycoords=\"axes fraction\")\n",
-    "    ax.annotate(f\"Mismatch: {1 - overlap.real:.1e}\", (0.35, 0.75), xycoords=\"axes fraction\")\n",
+    "    ax.annotate(\n",
+    "        f\"Mismatch: {1 - overlap.real:.1e}\", (0.35, 0.75), xycoords=\"axes fraction\"\n",
+    "    )\n",
     "axes[0, 0].legend(loc=\"lower left\")\n",
     "axes[-1, 0].set_xlabel(\"$t [M]$\")\n",
     "axes[-1, 1].set_xlabel(\"$t [M]$\")\n",