Adds auto-lint-checking & runs linting.

Author: evanhanders

.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install black
+
+    - name: Run black
+      run: |
+        black --check .

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+      - id: black

examples/d2/2d_rayleigh_benard/plot_all_slices.py

@@ -16,29 +16,45 @@
     --col_inch=<float>   Number of inches / column [default: 6]
     --row_inch=<float>   Number of inches / row [default: 2]
 """
+
 from docopt import docopt
+
 args = docopt(__doc__)
 from plotpal.slices import SlicePlotter
 
 # Read in master output directory
-root_dir    = args['--root_dir']
-data_dir    = args['--data_dir']
+root_dir = args["--root_dir"]
+data_dir = args["--data_dir"]
 
 # Read in additional plot arguments
-start_fig   = int(args['--start_fig'])
-start_file  = int(args['--start_file'])
-out_name    = args['--out_name']
-n_files     = args['--n_files']
-if n_files is not None: 
+start_fig = int(args["--start_fig"])
+start_file = int(args["--start_file"])
+out_name = args["--out_name"]
+n_files = args["--n_files"]
+if n_files is not None:
     n_files = int(n_files)
 
 # Create Plotter object, tell it which fields to plot
-plotter = SlicePlotter(root_dir, file_dir=data_dir, out_name=out_name, start_file=start_file, n_files=n_files)
-plotter_kwargs = { 'col_inch' : float(args['--col_inch']), 'row_inch' : float(args['--row_inch']), 'pad_factor' : 15 }
+plotter = SlicePlotter(
+    root_dir,
+    file_dir=data_dir,
+    out_name=out_name,
+    start_file=start_file,
+    n_files=n_files,
+)
+plotter_kwargs = {
+    "col_inch": float(args["--col_inch"]),
+    "row_inch": float(args["--row_inch"]),
+    "pad_factor": 15,
+}
 
 plotter.setup_grid(num_rows=2, num_cols=2, **plotter_kwargs)
-plotter.add_colormesh('b', x_basis='x', y_basis='z', remove_x_mean=True, divide_x_std=True)
-plotter.add_colormesh('p', x_basis='x', y_basis='z', remove_x_mean=True, divide_x_std=True, cmap='PiYG_r')
-plotter.add_colormesh('ux', x_basis='x', y_basis='z', cmap='PuOr_r')
-plotter.add_colormesh('uz', x_basis='x', y_basis='z', cmap='PuOr_r')
-plotter.plot_colormeshes(start_fig=start_fig, dpi=int(args['--dpi']))
+plotter.add_colormesh(
+    "b", x_basis="x", y_basis="z", remove_x_mean=True, divide_x_std=True
+)
+plotter.add_colormesh(
+    "p", x_basis="x", y_basis="z", remove_x_mean=True, divide_x_std=True, cmap="PiYG_r"
+)
+plotter.add_colormesh("ux", x_basis="x", y_basis="z", cmap="PuOr_r")
+plotter.add_colormesh("uz", x_basis="x", y_basis="z", cmap="PuOr_r")
+plotter.plot_colormeshes(start_fig=start_fig, dpi=int(args["--dpi"]))

examples/d2/2d_rayleigh_benard/plot_b_pdf.py

@@ -17,30 +17,47 @@
     --col_inch=<float>   Number of inches / column [default: 6]
     --row_inch=<float>   Number of inches / row [default: 5]
 """
+
 import logging
+
 logger = logging.getLogger(__name__)
 from docopt import docopt
+
 args = docopt(__doc__)
 from plotpal.pdfs import PdfPlotter
 
 # Read in master output directory
-root_dir    = args['--root_dir']
-data_dir    = args['--data_dir']
+root_dir = args["--root_dir"]
+data_dir = args["--data_dir"]
 
 # Read in additional plot arguments
-start_fig   = int(args['--start_fig'])
-start_file  = int(args['--start_file'])
-out_name    = args['--out_name']
-n_files     = args['--n_files']
-if n_files is not None: 
+start_fig = int(args["--start_fig"])
+start_file = int(args["--start_file"])
+out_name = args["--out_name"]
+n_files = args["--n_files"]
+if n_files is not None:
     n_files = int(n_files)
 
-bins = int(args['--bins'])
+bins = int(args["--bins"])
 
 # Load in figures and make plots
 threeD = False
