PySDM 2.64__tar.gz → 2.66__tar.gz

{PySDM-2.64 → PySDM-2.66}/.github/workflows/tests+artifacts+pypi.yml

@@ -48,7 +48,7 @@ jobs:
         pip install -e ./examples
         pip install pytest-cov
         pytest --durations=10 -We tests/unit_tests --cov-report=xml --cov=PySDM
-    - uses: codecov/codecov-action@v4.1.0
+    - uses: codecov/codecov-action@v4.5.0
       with:
         fail_ci_if_error: true
         verbose: true

{PySDM-2.64 → PySDM-2.66}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM
-Version: 2.64
+Version: 2.66
 Summary: Pythonic particle-based (super-droplet) warm-rain/aqueous-chemistry cloud microphysics package with box, parcel & 1D/2D prescribed-flow examples in Python, Julia and Matlab
 Home-page: https://github.com/open-atmos/PySDM
 Author: https://github.com/open-atmos/PySDM/graphs/contributors

{PySDM-2.64 → PySDM-2.66}/PySDM/__init__.py

@@ -24,6 +24,9 @@ PySDM test-suite built using [pytest](https://docs.pytest.org/) is located in th
 
 from importlib.metadata import PackageNotFoundError, version
 
+from PySDM.attributes.impl.attribute_registry import register_attribute
+
+from . import attributes
 from . import environments, exporters, products
 from .builder import Builder
 from .formulae import Formulae

PySDM-2.66/PySDM/attributes/__init__.py

@@ -0,0 +1,9 @@
+"""
+Classes representing super-particle attributes
+"""
+
+from .physics import *
+from .numerics import *
+from .ice import *
+from .chemistry import *
+from .isotopes import *

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/chemistry/acidity.py

@@ -2,11 +2,12 @@
 pH calculated by finding equilibrium hydrogen ion concentration
 """
 
-from PySDM.attributes.impl.intensive_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 from PySDM.backends.impl_numba.methods.chemistry_methods import _conc
 from PySDM.dynamics.impl.chemistry_utils import AQUEOUS_COMPOUNDS
 
 
+@register_attribute(name="pH")
 class Acidity(DerivedAttribute):
     def __init__(self, builder):
         self.conc = {}

PySDM-2.66/PySDM/attributes/chemistry/concentration.py

@@ -0,0 +1,25 @@
+"""
+concentrations (intensive, derived attributes)
+"""
+
+from PySDM.attributes.impl import IntensiveAttribute, register_attribute
+from PySDM.attributes.impl.mole_amount import make_mole_amount_factory
+from PySDM.dynamics.impl.chemistry_utils import AQUEOUS_COMPOUNDS
+
+
+class ConcentrationImpl(IntensiveAttribute):
+    def __init__(self, builder, *, what):
+        super().__init__(builder, name="conc_" + what, base="moles_" + what)
+
+
+def make_concentration_factory(what):
+    def _factory(builder):
+        return ConcentrationImpl(builder, what=what)
+
+    return _factory
+
+
+for compound in AQUEOUS_COMPOUNDS:
+    register_attribute(name=f"conc_{compound}")(make_concentration_factory(compound))
+
+    register_attribute(name=f"moles_{compound}")(make_mole_amount_factory(compound))

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/chemistry/hydrogen_ion_concentration.py

@@ -2,9 +2,10 @@
 hydrogen ion concentration derived from pH
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute(name="conc_H")
 class HydrogenIonConcentration(DerivedAttribute):
     def __init__(self, builder):
         self.acidity = builder.get_attribute("pH")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/ice/cooling_rate.py

@@ -5,10 +5,10 @@ cooling rate estimated as the difference in current and previous grid-cell
 """
 
 import numpy as np
-
-from PySDM.attributes.impl import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute()
 class CoolingRate(DerivedAttribute):
     def __init__(self, builder):
         self.cell_id = builder.get_attribute("cell id")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/ice/freezing_temperature.py

@@ -3,9 +3,10 @@ particle freezing temperature (assigned at initialisation, modified through coll
  used in singular regime)
 """
 
-from PySDM.attributes.impl import MaximumAttribute
+from PySDM.attributes.impl import MaximumAttribute, register_attribute
 
 
+@register_attribute()
 class FreezingTemperature(MaximumAttribute):
     def __init__(self, builder):
         super().__init__(builder, name="freezing temperature")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/ice/immersed_surface_area.py

@@ -3,9 +3,10 @@ immersed INP surface area (assigned at initialisation, modified through collisio
  used in time-dependent regime)
 """
 
-from ..impl import ExtensiveAttribute
+from ..impl import ExtensiveAttribute, register_attribute
 
 
+@register_attribute()
 class ImmersedSurfaceArea(ExtensiveAttribute):
     def __init__(self, particles_builder):
         super().__init__(particles_builder, name="immersed surface area")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/impl/__init__.py

@@ -9,3 +9,5 @@ from .derived_attribute import DerivedAttribute
 from .dummy_attribute import DummyAttribute
 from .extensive_attribute import ExtensiveAttribute
 from .maximum_attribute import MaximumAttribute
+from .attribute_registry import register_attribute, get_attribute_class
+from .intensive_attribute import IntensiveAttribute

PySDM-2.66/PySDM/attributes/impl/attribute_registry.py

@@ -0,0 +1,62 @@
+""" definition of decorator used to register PySDM attribute classes """
+
+import warnings
+
+from PySDM.impl.camel_case import camel_case_to_words
+
+_ATTRIBUTES_REGISTRY = {}
+
+
+def _make_dummy_attribute_factory(name):
+    # pylint: disable=import-outside-toplevel
+    from PySDM.attributes.impl.dummy_attribute import DummyAttribute
+
+    def _factory(builder):
+        return DummyAttribute(builder, name=name)
+
+    return _factory
+
+
+def register_attribute(*, name=None, variant=None, dummy_default=False, warn=False):
+    if variant is not None:
+        assert name is not None
+    if dummy_default:
+        assert variant is not None
+    if warn:
+        assert dummy_default
+
+    def decorator(cls):
+        key = name or camel_case_to_words(cls.__name__)
+
+        if key not in _ATTRIBUTES_REGISTRY:
+            _ATTRIBUTES_REGISTRY[key] = {}
+        elif cls in _ATTRIBUTES_REGISTRY[key]:
+            raise ValueError(f"attribute {key} already exists!")
+        _ATTRIBUTES_REGISTRY[key][cls] = variant or (lambda _, __: cls)
+        if dummy_default:
+            _ATTRIBUTES_REGISTRY[key][_make_dummy_attribute_factory(key)] = (
+                lambda _, __: (
+                    warnings.warn(
+                        f"dummy implementation used for requested attribute named '{name}'"
+                    )
+                    if warn
+                    else None
+                )
+                is None
+                and not variant(_, __)
+            )
+        return cls
+
+    return decorator
+
+
+def get_attribute_class(name, dynamics=None, formulae=None):
+    if name not in _ATTRIBUTES_REGISTRY:
+        raise ValueError(
+            f"Unknown attribute name: {name};"
+            " valid names: {', '.join(sorted(_ATTRIBUTES_REGISTRY))}"
+        )
+    for cls, func in _ATTRIBUTES_REGISTRY[name].items():
+        if func(dynamics, formulae):
+            return cls
+    assert False

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/impl/dummy_attribute.py

@@ -1,8 +1,6 @@
 """ logic around `PySDM.attributes.impl.dummy_attribute.DummyAttribute` - parent class
 for do-nothing attributes """
 
-import warnings
-
 import numpy as np
 
 from .attribute import Attribute
@@ -18,15 +16,3 @@ class DummyAttribute(Attribute):
 
     def get(self):
         return self.data
-
-
-def make_dummy_attribute_factory(name, warn=False):
-    def _factory(builder):
-        return DummyAttribute(builder, name=name)
-
-    if warn:
-        warnings.warn(
-            f"dummy implementation used for requested attribute named '{name}'"
-        )
-
-    return _factory

PySDM-2.66/PySDM/attributes/isotopes/__init__.py

@@ -0,0 +1,6 @@
+"""
+isotopic fractionation related attributes
+"""
+
+from .moles import Moles1H, Moles16O, MolesLightWater
+from ..isotopes import delta

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/isotopes/delta.py

@@ -3,7 +3,8 @@ per-droplet isotopic ratio of heavy-to-light isotope number concentrations
 expressed vs the VSMOW reference in SI units (i.e., not per mille)
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
+from PySDM.dynamics.isotopic_fractionation import HEAVY_ISOTOPES
 
 
 class DeltaImpl(DerivedAttribute):
@@ -43,3 +44,7 @@ def make_delta_factory(what):
         return DeltaImpl(builder, heavy_isotope=what)
 
     return _factory
+
+
+for isotope in HEAVY_ISOTOPES:
+    register_attribute(name=f"delta_{isotope}")(make_delta_factory(isotope))

PySDM-2.64/PySDM/attributes/isotopes/moles_light_isotopes.py → PySDM-2.66/PySDM/attributes/isotopes/moles.py

@@ -21,7 +21,9 @@ derived attributes providing amounts of light isotopes in water (1H and 16O)
         moles_16O =  .5 * (moles_2H + moles_3H) + moles_H2O
 """
 
-from PySDM.attributes.impl import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
+from PySDM.attributes.impl.mole_amount import make_mole_amount_factory
+from PySDM.dynamics.isotopic_fractionation import HEAVY_ISOTOPES
 
 
 class Helper(DerivedAttribute):
@@ -39,6 +41,7 @@ class Helper(DerivedAttribute):
             self.data += (mult, "*", attr.data)
 
 
+@register_attribute()
 class MolesLightWater(Helper):
     def __init__(self, builder):
         const = builder.formulae.constants
@@ -64,6 +67,7 @@ class MolesLightWater(Helper):
         )
 
 
+@register_attribute(name="moles_1H")
 class Moles1H(Helper):
     def __init__(self, builder):
         super().__init__(
@@ -79,6 +83,7 @@ class Moles1H(Helper):
         )
 
 
+@register_attribute(name="moles_16O")
 class Moles16O(Helper):
     def __init__(self, builder):
         super().__init__(
@@ -90,3 +95,7 @@ class Moles16O(Helper):
                 builder.get_attribute("moles light water"): 1.0,
             },
         )
+
+
+for isotope in HEAVY_ISOTOPES:
+    register_attribute(name=f"moles_{isotope}")(make_mole_amount_factory(isotope))

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/numerics/__init__.py

@@ -2,6 +2,6 @@
 attributes used for tracking cell-particle mapping in multi-dimensional simulations
 """
 
-from .cell_id import CellID
+from .cell_id import CellId
 from .cell_origin import CellOrigin
 from .position_in_cell import PositionInCell

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/numerics/cell_id.py

@@ -2,10 +2,11 @@
 grid cell id attribute
 """
 
-from PySDM.attributes.impl.cell_attribute import CellAttribute
+from PySDM.attributes.impl import CellAttribute, register_attribute
 
 
-class CellID(CellAttribute):
+@register_attribute()
+class CellId(CellAttribute):
     def __init__(self, builder):
         super().__init__(builder, name="cell id", dtype=int)
 

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/numerics/cell_origin.py

@@ -2,9 +2,10 @@
 grid-cell origin (multi-dimensional)
 """
 
-from PySDM.attributes.impl.cell_attribute import CellAttribute
+from PySDM.attributes.impl import CellAttribute, register_attribute
 
 
+@register_attribute()
 class CellOrigin(CellAttribute):
     def __init__(self, builder):
         super().__init__(

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/numerics/position_in_cell.py

@@ -2,9 +2,10 @@
 position-within-cell attribute (multi-dimensional, values normalised to one)
 """
 
-from PySDM.attributes.impl.cell_attribute import CellAttribute
+from PySDM.attributes.impl import CellAttribute, register_attribute
 
 
+@register_attribute()
 class PositionInCell(CellAttribute):
     def __init__(self, builder):
         super().__init__(

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/__init__.py

@@ -9,8 +9,9 @@ from .dry_radius import DryRadius
 from .dry_volume import DryVolume
 from .equilibrium_supersaturation import EquilibriumSupersaturation
 from .heat import Heat
-from .mass import WaterMass
-from .multiplicities import Multiplicities
+from .hygroscopicity import Kappa, KappaTimesDryVolume
+from .water_mass import WaterMass
+from .multiplicity import Multiplicity
 from .radius import Radius, SquareRootOfRadius
 from .relative_fall_velocity import RelativeFallMomentum, RelativeFallVelocity
 from .temperature import Temperature

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/area.py

@@ -2,9 +2,10 @@
 particle wet radius (calculated from the volume)
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute()
 class Area(DerivedAttribute):
     def __init__(self, builder):
         self.volume = builder.get_attribute("volume")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/critical_supersaturation.py

@@ -2,9 +2,10 @@
 kappa-Koehler critical supersaturation calculated for actual environment temperature
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute()
 class CriticalSupersaturation(DerivedAttribute):
     def __init__(self, builder):
         self.v_crit = builder.get_attribute("critical volume")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/critical_volume.py

@@ -2,9 +2,10 @@
 critical wet volume (kappa-Koehler, computed using actual temperature)
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute()
 class CriticalVolume(DerivedAttribute):
     def __init__(self, builder):
         self.cell_id = builder.get_attribute("cell id")
@@ -29,6 +30,7 @@ class CriticalVolume(DerivedAttribute):
         )
 
 
+@register_attribute()
 class WetToCriticalVolumeRatio(DerivedAttribute):
     def __init__(self, builder):
         self.critical_volume = builder.get_attribute("critical volume")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/dry_radius.py

@@ -2,9 +2,10 @@
 particle dry radius computed from dry volume
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute()
 class DryRadius(DerivedAttribute):
     def __init__(self, builder):
         self.volume_dry = builder.get_attribute("dry volume")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/dry_volume.py

@@ -2,10 +2,16 @@
 particle dry volume (subject to evolution due to collisions or aqueous chemistry)
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
-from PySDM.attributes.impl.extensive_attribute import ExtensiveAttribute
+from PySDM.attributes.impl import (
+    DerivedAttribute,
+    ExtensiveAttribute,
+    register_attribute,
+)
 
 
+@register_attribute(
+    name="dry volume", variant=lambda dynamics, _: "AqueousChemistry" in dynamics
+)
 class DryVolumeDynamic(DerivedAttribute):
     def __init__(self, builder):
         self.particulator = builder.particulator
@@ -20,16 +26,29 @@ class DryVolumeDynamic(DerivedAttribute):
         self.data *= dynamic.dry_molar_mass / dynamic.dry_rho
 
 
+@register_attribute(
+    name="dry volume", variant=lambda dynamics, _: "AqueousChemistry" not in dynamics
+)
 class DryVolume(ExtensiveAttribute):
     def __init__(self, builder):
         super().__init__(builder, name="dry volume")
 
 
+@register_attribute(
+    name="dry volume organic",
+    variant=lambda _, formulae: formulae.surface_tension.__name__ != "Constant",
+    dummy_default=True,
+)
 class DryVolumeOrganic(ExtensiveAttribute):
     def __init__(self, builder):
         super().__init__(builder, name="dry volume organic")
 
 
+@register_attribute(
+    name="dry volume organic fraction",
+    variant=lambda _, formulae: formulae.surface_tension.__name__ != "Constant",
+    dummy_default=True,
+)
 class OrganicFraction(DerivedAttribute):
     def __init__(self, builder):
         self.volume_dry_org = builder.get_attribute("dry volume organic")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/equilibrium_supersaturation.py

@@ -2,9 +2,10 @@
 kappa-Koehler equilibrium supersaturation calculated for actual environment temperature
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute()
 class EquilibriumSupersaturation(DerivedAttribute):
     def __init__(self, builder):
         self.r_wet = builder.get_attribute("radius")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/heat.py

@@ -2,9 +2,10 @@
 particle heat content (test-use only for now, exemplifying intensive/extensive attribute logic)
 """
 
-from PySDM.attributes.impl.extensive_attribute import ExtensiveAttribute
+from PySDM.attributes.impl import ExtensiveAttribute, register_attribute
 
 
+@register_attribute()
 class Heat(ExtensiveAttribute):
     def __init__(self, builder):
         super().__init__(builder, name="heat")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/hygroscopicity.py

@@ -4,15 +4,16 @@ kappa-Koehler hygroscopicity representation:
  and the derived `PySDM.attributes.physics.hygroscopicity.Kappa` attribute
 """
 
-from ..impl.derived_attribute import DerivedAttribute
-from ..impl.extensive_attribute import ExtensiveAttribute
+from ..impl import DerivedAttribute, ExtensiveAttribute, register_attribute
 
 
+@register_attribute()
 class KappaTimesDryVolume(ExtensiveAttribute):
     def __init__(self, builder):
         super().__init__(builder, name="kappa times dry volume")
 
 
+@register_attribute()
 class Kappa(DerivedAttribute):
     def __init__(self, builder):
         self.kappa_times_dry_volume = builder.get_attribute("kappa times dry volume")

PySDM-2.64/PySDM/attributes/physics/multiplicities.py → PySDM-2.66/PySDM/attributes/physics/multiplicity.py

@@ -4,13 +4,13 @@ super-particle multiplicity (aka weighting factor) - the number of real-world pa
 """
 
 import numpy as np
+from PySDM.attributes.impl import BaseAttribute, register_attribute
 
-from PySDM.attributes.impl.base_attribute import BaseAttribute
 
-
-class Multiplicities(BaseAttribute):
+@register_attribute()
+class Multiplicity(BaseAttribute):
     TYPE = np.int64
     MAX_VALUE = np.iinfo(TYPE).max
 
     def __init__(self, builder):
-        super().__init__(builder, name="multiplicity", dtype=Multiplicities.TYPE)
+        super().__init__(builder, name="multiplicity", dtype=Multiplicity.TYPE)

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/radius.py

@@ -2,9 +2,10 @@
 particle wet radius (calculated from the volume)
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute()
 class Radius(DerivedAttribute):
     def __init__(self, builder):
         self.volume = builder.get_attribute("volume")
@@ -16,6 +17,7 @@ class Radius(DerivedAttribute):
         self.data **= 1 / 3
 
 
+@register_attribute()
 class SquareRootOfRadius(DerivedAttribute):
     def __init__(self, builder):
         self.radius = builder.get_attribute("radius")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/relative_fall_velocity.py

@@ -2,15 +2,30 @@
 Attributes for tracking droplet velocity
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
-from PySDM.attributes.impl.extensive_attribute import ExtensiveAttribute
+from PySDM.attributes.impl import (
+    DerivedAttribute,
+    ExtensiveAttribute,
+    register_attribute,
+)
 
 
+@register_attribute(
+    name="relative fall momentum",
+    variant=lambda dynamics, _: "RelaxedVelocity" in dynamics,
+    dummy_default=True,
+    warn=True,
+    # note: could eventually make an attribute that calculates momentum
+    #       from terminal velocity instead when no RelaxedVelocity dynamic is present
+)
 class RelativeFallMomentum(ExtensiveAttribute):
     def __init__(self, builder):
         super().__init__(builder, name="relative fall momentum", dtype=float)
 
 
+@register_attribute(
+    name="relative fall velocity",
+    variant=lambda dynamics, _: "RelaxedVelocity" in dynamics,
+)
 class RelativeFallVelocity(DerivedAttribute):
     def __init__(self, builder):
         self.momentum = builder.get_attribute("relative fall momentum")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/reynolds_number.py

@@ -2,9 +2,14 @@
 particle Reynolds number
 """
 
-from ..impl.derived_attribute import DerivedAttribute
+from ..impl import DerivedAttribute, register_attribute
 
 
+@register_attribute(
+    name="Reynolds number",
+    variant=lambda _, formulae: formulae.ventilation.__name__ != "Neglect",
+    dummy_default=True,
+)
 class ReynoldsNumber(DerivedAttribute):
     def __init__(self, builder):
         self.radius = builder.get_attribute("radius")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/temperature.py

@@ -2,9 +2,10 @@
 particle temperature (test-use only for now, exemplifying intensive/extensive attribute logic)
 """
 
-from PySDM.attributes.impl.intensive_attribute import IntensiveAttribute
+from PySDM.attributes.impl import IntensiveAttribute, register_attribute
 
 
+@register_attribute()
 class Temperature(IntensiveAttribute):
     def __init__(self, builder):
         super().__init__(builder, base="heat", name="temperature")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/terminal_velocity.py

@@ -2,9 +2,14 @@
 particle terminal velocity (used for collision probability and particle displacement)
 """
 
-from PySDM.attributes.impl.derived_attribute import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute(
+    name="relative fall velocity",
+    variant=lambda dynamics, _: "RelaxedVelocity" not in dynamics,
+)
+@register_attribute()
 class TerminalVelocity(DerivedAttribute):
     def __init__(self, builder):
         self.radius = builder.get_attribute("radius")

{PySDM-2.64 → PySDM-2.66}/PySDM/attributes/physics/volume.py

@@ -4,9 +4,10 @@ in simulation involving mixed-phase clouds, positive values correspond to
 liquid water and negative values to ice
 """
 
-from PySDM.attributes.impl import DerivedAttribute
+from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
+@register_attribute()
 class Volume(DerivedAttribute):
     def __init__(self, builder):
         self.water_mass = builder.get_attribute("water mass")