roms-tools 1.4.1__tar.gz → 1.4.2__tar.gz

{roms_tools-1.4.1 → roms_tools-1.4.2}/.github/workflows/pre-commit.yaml

@@ -11,4 +11,8 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
+    - name: Install specific pre-commit version
+      run: pip install pre-commit==3.8.0
     - uses: pre-commit/action@v3.0.1
+      with:
+        extra_args: --all-files

{roms_tools-1.4.1 → roms_tools-1.4.2}/.pre-commit-config.yaml

@@ -6,7 +6,7 @@ exclude: roms_tools/tests/test_setup/test_data/
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -40,3 +40,9 @@ repos:
     rev: v0.3.6
     hooks:
       - id: blackdoc
+
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
+    hooks:
+      - id: docformatter
+        args: ["--in-place", "--recursive", "--wrap-summaries=88", "--wrap-descriptions=88"]

{roms_tools-1.4.1 → roms_tools-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: roms-tools
-Version: 1.4.1
+Version: 1.4.2
 Summary: Tools for running and analysing UCLA-ROMS simulations
 Author-email: Nora Loose <nora.loose@gmail.com>, Thomas Nicholas <tom@cworthy.org>
 License: Apache-2

{roms_tools-1.4.1 → roms_tools-1.4.2}/conftest.py

@@ -65,9 +65,7 @@ def tidal_forcing(request, use_dask):
 
 @pytest.fixture(scope="session")
 def initial_conditions(request, use_dask):
-    """
-    Fixture for creating an InitialConditions object.
-    """
+    """Fixture for creating an InitialConditions object."""
 
     grid = Grid(
         nx=2,
@@ -95,9 +93,7 @@ def initial_conditions(request, use_dask):
 
 @pytest.fixture(scope="session")
 def initial_conditions_with_bgc(request, use_dask):
-    """
-    Fixture for creating an InitialConditions object.
-    """
+    """Fixture for creating an InitialConditions object."""
 
     grid = Grid(
         nx=2,
@@ -127,9 +123,7 @@ def initial_conditions_with_bgc(request, use_dask):
 
 @pytest.fixture(scope="session")
 def initial_conditions_with_bgc_from_climatology(request, use_dask):
-    """
-    Fixture for creating an InitialConditions object.
-    """
+    """Fixture for creating an InitialConditions object."""
 
     grid = Grid(
         nx=2,
@@ -163,9 +157,7 @@ def initial_conditions_with_bgc_from_climatology(request, use_dask):
 
 @pytest.fixture(scope="session")
 def boundary_forcing(request, use_dask):
-    """
-    Fixture for creating a BoundaryForcing object.
-    """
+    """Fixture for creating a BoundaryForcing object."""
 
     grid = Grid(
         nx=2,
@@ -194,9 +186,7 @@ def boundary_forcing(request, use_dask):
 
 @pytest.fixture(scope="session")
 def bgc_boundary_forcing_from_climatology(request, use_dask):
-    """
-    Fixture for creating a BoundaryForcing object.
-    """
+    """Fixture for creating a BoundaryForcing object."""
 
     grid = Grid(
         nx=2,
@@ -226,9 +216,7 @@ def bgc_boundary_forcing_from_climatology(request, use_dask):
 
 @pytest.fixture(scope="session")
 def surface_forcing(request, use_dask):
-    """
-    Fixture for creating a SurfaceForcing object.
-    """
+    """Fixture for creating a SurfaceForcing object."""
 
     grid = Grid(
         nx=5,
@@ -256,9 +244,7 @@ def surface_forcing(request, use_dask):
 
 @pytest.fixture(scope="session")
 def coarse_surface_forcing(request, use_dask):
-    """
-    Fixture for creating a SurfaceForcing object.
-    """
+    """Fixture for creating a SurfaceForcing object."""
 
     grid = Grid(
         nx=5,
@@ -287,9 +273,8 @@ def coarse_surface_forcing(request, use_dask):
 
 @pytest.fixture(scope="session")
 def corrected_surface_forcing(request, use_dask):
-    """
-    Fixture for creating a SurfaceForcing object with shortwave radiation correction.
-    """
+    """Fixture for creating a SurfaceForcing object with shortwave radiation
+    correction."""
 
     grid = Grid(
         nx=5,
@@ -318,9 +303,7 @@ def corrected_surface_forcing(request, use_dask):
 
 @pytest.fixture(scope="session")
 def bgc_surface_forcing(request, use_dask):
-    """
-    Fixture for creating a SurfaceForcing object with BGC.
-    """
+    """Fixture for creating a SurfaceForcing object with BGC."""
     grid = Grid(
         nx=5,
         ny=5,
@@ -348,9 +331,7 @@ def bgc_surface_forcing(request, use_dask):
 
 @pytest.fixture(scope="session")
 def bgc_surface_forcing_from_climatology(request, use_dask):
-    """
-    Fixture for creating a SurfaceForcing object with BGC from climatology.
-    """
+    """Fixture for creating a SurfaceForcing object with BGC from climatology."""
     grid = Grid(
         nx=5,
         ny=5,

{roms_tools-1.4.1 → roms_tools-1.4.2}/docs/_templates/autosummary/class.rst

@@ -3,7 +3,6 @@
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
-   :special-members:
 
    {% block methods %}
    {% if methods %}

{roms_tools-1.4.1 → roms_tools-1.4.2}/docs/environment.yml

@@ -8,5 +8,6 @@ dependencies:
   - nbsphinx
   - sphinx-book-theme
   - sphinxcontrib-bibtex
+  - pre-commit
   # for running jupyter notebooks
   - ipykernel