-bases  = ['x', 'z']
-pdfs_to_plot = ['b',]
-plotter = PdfPlotter(root_dir, file_dir=data_dir, out_name=out_name, start_file=start_file, n_files=n_files)
-plotter.calculate_pdfs(pdfs_to_plot, bins=bins, threeD=threeD, bases=bases, uneven_basis='z')
-plotter.plot_pdfs(dpi=int(args['--dpi']), row_inch=float(args['--row_inch']), col_inch=float(args['--col_inch']))
+bases = ["x", "z"]
+pdfs_to_plot = [
+    "b",
+]
+plotter = PdfPlotter(
+    root_dir,
+    file_dir=data_dir,
+    out_name=out_name,
+    start_file=start_file,
+    n_files=n_files,
+)
+plotter.calculate_pdfs(
+    pdfs_to_plot, bins=bins, threeD=threeD, bases=bases, uneven_basis="z"
+)
+plotter.plot_pdfs(
+    dpi=int(args["--dpi"]),
+    row_inch=float(args["--row_inch"]),
+    col_inch=float(args["--col_inch"]),
+)

examples/d2/2d_rayleigh_benard/plot_b_slices.py

@@ -16,26 +16,39 @@
     --col_inch=<float>   Number of inches / column [default: 6]
     --row_inch=<float>   Number of inches / row [default: 1.5]
 """
+
 from docopt import docopt
+
 args = docopt(__doc__)
 from plotpal.slices import SlicePlotter
 
 # Read in master output directory
-root_dir    = args['--root_dir']
-data_dir    = args['--data_dir']
+root_dir = args["--root_dir"]
+data_dir = args["--data_dir"]
 
 # Read in additional plot arguments
-start_fig   = int(args['--start_fig'])
-start_file  = int(args['--start_file'])
-out_name    = args['--out_name']
-n_files     = args['--n_files']
-if n_files is not None: 
+start_fig = int(args["--start_fig"])
+start_file = int(args["--start_file"])
+out_name = args["--out_name"]
+n_files = args["--n_files"]
+if n_files is not None:
     n_files = int(n_files)
 
 # Create Plotter object, tell it which fields to plot
-plotter = SlicePlotter(root_dir, file_dir=data_dir, out_name=out_name, start_file=start_file, n_files=n_files)
-plotter_kwargs = { 'col_inch' : float(args['--col_inch']), 'row_inch' : float(args['--row_inch']) }
+plotter = SlicePlotter(
+    root_dir,
+    file_dir=data_dir,
+    out_name=out_name,
+    start_file=start_file,
+    n_files=n_files,
+)
+plotter_kwargs = {
+    "col_inch": float(args["--col_inch"]),
+    "row_inch": float(args["--row_inch"]),
+}
 
 plotter.setup_grid(num_rows=1, num_cols=1, **plotter_kwargs)
-plotter.add_colormesh('b', x_basis='x', y_basis='z', remove_x_mean=True, divide_x_std=True)
-plotter.plot_colormeshes(start_fig=start_fig, dpi=int(args['--dpi']))
+plotter.add_colormesh(
+    "b", x_basis="x", y_basis="z", remove_x_mean=True, divide_x_std=True
+)
+plotter.plot_colormeshes(start_fig=start_fig, dpi=int(args["--dpi"]))

examples/d2/2d_rayleigh_benard/plot_instantaneous_profiles.py

@@ -15,24 +15,38 @@
     --col_inch=<float>     Figure width (inches) [default: 3]
     --row_inch=<float>     Figure height (inches) [default: 2]
 """
+
 from docopt import docopt
+
 args = docopt(__doc__)
 from plotpal.profiles import RolledProfilePlotter
 
-root_dir    = args['--root_dir']
-data_dir    = args['--data_dir']
-start_file  = int(args['--start_file'])
-subdir_name    = args['--subdir_name']
-dpi         = int(args['--dpi'])
-n_files     = args['--n_files']
-if n_files is not None: 
+root_dir = args["--root_dir"]
+data_dir = args["--data_dir"]
+start_file = int(args["--start_file"])
+subdir_name = args["--subdir_name"]
+dpi = int(args["--dpi"])
+n_files = args["--n_files"]
+if n_files is not None:
     n_files = int(n_files)
 
 
 # Create Plotter object, tell it which fields to plot
-plotter = RolledProfilePlotter(root_dir, file_dir=data_dir, out_name=subdir_name, start_file=start_file, n_files=n_files)
-plotter.setup_grid(num_rows=2, num_cols=1, col_inch=float(args['--col_inch']), row_inch=float(args['--row_inch']), pad_factor=15)
-plotter.add_line('z', 'b', grid_num=0)
-plotter.add_line('z', 'cond_flux', grid_num=1)
-plotter.add_line('z', 'conv_flux', grid_num=1)
+plotter = RolledProfilePlotter(
+    root_dir,
+    file_dir=data_dir,
+    out_name=subdir_name,
+    start_file=start_file,
+    n_files=n_files,
+)
+plotter.setup_grid(
+    num_rows=2,
+    num_cols=1,
+    col_inch=float(args["--col_inch"]),
+    row_inch=float(args["--row_inch"]),
+    pad_factor=15,
+)
+plotter.add_line("z", "b", grid_num=0)
+plotter.add_line("z", "cond_flux", grid_num=1)
+plotter.add_line("z", "conv_flux", grid_num=1)
 plotter.plot_lines(dpi=dpi)

