resolve merge conflict

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ default_stages: [commit]
 
 repos:
   - repo: https://github.com/psf/black
-    rev: 24.1.0
+    rev: 25.1.0
     hooks:
       - id: black
 
@@ -14,7 +14,7 @@ repos:
 #      - id: isort
 
   - 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

PySDM/attributes/impl/attribute_registry.py

@@ -1,4 +1,4 @@
-""" definition of decorator used to register PySDM attribute classes """
+"""definition of decorator used to register PySDM attribute classes"""
 
 import warnings
 

PySDM/attributes/impl/dummy_attribute.py

@@ -1,5 +1,5 @@
-""" logic around `PySDM.attributes.impl.dummy_attribute.DummyAttribute` - parent class
-for do-nothing attributes """
+"""logic around `PySDM.attributes.impl.dummy_attribute.DummyAttribute` - parent class
+for do-nothing attributes"""
 
 import numpy as np
 

PySDM/backends/impl_common/__init__.py

@@ -1 +1 @@
-""" common code for all backends """
+"""common code for all backends"""

PySDM/backends/impl_numba/__init__.py

@@ -1 +1 @@
-""" the guts of the CPU backend """
+"""the guts of the CPU backend"""

PySDM/backends/impl_numba/methods/__init__.py

@@ -1,4 +1,4 @@
-""" method classes of the CPU backend """
+"""method classes of the CPU backend"""
 
 from .chemistry_methods import ChemistryMethods
 from .collisions_methods import CollisionsMethods

PySDM/backends/impl_numba/methods/spawning_methods.py

@@ -1,4 +1,4 @@
-""" CPU implementation of backend methods for particle spawning """
+"""CPU implementation of backend methods for particle spawning"""
 
 from functools import cached_property
 

PySDM/backends/impl_numba/test_helpers/__init__.py

@@ -1 +1 @@
-""" logic intended to be used in tests only including the SciPy-based condensation solver """
+"""logic intended to be used in tests only including the SciPy-based condensation solver"""

PySDM/backends/impl_thrust_rtc/__init__.py

@@ -1 +1 @@
-""" the guts of the GPU backend """
+"""the guts of the GPU backend"""

PySDM/backends/impl_thrust_rtc/methods/__init__.py

@@ -1 +1 @@
-""" method classes of the GPU backend """
+"""method classes of the GPU backend"""

PySDM/dynamics/collisions/coalescence_efficiencies/constEc.py

@@ -1,4 +1,4 @@
-""" constant value """
+"""constant value"""
 
 
 class ConstEc:

PySDM/dynamics/collisions/collision_kernels/impl/__init__.py

@@ -1 +1 @@
-""" common code for implementing collision kernels """
+"""common code for implementing collision kernels"""

PySDM/dynamics/collisions/collision_kernels/impl/gravitational.py

@@ -1,4 +1,4 @@
-""" common parent class for gravitational collision kernels """
+"""common parent class for gravitational collision kernels"""
 
 
 class Gravitational:  # pylint: disable=too-few-public-methods

PySDM/dynamics/collisions/collision_kernels/impl/parameterized.py

@@ -1,4 +1,4 @@
-""" common parent class for collision kernels specified using Berry's parameterization """
+"""common parent class for collision kernels specified using Berry's parameterization"""
 
 from PySDM.physics import constants as const
 

PySDM/dynamics/impl/__init__.py

@@ -1,4 +1,4 @@
-""" stuff not intended to be imported from user code """
+"""stuff not intended to be imported from user code"""
 
 from .register_dynamic import register_dynamic
 from .super_particle_spawning_dynamic import SuperParticleSpawningDynamic

PySDM/dynamics/impl/register_dynamic.py

@@ -1,5 +1,5 @@
-""" decorator for dynamics classes
-ensuring that their instances can be re-used with multiple builders """
+"""decorator for dynamics classes
+ensuring that their instances can be re-used with multiple builders"""
 
 from copy import deepcopy
 

PySDM/dynamics/seeding.py

