Update package name to match package name format that is required on PyPi; pre-commit bump (incl. docstring updates)

.pre-commit-config.yaml

@@ -1,21 +1,21 @@
 files: '.py'
 exclude: '.git'
-default_stages: [commit]
+default_stages: [pre-commit]
 
 repos:
   - repo: https://github.com/psf/black
-    rev: 24.1.1
+    rev: 25.1.0
     hooks:
       - id: black
 
   - repo: https://github.com/timothycrosley/isort
-    rev: 5.13.2
+    rev: 6.0.1
     hooks:
       - id: isort
         args: ["--profile", "black"]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer

PyMPDATA_MPI/domain_decomposition.py

@@ -1,4 +1,4 @@
-""" MPI-aware domain decomposition utilities """
+"""MPI-aware domain decomposition utilities"""
 
 import numpy as np
 from PyMPDATA.impl.domain_decomposition import make_subdomain

PyMPDATA_MPI/impl/__init__.py

@@ -1,3 +1,3 @@
-""" implementation details """
+"""implementation details"""
 
 from .mpi_boundary_condition import MPIBoundaryCondition

PyMPDATA_MPI/impl/boundary_condition_commons.py

@@ -1,5 +1,5 @@
 # pylint: disable=too-many-positional-arguments,too-many-arguments
-""" boundary_condition common functions """
+"""boundary_condition common functions"""
 
 from functools import lru_cache
 

PyMPDATA_MPI/impl/mpi_boundary_condition.py

@@ -1,4 +1,4 @@
-""" common base class for MPI boundary conditions """
+"""common base class for MPI boundary conditions"""
 
 from PyMPDATA_MPI.impl.boundary_condition_commons import make_scalar_boundary_condition
 

PyMPDATA_MPI/mpi_periodic.py

@@ -1,4 +1,4 @@
-""" periodic/cyclic boundary condition logic """
+"""periodic/cyclic boundary condition logic"""
 
 from functools import lru_cache
 

PyMPDATA_MPI/mpi_polar.py

@@ -1,4 +1,4 @@
-""" polar boundary condition logic """
+"""polar boundary condition logic"""
 
 from functools import lru_cache
 

pyproject.toml

@@ -8,7 +8,7 @@ requires = ['setuptools==69.1.0', 'setuptools-scm==7.1.0']
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "PyMPDATA-MPI"
+name = "pympdata-mpi"
 description = "PyMPDATA + numba-mpi coupler sandbox"
 readme = "README.md"
 requires-python = ">=3.10"

scenarios/__init__.py

@@ -1,4 +1,4 @@
-""" base imports for scenarios """
+"""base imports for scenarios"""
 
 from .cartesian import CartesianScenario
 from .spherical import SphericalScenario

scenarios/_scenario.py

@@ -1,4 +1,4 @@
-""" Provides base _Scenario base class that every scenario should inherit """
+"""Provides base _Scenario base class that every scenario should inherit"""
 
 from PyMPDATA import Solver
 from PyMPDATA.impl.enumerations import INNER, OUTER

scenarios/cartesian.py

@@ -1,4 +1,4 @@
-""" 2D constant-advector carthesian example """
+"""2D constant-advector carthesian example"""
 
 import numba
 import numpy as np

tests/local/contract_tests/test_single_vs_multi_node.py

@@ -1,4 +1,4 @@
-""" test for asserting equivalence of results from single node environment and multi-node one """
+"""test for asserting equivalence of results from single node environment and multi-node one"""
 
 import os
 import shutil