examples/d2/2d_rayleigh_benard/plot_rolled_profiles.py

@@ -16,25 +16,42 @@
     --col_inch=<float>     Figure width (inches) [default: 3]
     --row_inch=<float>     Figure height (inches) [default: 2]
 """
+
 from docopt import docopt
+
 args = docopt(__doc__)
 from plotpal.profiles import RolledProfilePlotter
 
-root_dir    = args['--root_dir']
-data_dir    = args['--data_dir']
-start_file  = int(args['--start_file'])
-subdir_name    = args['--subdir_name']
-dpi         = int(args['--dpi'])
-n_files     = args['--n_files']
-if n_files is not None: 
+root_dir = args["--root_dir"]
+data_dir = args["--data_dir"]
+start_file = int(args["--start_file"])
+subdir_name = args["--subdir_name"]
+dpi = int(args["--dpi"])
+n_files = args["--n_files"]
+if n_files is not None:
     n_files = int(n_files)
 
-roll_writes = int(args['--roll_writes']) #rolling uses this many writes before AND after the current write, so 2x this many total.
+roll_writes = int(
+    args["--roll_writes"]
+)  # rolling uses this many writes before AND after the current write, so 2x this many total.
 
 # Create Plotter object, tell it which fields to plot
-plotter = RolledProfilePlotter(root_dir, file_dir=data_dir, out_name=subdir_name, roll_writes=roll_writes, start_file=start_file, n_files=n_files)
-plotter.setup_grid(num_rows=2, num_cols=1, col_inch=float(args['--col_inch']), row_inch=float(args['--row_inch']), pad_factor=15)
-plotter.add_line('z', 'b', grid_num=0)
-plotter.add_line('z', 'cond_flux', grid_num=1)
-plotter.add_line('z', 'conv_flux', grid_num=1)
+plotter = RolledProfilePlotter(
+    root_dir,
+    file_dir=data_dir,
+    out_name=subdir_name,
+    roll_writes=roll_writes,
+    start_file=start_file,
+    n_files=n_files,
+)
+plotter.setup_grid(
+    num_rows=2,
+    num_cols=1,
+    col_inch=float(args["--col_inch"]),
+    row_inch=float(args["--row_inch"]),
+    pad_factor=15,
+)
+plotter.add_line("z", "b", grid_num=0)
+plotter.add_line("z", "cond_flux", grid_num=1)
+plotter.add_line("z", "conv_flux", grid_num=1)
 plotter.plot_lines(dpi=dpi)

examples/d2/2d_rayleigh_benard/plot_scalar_traces.py

@@ -15,31 +15,40 @@
 
     --roll_writes=<int>     Number of writes to roll a comparison average over
 """
+
 from docopt import docopt
+
 args = docopt(__doc__)
 from plotpal.scalars import ScalarFigure, ScalarPlotter
 
-root_dir    = args['--root_dir']
-data_dir    = args['--data_dir']
-out_name    = args['--out_name']
-start_file  = int(args['--start_file'])
-n_files     = int(args['--n_files'])
-dpi         = int(args['--dpi'])
+root_dir = args["--root_dir"]
+data_dir = args["--data_dir"]
+out_name = args["--out_name"]
+start_file = int(args["--start_file"])
+n_files = int(args["--n_files"])
+dpi = int(args["--dpi"])
 
-roll_writes = args['--roll_writes']
+roll_writes = args["--roll_writes"]
 if roll_writes is not None:
     roll_writes = int(roll_writes)
 
 figs = []
 
 # Nu vs time
-fig1 = ScalarFigure(num_rows=2, num_cols=1, col_inch=6, fig_name='fundamentals')
-fig1.add_field(0, 'Re', color='orange')
-fig1.add_field(1, 'Nu', color='indigo')
+fig1 = ScalarFigure(num_rows=2, num_cols=1, col_inch=6, fig_name="fundamentals")
+fig1.add_field(0, "Re", color="orange")
+fig1.add_field(1, "Nu", color="indigo")
 figs.append(fig1)
 
 # Load in figures and make plots
-plotter = ScalarPlotter(root_dir, file_dir=data_dir, out_name=out_name, start_file=start_file, n_files=n_files, roll_writes=roll_writes)
+plotter = ScalarPlotter(
+    root_dir,
+    file_dir=data_dir,
+    out_name=out_name,
+    start_file=start_file,
+    n_files=n_files,
+    roll_writes=roll_writes,
+)
 plotter.load_figures(figs)
 plotter.plot_figures(dpi=dpi)
 plotter.plot_convergence_figures(dpi=dpi)