@@ -1,6 +1,6 @@
-""" particle injection handling, requires initalising a simulation with
+"""particle injection handling, requires initalising a simulation with
 enough particles flagged with NaN multiplicity (translated to zeros
-at multiplicity discretisation """
+at multiplicity discretisation"""
 
 from collections.abc import Sized
 

PySDM/environments/impl/__init__.py

@@ -1,3 +1,3 @@
-""" common internals not intended to be imported from user code """
+"""common internals not intended to be imported from user code"""
 
 from PySDM.environments.impl.register_environment import register_environment

PySDM/environments/impl/register_environment.py

@@ -1,5 +1,5 @@
-""" decorator for environment classes
-ensuring that their instances can be re-used with multiple builders """
+"""decorator for environment classes
+ensuring that their instances can be re-used with multiple builders"""
 
 from copy import deepcopy
 

PySDM/exporters/netcdf_exporter.py

@@ -1,5 +1,5 @@
-""" netCDF exporter implemented using
- [SciPy.io.netcdf_file](https://docs.scipy.org/doc/scipy/reference/tutorial/io.html#netcdf)
+"""netCDF exporter implemented using
+[SciPy.io.netcdf_file](https://docs.scipy.org/doc/scipy/reference/tutorial/io.html#netcdf)
 """
 
 import numpy as np

PySDM/impl/__init__.py

@@ -1 +1 @@
-""" stuff not intended to be used from user code """
+"""stuff not intended to be used from user code"""

PySDM/initialisation/impl/__init__.py

@@ -1,2 +1,2 @@
-""" commons (incl. `PySDM.initialisation.impl.spectrum.Spectrum` base class)
- not intended to be imported from user code """
+"""commons (incl. `PySDM.initialisation.impl.spectrum.Spectrum` base class)
+not intended to be imported from user code"""

PySDM/initialisation/sampling/__init__.py

@@ -1 +1 @@
-""" particle attribute sampling logic """
+"""particle attribute sampling logic"""

PySDM/physics/air_dynamic_viscosity/__init__.py

@@ -1,3 +1,3 @@
-""" air dynamic viscosity formulae """
+"""air dynamic viscosity formulae"""
 
 from .zografos_et_al_1987 import ZografosEtAl1987

PySDM/physics/bulk_phase_partitioning/__init__.py

@@ -1,4 +1,4 @@
-""" phase partitioning formulae for bulk description of cloud water """
+"""phase partitioning formulae for bulk description of cloud water"""
 
 from PySDM.impl.null_physics_class import Null
 from .kaul_et_al_2015 import KaulEtAl2015

PySDM/physics/impl/fake_unit_registry.py

@@ -1,7 +1,7 @@
-""" logic around `PySDM.physics.impl.fake_unit_registry.FakeUnitRegistry` - PySDM mock of Pint's
- [UnitRegistry](https://pint.readthedocs.io/en/stable/developers_reference.html#pint.UnitRegistry),
- with the genuine Pint class used only within unit tests through the
- `PySDM.physics.dimensional_analysis.DimensionalAnalysis` context manager
+"""logic around `PySDM.physics.impl.fake_unit_registry.FakeUnitRegistry` - PySDM mock of Pint's
+[UnitRegistry](https://pint.readthedocs.io/en/stable/developers_reference.html#pint.UnitRegistry),
+with the genuine Pint class used only within unit tests through the
+`PySDM.physics.dimensional_analysis.DimensionalAnalysis` context manager
 """
 
 

PySDM/physics/impl/flag.py

@@ -1,6 +1,6 @@
-""" flag disabling `PySDM.physics.impl.fake_unit_registry.FakeUnitRegistry` within
- `PySDM.physics.dimensional_analysis.DimensionalAnalysis`
- context manager
+"""flag disabling `PySDM.physics.impl.fake_unit_registry.FakeUnitRegistry` within
+`PySDM.physics.dimensional_analysis.DimensionalAnalysis`
+context manager
 """
 
 DIMENSIONAL_ANALYSIS = False

PySDM/physics/isotope_diffusivity_ratios/__init__.py

@@ -1,4 +1,4 @@
-""" heavy-to-light diffusivity ratios for water molecules """
+"""heavy-to-light diffusivity ratios for water molecules"""
 
 from PySDM.impl.null_physics_class import Null
 from .grahams_law import GrahamsLaw

PySDM/physics/isotope_diffusivity_ratios/grahams_law.py

@@ -1,5 +1,5 @@
-""" [Graham's law](https://en.wikipedia.org/wiki/Graham%27s_law)
-    see also eq. (21) in [Horita et al. 2008](https://doi.org/10.1080/10256010801887174)
+"""[Graham's law](https://en.wikipedia.org/wiki/Graham%27s_law)
+see also eq. (21) in [Horita et al. 2008](https://doi.org/10.1080/10256010801887174)
 """
 
 

PySDM/physics/isotope_equilibrium_fractionation_factors/__init__.py

@@ -1,5 +1,5 @@
-""" factors describing partitioning of water isotopologues under thermodynamic
-phase equilibrium, defined as ratios alpha of isotopic ratios R """
+"""factors describing partitioning of water isotopologues under thermodynamic
+phase equilibrium, defined as ratios alpha of isotopic ratios R"""
 
 from PySDM.impl.null_physics_class import Null
 from .barkan_and_luz_2005 import BarkanAndLuz2005

PySDM/physics/isotope_meteoric_water_line/__init__.py

@@ -1,4 +1,4 @@
-""" definitions of meteoric water line parameters
+"""definitions of meteoric water line parameters
 and definitions of the excess quantities"""
 
 from PySDM.impl.null_physics_class import Null

PySDM/physics/isotope_meteoric_water_line/picciotto_et_al_1960.py

@@ -1,7 +1,7 @@
-""" based on [Picciotto et al. 1960](https://doi.org/10.1038/187857a0)
- where delta(2H)= slope_coeff * delta(18O) + intercept_coeff formulae is given
- with swapped 2H and 18O in a paper
- """
+"""based on [Picciotto et al. 1960](https://doi.org/10.1038/187857a0)
+where delta(2H)= slope_coeff * delta(18O) + intercept_coeff formulae is given
+with swapped 2H and 18O in a paper
+"""
 
 
 class PicciottoEtAl1960:  # pylint: disable=too-few-public-methods

PySDM/physics/isotope_ratio_evolution/__init__.py

@@ -1,4 +1,4 @@
-""" isotope-ratio evolution formulae (incl. Rayleigh distillation) """
+"""isotope-ratio evolution formulae (incl. Rayleigh distillation)"""
 
 from PySDM.impl.null_physics_class import Null
 from .merlivat_and_jouzel_1979 import MerlivatAndJouzel1979

PySDM/physics/isotope_ratio_evolution/rayleigh_distillation.py

@@ -1,4 +1,4 @@
-""" Fractional distillation assuming continuous removal under equilibrium """
+"""Fractional distillation assuming continuous removal under equilibrium"""
 
 
 class RayleighDistillation:  # pylint:disable=too-few-public-methods

PySDM/physics/isotope_relaxation_timescale/bolin_1958.py

@@ -1,5 +1,5 @@
-""" Timescale derived for tritium with assumption of zero ambient concentration - see text above
-    Table 1 [Bolin 1958](https://digitallibrary.un.org/record/3892725) """
+"""Timescale derived for tritium with assumption of zero ambient concentration - see text above
+Table 1 [Bolin 1958](https://digitallibrary.un.org/record/3892725)"""
 
 import numpy as np
 

PySDM/physics/isotope_relaxation_timescale/miyake_et_al_1968.py

@@ -1,4 +1,4 @@
-""" eq. 28 in [Miyake et al. 1968](https://doi.org/10.2467/mripapers1950.19.2_243) """
+"""eq. 28 in [Miyake et al. 1968](https://doi.org/10.2467/mripapers1950.19.2_243)"""
 
 
 class MiyakeEtAl1968:  # pylint: disable=too-few-public-methods

PySDM/physics/isotope_temperature_inference/picciotto_et_al_1960.py

@@ -1,5 +1,5 @@
-""" based on [Picciotto et al. 1960](https://doi.org/10.1038/187857a0)
- where delta(T)=-(a*T + b) formulae given, here cast as T(delta)=(-delta-b)/a """
+"""based on [Picciotto et al. 1960](https://doi.org/10.1038/187857a0)
+where delta(T)=-(a*T + b) formulae given, here cast as T(delta)=(-delta-b)/a"""
 
 
 class PicciottoEtAl1960:  # pylint: disable=too-few-public-methods

PySDM/physics/terminal_velocity/__init__.py

@@ -1,4 +1,4 @@
-""" terminal velocity formulae """
+"""terminal velocity formulae"""
 
 from .rogers_yau import RogersYau
 from .gunn_kinzer_1949 import GunnKinzer1949

PySDM/physics/terminal_velocity/gunn_kinzer_1949.py

@@ -1,4 +1,4 @@
-""" [Gunn & Kinzer 1949](https://doi.org/10.1175/1520-0469(1949)006%3C0243:TTVOFF%3E2.0.CO;2) """
+"""[Gunn & Kinzer 1949](https://doi.org/10.1175/1520-0469(1949)006%3C0243:TTVOFF%3E2.0.CO;2)"""
 
 
 class GunnKinzer1949:  # pylint: disable=too-few-public-methods

PySDM/physics/terminal_velocity/power_series.py

@@ -1,4 +1,4 @@
-""" power-series formulation """
+"""power-series formulation"""
 
 
 class PowerSeries:  # pylint: disable=too-few-public-methods

PySDM/products/impl/__init__.py

@@ -1,4 +1,4 @@
-""" commons, not intended to be imported from user code """
+"""commons, not intended to be imported from user code"""
 
 from PySDM.products.impl.moist_environment_product import MoistEnvironmentProduct
 from PySDM.products.impl.moment_product import MomentProduct

PySDM/products/impl/moment_product.py

@@ -1,4 +1,4 @@
-""" common code for products computing statistical moments (e.g., effective radius, acidity) """
+"""common code for products computing statistical moments (e.g., effective radius, acidity)"""
 
 from abc import ABC
 

PySDM/products/impl/register_product.py

@@ -1,5 +1,5 @@
-""" decorator for product classes
-ensuring that their instances can be re-used with multiple builders """
+"""decorator for product classes
+ensuring that their instances can be re-used with multiple builders"""
 
 from copy import deepcopy
 

PySDM/products/optical/__init__.py

@@ -1,4 +1,4 @@
-""" cloud optical properties """
+"""cloud optical properties"""
 
 from .cloud_optical_depth import CloudOpticalDepth
 from .cloud_albedo import CloudAlbedo

PySDM/products/parcel/__init__.py

@@ -1,4 +1,4 @@
-""" products specific to the parcel environment """
+"""products specific to the parcel environment"""
 
 from .cloud_water_path import ParcelLiquidWaterPath
 from .parcel_displacement import ParcelDisplacement

PySDM/products/size_spectral/__init__.py

@@ -1,4 +1,4 @@
-""" products expressing particle size-spectral quantities """
+"""products expressing particle size-spectral quantities"""
 
 from .arbitrary_moment import (
     RadiusFirstMoment,

examples/PySDM_examples/Arabas_et_al_2023/commons.py

@@ -1,4 +1,4 @@
-""" ABIFM and INAS parameters and other constants """
+"""ABIFM and INAS parameters and other constants"""
 
 from PySDM import Formulae
 from PySDM.physics import si

examples/PySDM_examples/Pierchala_et_al_2022/commons.py

@@ -1,5 +1,5 @@
-""" common data for use in the
-  [Pierchala et al. 2022](https://doi.org/10.1016/j.gca.2022.01.020) example
+"""common data for use in the
+[Pierchala et al. 2022](https://doi.org/10.1016/j.gca.2022.01.020) example
 """
 
 from PySDM.physics import constants_defaults as const

tests/smoke_tests/box/dejong_azimi/test_box.py

@@ -1,4 +1,4 @@
-""" regression tests asserting on values from the plots """
+"""regression tests asserting on values from the plots"""
 
 from pathlib import Path
 

tests/smoke_tests/box/partmc/test_dry_wet_equilibration.py

@@ -1,5 +1,5 @@
-""" comparing kappa-Koehler wet radius equilibration in PySDM and PartMC
-  (based on PyPartMC-examples notebook by Zach D'Aquino) """
+"""comparing kappa-Koehler wet radius equilibration in PySDM and PartMC
+(based on PyPartMC-examples notebook by Zach D'Aquino)"""
 
 # pylint: disable=missing-function-docstring,no-member
 import platform

tests/smoke_tests/conftest.py

@@ -1,4 +1,4 @@
-""" borrowing everything from unit_tests (this cannot be one level up due to devops_tests) """
+"""borrowing everything from unit_tests (this cannot be one level up due to devops_tests)"""
 
 import pytest
 

tests/smoke_tests/no_env/pierchala_et_al_2022/test_supplement.py

@@ -1,4 +1,4 @@
-""" tests for consistency of values taken from the Supplement """
+"""tests for consistency of values taken from the Supplement"""
 
 import numpy as np
 from PySDM_examples.Pierchala_et_al_2022.commons import deltas_0_SMOW

tests/smoke_tests/parcel_a/lowe_et_al_2019/test_dz_sensitivity.py

@@ -1,4 +1,4 @@
-""" checks how parcel equilibrium supersaturation depends on dz """
+"""checks how parcel equilibrium supersaturation depends on dz"""
 
 import numpy as np
 from matplotlib import pyplot

tests/smoke_tests/parcel_a/lowe_et_al_2019/test_fig_s2.py

@@ -1,7 +1,7 @@
 """
-    test for supplementary figure 2 in Lowe et al 2019 paper.
-    checks that values from panels d)-f) are in a reasonable range
-    and decrease/increase monotonically with updraft velocity
+test for supplementary figure 2 in Lowe et al 2019 paper.
+checks that values from panels d)-f) are in a reasonable range
+and decrease/increase monotonically with updraft velocity
 """
 
 import os

tests/smoke_tests/parcel_c/graf_et_al_2019/test_fig_4.py

@@ -1,4 +1,4 @@
-""" tests ensuring values on plots match those in the paper """
+"""tests ensuring values on plots match those in the paper"""
 
 from pathlib import Path
 

tests/smoke_tests/parcel_c/graf_et_al_2019/test_table_1.py

@@ -1,4 +1,4 @@
-""" tests ensuring values on plots match those in the paper """
+"""tests ensuring values on plots match those in the paper"""
 
 from pathlib import Path
 

tests/smoke_tests/parcel_d/rozanski_and_sonntag_1982/test_figs_4_5_6.py

@@ -1,4 +1,4 @@
-""" tests ensuring values on plots match those in the paper """
+"""tests ensuring values on plots match those in the paper"""
 
 from pathlib import Path
 

tests/smoke_tests/parcel_d/seeding/test_hello_world.py

@@ -1,4 +1,4 @@
-""" tests ensuring values on plots match those in the paper """
+"""tests ensuring values on plots match those in the paper"""
 
 from pathlib import Path
 

tests/smoke_tests/parcel_d/seeding/test_seeding_no_collisions.py

@@ -1,4 +1,4 @@
-""" tests ensuring values on plots match those in the paper """
+"""tests ensuring values on plots match those in the paper"""
 
 from pathlib import Path
 

tests/unit_tests/attributes/test_impl_attribute_registry.py

@@ -1,6 +1,6 @@
-""" checks the attribute registry logic mapping attribute names to classes implementing them
- and handling different variants of these implementations picked depending on the choice of
- dynamics and formulae options """
+"""checks the attribute registry logic mapping attribute names to classes implementing them
+and handling different variants of these implementations picked depending on the choice of
+dynamics and formulae options"""
 
 import pytest