chore: increase line length, apply ruff formatting (#76)

Author: wpbonelli

autotest/test_interface.py

@@ -9,18 +9,10 @@
 from modflowapi import Callbacks, ModflowApi, run_simulation
 from modflowapi.extensions.pakbase import AdvancedPackage, ArrayPackage, ListPackage
 
-data_pth = Path("../examples/data")
+data_pth = Path("../docs/examples/data")
 pytestmark = pytest.mark.extensions
 os = system()
-so = "libmf6" + (
-    ".so"
-    if os == "Linux"
-    else ".dylib"
-    if os == "Darwin"
-    else ".dll"
-    if os == "Windows"
-    else None
-)
+so = "libmf6" + (".so" if os == "Linux" else ".dylib" if os == "Darwin" else ".dll" if os == "Windows" else None)
 if so is None:
     pytest.skip("Unsupported operating system", allow_module_level=True)
 
@@ -76,9 +68,7 @@ def callback(sim, step):
                 raise AssertionError("ApiModel size is incorrect")
 
             if (model.kper, model.kstp) != (-1, -1):
-                raise AssertionError(
-                    "ApiModel has advanced prior to initialization callback"
-                )
+                raise AssertionError("ApiModel has advanced prior to initialization callback")
 
             dis = model.dis
             if not isinstance(dis, ArrayPackage):
@@ -102,15 +92,11 @@ def callback(sim, step):
 
         elif step == Callbacks.stress_period_start:
             if sim.kstp != 0:
-                raise AssertionError(
-                    "Solution advanced prior to stress_period_start callback"
-                )
+                raise AssertionError("Solution advanced prior to stress_period_start callback")
 
         elif step == Callbacks.timestep_start:
             if sim.iteration != -1:
-                raise AssertionError(
-                    "Solution advanced prior to timestep_start callback"
-                )
+                raise AssertionError("Solution advanced prior to timestep_start callback")
 
             factor = ((1 + sim.kstp) / sim.nstp) * 0.5
             spd = sim.test_model.wel.stress_period_data.values
@@ -169,9 +155,7 @@ def callback(sim, step):
                 raise AssertionError("ApiModel size is incorrect")
 
             if (model.kper, model.kstp) != (-1, -1):
-                raise AssertionError(
-                    "ApiModel has advanced prior to initialization callback"
-                )
+                raise AssertionError("ApiModel has advanced prior to initialization callback")
 
             dis = model.dis
             if not isinstance(dis, ArrayPackage):
@@ -195,15 +179,11 @@ def callback(sim, step):
 
         elif step == Callbacks.stress_period_start:
             if sim.kstp != 0:
-                raise AssertionError(
-                    "Solution advanced prior to stress_period_start callback"
-                )
+                raise AssertionError("Solution advanced prior to stress_period_start callback")
 
         elif step == Callbacks.timestep_start:
             if sim.iteration != -1:
-                raise AssertionError(
-                    "Solution advanced prior to timestep_start callback"
-                )
+                raise AssertionError("Solution advanced prior to timestep_start callback")
 
             factor = 0.75
             spd = sim.gwf_1.chd_left.stress_period_data.values
@@ -253,9 +233,7 @@ def callback(sim, step):
                 raise AssertionError("ApiModel size is incorrect")
 
             if (model.kper, model.kstp) != (-1, -1):
-                raise AssertionError(
-                    "ApiModel has advanced prior to initialization callback"
-                )
+                raise AssertionError("ApiModel has advanced prior to initialization callback")
 
             dis = model.dis
             if not isinstance(dis, ArrayPackage):
@@ -275,15 +253,11 @@ def callback(sim, step):
 
         elif step == Callbacks.stress_period_start:
             if sim.kstp != 0:
-                raise AssertionError(
-                    "Solution advanced prior to stress_period_start callback"
-                )
+                raise AssertionError("Solution advanced prior to stress_period_start callback")
 
         elif step == Callbacks.timestep_start:
             if sim.iteration != -1:
-                raise AssertionError(
-                    "Solution advanced prior to timestep_start callback"
-                )
+                raise AssertionError("Solution advanced prior to timestep_start callback")
 
             factor = 1.75
             spd = sim.gwf_1.rch.stress_period_data.values
@@ -362,9 +336,7 @@ def callback(sim, step):
             wel.rhs = rhs
 
             rhs2 = wel.get_advanced_var("rhs")
-            np.testing.assert_allclose(
-                rhs, rhs2, err_msg="rhs variable not being properly set"
-            )
+            np.testing.assert_allclose(rhs, rhs2, err_msg="rhs variable not being properly set")
 
             hcof = wel.hcof
             hcof[0:3] = np.abs(rhs)[0:3] / 2
@@ -373,17 +345,13 @@ def callback(sim, step):
 
             hcof2 = wel.get_advanced_var("hcof")
 
-            np.testing.assert_allclose(
-                hcof, hcof2, err_msg="hcof is not being properly set"
-            )
+            np.testing.assert_allclose(hcof, hcof2, err_msg="hcof is not being properly set")
 
             rhs *= 1.2
             wel.set_advanced_var("rhs", rhs)
             rhs3 = wel.rhs
 
-            np.testing.assert_allclose(
-                rhs, rhs3, err_msg="set advanced var method not working properly"
-            )
+            np.testing.assert_allclose(rhs, rhs3, err_msg="set advanced var method not working properly")
 
             npf = model.npf
 

docs/conf.py

@@ -4,44 +4,41 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import os
+import sys
 from pathlib import Path
+
 from flopy.utils.get_modflow import run_main as get_modflow
-import sys
-sys.path.insert(0, os.path.abspath('../'))
+
+sys.path.insert(0, os.path.abspath("../"))
 from modflowapi import __version__
 
 # -- Determine if this is a development or release version ------------------
 branch_or_version = __version__ if "dev" not in __version__ else "develop"
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-project = 'modflowapi'
-copyright = '2025, modflowapi developers'
-author = 'modflowapi developers'
-release = '0.3.0.dev0'
+project = "modflowapi"
+copyright = "2025, modflowapi developers"
+author = "modflowapi developers"
+release = "0.3.0.dev0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.autosummary",
-    "myst_parser",
-    "nbsphinx"
-]
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**/Extensions.py']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary", "myst_parser", "nbsphinx"]
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/Extensions.py"]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
 
 # -- nbsphinx configuration -------------------------------------------------
 nbsphinx_custom_formats = {
-    '.py': ['jupytext.reads', {'fmt': 'py:light'}],
+    ".py": ["jupytext.reads", {"fmt": "py:light"}],
 }
 
 # -- Install MODFLOW --------------------------------------------------------
 bindir = Path.cwd() / "examples" / "notebooks"
 repo = "modflow6-nightly-build" if branch_or_version == "develop" else "modflow6"
-get_modflow(str(bindir), repo=repo)
+get_modflow(str(bindir), repo=repo)