acoular 25.10__py3-none-any.whl → 26.1__py3-none-any.whl

acoular/tprocess.py

@@ -105,17 +105,17 @@ class MaskedTimeOut(TimeOut):
     source = Instance(SamplesGenerator)
 
     #: The index of the first valid sample. Default is ``0``.
-    start = CInt(0, desc='start of valid samples')
+    start = CInt(0)
 
     #: The index of the last valid sample (exclusive).
     #: If set to :obj:`None`, the selection continues until the end of the available data.
-    stop = Union(None, CInt, desc='stop of valid samples')
+    stop = Union(None, CInt)
 
     #: List of channel indices to be excluded from processing.
-    invalid_channels = List(int, desc='list of invalid channels')
+    invalid_channels = List(int)
 
     #: A mask or index array representing valid channels. (automatically updated)
-    channels = Property(depends_on=['invalid_channels', 'source.num_channels'], desc='channel mask')
+    channels = Property(depends_on=['invalid_channels', 'source.num_channels'])
 
     #: Total number of input channels, including invalid channels, as given by
     #: :attr:`~acoular.base.TimeOut.source`. (read-only).
@@ -125,19 +125,15 @@ class MaskedTimeOut(TimeOut):
     num_samples_total = Delegate('source', 'num_samples')
 
     #: Number of valid input channels after excluding :attr:`invalid_channels`. (read-only)
-    num_channels = Property(
-        depends_on=['invalid_channels', 'source.num_channels'], desc='number of valid input channels'
-    )
+    num_channels = Property(depends_on=['invalid_channels', 'source.num_channels'])
 
     #: Number of valid time-domain samples, based on :attr:`start` and :attr:`stop` indices.
     #: (read-only)
-    num_samples = Property(
-        depends_on=['start', 'stop', 'source.num_samples'], desc='number of valid samples per channel'
-    )
+    num_samples = Property(depends_on=['start', 'stop', 'source.num_samples'])
 
     #: The name of the cache file (without extension). It serves as an internal reference for data
     #: caching and tracking processed files. (automatically generated)
-    basename = Property(depends_on=['source.digest'], desc='basename for cache file')
+    basename = Property(depends_on=['source.digest'])
 
     #: A unique identifier for the object, based on its properties. (read-only)
     digest = Property(depends_on=['source.digest', 'start', 'stop', 'invalid_channels'])
@@ -274,7 +270,7 @@ class ChannelMixer(TimeOut):
     #: If not explicitly set, all channels are weighted equally (delault is ``1``).
     #: The shape of :attr:`weights` must match the :attr:`number of input channels<num_channels>`.
     #: If an incompatible shape is provided, a :obj:`ValueError` will be raised.
-    weights = CArray(desc='channel weights')
+    weights = CArray()
 
     #: The number of output channels, which is always ``1`` for this class since it produces a
     #: single mixed output. (read-only)
@@ -589,7 +585,7 @@ class AngleTracker(MaskedTimeOut):
 
     #: Number of trigger signals per revolution. This allows tracking scenarios where multiple
     #: trigger pulses occur per rotation. Default is ``1``, meaning a single trigger per revolution.
-    trigger_per_revo = Int(1, desc='trigger signals per revolution')
+    trigger_per_revo = Int(1)
 
     #: Rotation direction flag:
     #:
@@ -597,26 +593,26 @@ class AngleTracker(MaskedTimeOut):
     #: - ``-1``: clockwise rotation.
     #:
     #: Default is ``-1``.
-    rot_direction = Int(-1, desc='mathematical direction of rotation')
+    rot_direction = Int(-1)
 
     #: Number of points used for spline interpolation. Default is ``4``.
-    interp_points = Int(4, desc='Points of interpolation used for spline')
+    interp_points = Int(4)
 
     #: Initial rotation angle (in radians) corresponding to the first trigger event. This allows
     #: defining a custom starting reference angle. Default is ``0``.
-    start_angle = Float(0, desc='rotation angle for trigger position')
+    start_angle = Float(0)
 
     #: Revolutions per minute (RPM) computed for each sample.
     #: It is based on the trigger data. (read-only)
-    rpm = Property(depends_on=['digest'], desc='revolutions per minute for each sample')
+    rpm = Property(depends_on=['digest'])
 
     #: Average revolutions per minute over the entire dataset.
     #: It is computed based on the trigger intervals. (read-only)
-    average_rpm = Property(depends_on=['digest'], desc='average revolutions per minute')
+    average_rpm = Property(depends_on=['digest'])
 
     #: Computed rotation angle (in radians) for each sample.
     #: It is interpolated from the trigger data. (read-only)
-    angle = Property(depends_on=['digest'], desc='rotation angle for each sample')
+    angle = Property(depends_on=['digest'])
 
     # Internal flag to determine whether rpm and angle calculation has been processed,
     # prevents recalculation
@@ -741,14 +737,15 @@ class SpatialInterpolator(TimeOut):  # pragma: no cover
 
     #: The physical microphone geometry. An instance of :class:`~acoular.microphones.MicGeom` that
     #: defines the positions of the real microphones used for measurement.
-    mics = Instance(MicGeom(), desc='microphone geometry')
+    mics = Instance(MicGeom())
 
     #: The virtual microphone geometry. This property defines the positions
     #: of virtual microphones where interpolated pressure values are computed.
     #: Default is the physical microphone geometry (:attr:`mics`).
-    mics_virtual = Property(desc='microphone geometry')
+    mics_virtual = Property()
 
-    _mics_virtual = Instance(MicGeom, desc='internal microphone geometry;internal usage, read only')
+    #: internal microphone geometry;internal usage, read only
+    _mics_virtual = Instance(MicGeom)
 
     def _get_mics_virtual(self):
         if not self._mics_virtual and self.mics:
@@ -778,7 +775,6 @@ class SpatialInterpolator(TimeOut):  # pragma: no cover
         'IDW',
         'custom',
         'sinc',
-        desc='method for interpolation used',
     )
 
     #: Defines the spatial dimensionality of the microphone array.
@@ -790,7 +786,7 @@ class SpatialInterpolator(TimeOut):  # pragma: no cover
     #: - ``'ring'``: Circular arrays where rotation needs to be considered.
     #: - ``'3D'``: Three-dimensional microphone distributions.
     #: - ``'custom'``: User-defined microphone arrangements.
-    array_dimension = Enum('1D', '2D', 'ring', '3D', 'custom', desc='spatial dimensionality of the array geometry')
+    array_dimension = Enum('1D', '2D', 'ring', '3D', 'custom')
 
     #: Sampling frequency of the output signal, inherited from the :attr:`source`. This defines the
     #: rate at which microphone pressure samples are acquired and processed.
@@ -825,14 +821,11 @@ class SpatialInterpolator(TimeOut):  # pragma: no cover
     #: Number of neighboring microphones used in IDW interpolation. This parameter determines how
     #: many physical microphones contribute to the weighted sum in inverse distance weighting (IDW)
     #: interpolation.
-    num_IDW = Int(3, desc='number of neighboring microphones, DEFAULT=3')  # noqa: N815
+    num_IDW = Int(3)  # noqa: N815
 
     #: Weighting exponent for IDW interpolation. This parameter controls the influence of distance
     #: in inverse distance weighting (IDW). A higher value gives more weight to closer microphones.
-    p_weight = Float(
-        2,
-        desc='used in interpolation for virtual microphone, weighting power exponent for IDW',
-    )
+    p_weight = Float(2)
 
     # Stores the output of :meth:`_virtNewCoord_func`; Read-Only
     _virtNewCoord_func = Property(  # noqa: N815
@@ -861,7 +854,7 @@ class SpatialInterpolator(TimeOut):  # pragma: no cover
 
     @cached_property
     def _get_virtNewCoord(self):  # noqa N802
-        return self._virtNewCoord_func(self.mics.mpos, self.mics_virtual.mpos, self.method, self.array_dimension)
+        return self._virtNewCoord_func(self.mics.pos, self.mics_virtual.pos, self.method, self.array_dimension)
 
     def sinc_mic(self, r):
         """
@@ -1054,7 +1047,7 @@ class SpatialInterpolator(TimeOut):  # pragma: no cover
         # number of time samples
         nTime = p.shape[0]
         # number of virtual mixcs
-        nVirtMics = self.mics_virtual.mpos.shape[1]
+        nVirtMics = self.mics_virtual.pos.shape[1]
         # mesh and projection onto polar Coordinates
         meshList, virtNewCoord, newCoord = self._get_virtNewCoord()
         # pressure interpolation init
@@ -1359,7 +1352,7 @@ class SpatialInterpolatorRotation(SpatialInterpolator):  # pragma: no cover
         # period for rotation
         period = 2 * np.pi
         # get angle
-        angle = self.angle_source.angle()
+        angle = self.angle_source.angle
         # counter to track angle position in time for each block
         count = 0
         for timeData in self.source.result(num):
@@ -1797,7 +1790,7 @@ class FiltOctave(Filter):
     """
 
     #: The center frequency of the octave or third-octave band. Default is ``1000``.
-    band = Float(1000.0, desc='band center frequency')
+    band = Float(1000.0)
 
     #: Defines whether the filter is an octave-band or third-octave-band filter.
     #:
@@ -1805,11 +1798,11 @@ class FiltOctave(Filter):
     #: - ``'Third octave'``: Third-octave band filter.
     #:
     #: Default is ``'Octave'``.
-    fraction = Map({'Octave': 1, 'Third octave': 3}, default_value='Octave', desc='fraction of octave')
+    fraction = Map({'Octave': 1, 'Third octave': 3}, default_value='Octave')
 
     #: The order of the IIR filter, which affects the steepness of the filter's roll-off.
     #: Default is ``3``.
-    order = Int(3, desc='IIR filter order')
+    order = Int(3)
 
     #: Second-order sections representation of the filter coefficients. This property depends on
     #: :attr:`band`, :attr:`fraction`, :attr:`order`, and the source's digest.
@@ -1884,7 +1877,7 @@ class FiltFiltOctave(FiltOctave):
 
     #: The half-order of the IIR filter, applied twice (once forward and once backward). This
     #: results in a final filter order twice as large as the specified value. Default is ``2``.
-    order = Int(2, desc='IIR filter half order')
+    order = Int(2)
 
     #: A unique identifier for the filter, based on its properties. (read-only)
     digest = Property(depends_on=['source.digest', 'band', 'fraction', 'order'])
@@ -1999,7 +1992,7 @@ class TimeExpAverage(Filter):
     #: - ``'I'`` (Impulse) → 0.035 (non-standard)
     #:
     #: Default is ``'F'``.
-    weight = Map({'F': 0.125, 'S': 1.0, 'I': 0.035}, default_value='F', desc='time weighting')
+    weight = Map({'F': 0.125, 'S': 1.0, 'I': 0.035}, default_value='F')
 
     #: Filter coefficients in second-order section (SOS) format.
     sos = Property(depends_on=['weight', 'source.digest'])
@@ -2072,7 +2065,7 @@ class FiltFreqWeight(Filter):
     #: - ``'Z'``: A flat response with no frequency weighting.
     #:
     #: Default is ``'A'``.
-    weight = Enum('A', 'C', 'Z', desc='frequency weighting')
+    weight = Enum('A', 'C', 'Z')
 
     #: Second-order sections (SOS) representation of the filter coefficients. This property is
     #: dynamically computed based on :attr:`weight` and the :attr:`Filter.source`'s digest.
@@ -2256,17 +2249,17 @@ class OctaveFilterBank(FilterBank):
 
     #: The lowest band center frequency index. Default is ``21``.
     #: This index refers to the position in the scale of octave or third-octave bands.
-    lband = Int(21, desc='lowest band center frequency index')
+    lband = Int(21)
 
     #: The highest band center frequency index + 1. Default is ``40``.
     #: This is the position in the scale of octave or third-octave bands.
-    hband = Int(40, desc='highest band center frequency index + 1')
+    hband = Int(40)
 
     #: The fraction of an octave, either ``'Octave'`` or ``'Third octave'``.
     #: Default is ``'Octave'``.
     #: Determines the width of the frequency bands. 'Octave' refers to full octaves,
     #: and ``'Third octave'`` refers to third-octave bands.
-    fraction = Map({'Octave': 1, 'Third octave': 3}, default_value='Octave', desc='fraction of octave')
+    fraction = Map({'Octave': 1, 'Third octave': 3}, default_value='Octave')
 
     #: The list of filter coefficients for all filters in the filter bank.
     #: The coefficients are computed based on the :attr:`lband`, :attr:`hband`,
@@ -2339,20 +2332,22 @@ class WriteWAV(TimeOut):
 
     #: The name of the file to be saved. If none is given, the name will be automatically
     #: generated from the source.
-    file = File(filter=['*.wav'], desc='name of wave file')
+    file = File(filter=['*.wav'])
 
     #: The name of the cache file (without extension). It serves as an internal reference for data
     #: caching and tracking processed files. (automatically generated)
     basename = Property(depends_on=['digest'])
 
     #: The list of channels to save. Can only contain one or two channels.
-    channels = List(int, desc='channels to save')
+    channels = List(int)
 
     # Bit depth of the output file.
-    encoding = Enum('uint8', 'int16', 'int32', desc='bit depth of the output file')
+    #: bit depth of the output file
+    encoding = Enum('uint8', 'int16', 'int32')
 
     # Maximum value to scale the output to. If `None`, the maximum value of the data is used.
-    max_val = Either(None, Float, desc='Maximum value to scale the output to.')
+    #: Maximum value to scale the output to.
+    max_val = Either(None, Float)
 
     #: A unique identifier for the filter, based on its properties. (read-only)
     digest = Property(depends_on=['source.digest', 'channels'])
@@ -2519,7 +2514,7 @@ class WriteH5(TimeOut):
 
     #: The name of the file to be saved. If none is given, the name is automatically
     #: generated based on the current timestamp.
-    file = File(filter=['*.h5'], desc='name of data file')
+    file = File(filter=['*.h5'])
 
     #: The number of samples to write to file per call to `result` method.
     #: Default is ``-1``, meaning all available data from the source will be written.
@@ -2533,10 +2528,10 @@ class WriteH5(TimeOut):
 
     #: Precision of the entries in the HDF5 file, represented as numpy data types.
     #: Default is ``'float32'``.
-    precision = Enum('float32', 'float64', desc='precision of H5 File')
+    precision = Enum('float32', 'float64')
 
     #: Metadata to be stored in the HDF5 file.
-    metadata = Dict(desc='metadata to be stored in .h5 file')
+    metadata = Dict()
 
     @cached_property
     def _get_digest(self):
@@ -2692,22 +2687,34 @@ class TimeConvolve(TimeOut):
 
     #: Convolution kernel in the time domain.
     #: The second dimension of the kernel array has to be either ``1`` or match
-    #: the :attr:`source`'s :attr:`~acoular.base.SamplesGenerator.num_channels` attribute.
+    #: the :attr:`source`'s :attr:`~acoular.base.Generator.num_channels` attribute.
     #: If only a single kernel is supplied, it is applied to all channels.
-    kernel = CArray(dtype=float, desc='Convolution kernel.')
+    kernel = CArray(dtype=float)
+
+    #: Controls whether to extend the output to include the full convolution result.
+    #:
+    #: - If ``False`` (default): Output length is :math:`\\max(L, M)`, where :math:`L` is the
+    #:   kernel length and :math:`M` is the signal length. This mode keeps the output length
+    #:   equal to the longest input (different from NumPy's ``mode='same'``, since it does not
+    #:   pad the output).
+    #: - If ``True``: Output length is :math:`L + M - 1`, returning the full convolution at
+    #:   each overlap point (similar to NumPy's ``mode='full'``).
+    #:
+    #: Default is ``False``.
+    extend_signal = Bool(False)
 
     # Internal block size for partitioning signals into smaller segments during processing.
-    _block_size = Int(desc='Block size')
+    #: Block size
+    _block_size = Int()
 
     # Blocks of the convolution kernel in the frequency domain.
     # Computed using Fast Fourier Transform (FFT).
     _kernel_blocks = Property(
         depends_on=['kernel', '_block_size'],
-        desc='Frequency domain Kernel blocks',
     )
 
     #: A unique identifier for the object, based on its properties. (read-only)
-    digest = Property(depends_on=['source.digest', 'kernel'])
+    digest = Property(depends_on=['source.digest', 'kernel', 'extend_signal'])
 
     @cached_property
     def _get_digest(self):
@@ -2765,12 +2772,12 @@ class TimeConvolve(TimeOut):
         return blocks
 
     def result(self, num=128):
-        """
+        r"""
         Convolve the source signal with the kernel and yield the result in blocks.
 
-        The method generates the convolution of the source signal with the kernel by processing the
-        signal in small blocks, performing the convolution in the frequency domain, and yielding the
-        results block by block.
+        The method generates the convolution of the source signal (length :math:`M`) with the kernel
+        (length :math:`L`) by processing the signal in small blocks, performing the convolution in
+        the frequency domain, and yielding the results block by block.
 
         Parameters
         ----------
@@ -2781,14 +2788,15 @@ class TimeConvolve(TimeOut):
         Yields
         ------
         :obj:`numpy.ndarray`
-            A array of shape (``num``, :attr:`~acoular.base.SamplesGenerator.num_channels`),
-            where :attr:`~acoular.base.SamplesGenerator.num_channels` is inhereted from the
+            An array of shape (``num``, :attr:`~acoular.base.Generator.num_channels`),
+            where :attr:`~acoular.base.Generator.num_channels` is inherited from the
             :attr:`source`, representing the convolution result in blocks.
 
         Notes
         -----
         - The kernel is first validated and reshaped if necessary.
         - The convolution is computed efficiently using the FFT in the frequency domain.
+        - The output length is determined by the :attr:`extend_signal` property.
         """
         self._validate_kernel()
         # initialize variables
@@ -2796,10 +2804,13 @@ class TimeConvolve(TimeOut):
         L = self.kernel.shape[0]
         N = self.source.num_channels
         M = self.source.num_samples
+
+        output_size = max(L, M) if not self.extend_signal else L + M - 1
+
         numblocks_kernel = int(np.ceil(L / num))  # number of kernel blocks
         Q = int(np.ceil(M / num))  # number of signal blocks
-        R = int(np.ceil((L + M - 1) / num))  # number of output blocks
-        last_size = (L + M - 1) % num  # size of final block
+        R = int(np.ceil(output_size / num))  # number of output blocks
+        last_size = output_size % num  # size of final output block
 
         idx = 0
         fdl = np.zeros([numblocks_kernel, num + 1, N], dtype='complex128')
@@ -2815,7 +2826,8 @@ class TimeConvolve(TimeOut):
             _append_to_fdl(fdl, idx, numblocks_kernel, rfft(buff, axis=0))
             spec_sum = _spectral_sum(spec_sum, fdl, self._kernel_blocks)
             # truncate s.t. total length is L+M-1 (like numpy convolve w/ mode="full")
-            yield irfft(spec_sum, axis=0)[num : last_size + num]
+            final_len = last_size if last_size != 0 else num
+            yield irfft(spec_sum, axis=0)[num : final_len + num]
             return
 
         # stream processing of source signal
@@ -2841,7 +2853,8 @@ class TimeConvolve(TimeOut):
         _append_to_fdl(fdl, idx, numblocks_kernel, rfft(buff, axis=0))
         spec_sum = _spectral_sum(spec_sum, fdl, self._kernel_blocks)
         # truncate s.t. total length is L+M-1 (like numpy convolve w/ mode="full")
-        yield irfft(spec_sum, axis=0)[num : last_size + num]
+        final_len = last_size if last_size != 0 else num
+        yield irfft(spec_sum, axis=0)[num : final_len + num]
 
 
 @nb.jit(nopython=True, cache=True)

acoular/trajectory.py

@@ -81,7 +81,6 @@ class Trajectory(HasStrictTraits):
     points = Dict(
         key_trait=Float,
         value_trait=Tuple(Float, Float, Float),
-        desc='sampled positions along the trajectory',
     )
 
     #: Automatically determined tuple ``(t_min, t_max)`` representing the start and end times of the
@@ -194,4 +193,4 @@ class Trajectory(HasStrictTraits):
             t_end = self.interval[1]
         # all locations are fetched in one go because that is much faster further improvement could
         # be possible if interpolated locations are fetched in blocks
-        yield from zip(*self.location(np.arange(t_start, t_end, delta_t), der))
+        yield from zip(*self.location(np.arange(t_start, t_end, delta_t), der), strict=True)

acoular/version.py

@@ -5,5 +5,5 @@
 """Dedicated file to determine the package version without importing acoular."""
 
 __author__ = 'Acoular Development Team'
-__date__ = '23 October 2025'
-__version__ = '25.10'
+__date__ = '28 January 2026'
+__version__ = '26.01'

{acoular-25.10.dist-info → acoular-26.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acoular
-Version: 25.10
+Version: 26.1
 Summary: Python library for acoustic beamforming
 Project-URL: homepage, https://acoular.org
 Project-URL: documentation, https://acoular.org
@@ -51,65 +51,14 @@ Requires-Python: <3.14,>=3.10
 Requires-Dist: numba
 Requires-Dist: numpy
 Requires-Dist: scikit-learn
-Requires-Dist: scipy!=1.16.*,>=1.1.0
+Requires-Dist: scipy!=1.16.0,>=1.15; python_version == '3.10'
+Requires-Dist: scipy>=1.16.1; python_version > '3.10'
 Requires-Dist: tables
 Requires-Dist: traits>=6.0
-Provides-Extra: dev
-Requires-Dist: graphviz; extra == 'dev'
-Requires-Dist: h5py; extra == 'dev'
-Requires-Dist: hatch; extra == 'dev'
-Requires-Dist: ipython; extra == 'dev'
-Requires-Dist: matplotlib; extra == 'dev'
-Requires-Dist: numpydoc; extra == 'dev'
-Requires-Dist: pickleshare; extra == 'dev'
-Requires-Dist: pydata-sphinx-theme; extra == 'dev'
-Requires-Dist: pylops; extra == 'dev'
-Requires-Dist: pytest; extra == 'dev'
-Requires-Dist: pytest-cases; extra == 'dev'
-Requires-Dist: pytest-cov; extra == 'dev'
-Requires-Dist: pytest-env; extra == 'dev'
-Requires-Dist: pytest-mock; extra == 'dev'
-Requires-Dist: pytest-profiling; extra == 'dev'
-Requires-Dist: pytest-regtest; extra == 'dev'
-Requires-Dist: pyyaml; extra == 'dev'
-Requires-Dist: ruff==0.8.1; extra == 'dev'
-Requires-Dist: setuptools; extra == 'dev'
-Requires-Dist: sounddevice; extra == 'dev'
-Requires-Dist: sphinx; extra == 'dev'
-Requires-Dist: sphinx-copybutton; extra == 'dev'
-Requires-Dist: sphinx-gallery; extra == 'dev'
-Requires-Dist: sphinxcontrib-bibtex; extra == 'dev'
-Requires-Dist: traitsui; extra == 'dev'
-Provides-Extra: docs
-Requires-Dist: graphviz; extra == 'docs'
-Requires-Dist: ipython; extra == 'docs'
-Requires-Dist: matplotlib; extra == 'docs'
-Requires-Dist: numpydoc; extra == 'docs'
-Requires-Dist: pickleshare; extra == 'docs'
-Requires-Dist: pydata-sphinx-theme; extra == 'docs'
-Requires-Dist: setuptools; extra == 'docs'
-Requires-Dist: sounddevice; extra == 'docs'
-Requires-Dist: sphinx; extra == 'docs'
-Requires-Dist: sphinx-copybutton; extra == 'docs'
-Requires-Dist: sphinx-gallery; extra == 'docs'
-Requires-Dist: sphinxcontrib-bibtex; extra == 'docs'
 Provides-Extra: full
 Requires-Dist: matplotlib; extra == 'full'
 Requires-Dist: pylops; extra == 'full'
 Requires-Dist: sounddevice; extra == 'full'
-Provides-Extra: tests
-Requires-Dist: h5py; extra == 'tests'
-Requires-Dist: pylops; extra == 'tests'
-Requires-Dist: pytest; extra == 'tests'
-Requires-Dist: pytest-cases; extra == 'tests'
-Requires-Dist: pytest-cov; extra == 'tests'
-Requires-Dist: pytest-env; extra == 'tests'
-Requires-Dist: pytest-mock; extra == 'tests'
-Requires-Dist: pytest-profiling; extra == 'tests'
-Requires-Dist: pytest-regtest; extra == 'tests'
-Requires-Dist: pyyaml; extra == 'tests'
-Requires-Dist: sounddevice; extra == 'tests'
-Requires-Dist: traitsui; extra == 'tests'
 Description-Content-Type: text/markdown
 
 ![Acoular Logo](https://github.com/acoular/acoular/blob/master/docs/source/_static/Acoular_logo.png?raw=true)
@@ -117,45 +66,57 @@ Description-Content-Type: text/markdown
 [![PyPI](https://img.shields.io/pypi/pyversions/acoular.svg)](https://pypi.org/project/acoular)
 [![PyPI](https://img.shields.io/pypi/v/acoular.svg)](https://pypi.org/project/acoular)
 [![Actions status](https://github.com/acoular/acoular/actions/workflows/tests.yml/badge.svg)](https://github.com/acoular/acoular/actions)
-[![DOI](https://zenodo.org/badge/29729101.svg)](https://zenodo.org/doi/10.5281/zenodo.3690794)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/3690794.svg)](https://zenodo.org/doi/10.5281/zenodo.3690794)
 
 # Acoular
-Acoular is a Python module for acoustic beamforming that is distributed under the new BSD license. 
-
-It is aimed at applications in acoustic testing. Multichannel data recorded by a microphone array can be processed and analyzed in order to generate mappings of sound source distributions. The maps (acoustic photographs) can then be used to locate sources of interest and to characterize them using their spectra. 
-
-# Features
-- frequency domain beamforming algorithms: delay & sum, Capon (adaptive), MUSIC, functional beamforming, eigenvalue beamforming
-- frequency domain deconvolution algorithms: DAMAS, DAMAS+, Clean, CleanSC, orthogonal deconvolution
-- frequency domain inverse methods: CMF (covariance matrix fitting), general inverse beamforming, SODIX
-- time domain methods: delay & sum beamforming, CleanT deconvolution
-- time domain methods applicable for moving sources with arbitrary trajectory (linear, circular, arbitrarily 3D curved), 
-- frequency domain methods for rotating sources via virtual array rotation for arbitrary arrays and with different interpolation techniques
+Acoular is a Python module for acoustic beamforming that is distributed under the [BSD 3-clause license](LICENSE). 
+
+It is aimed at (but not limited to) applications in acoustic testing. Multichannel data recorded by microphone arrays can be processed and analyzed to generate mappings of sound source distributions. The maps (acoustic photographs) can then be used to locate sources of interest and to characterize them using their spectra. 
+
+👁️📢 Please consider taking the [**Acoular User Survey**](https://www.soscisurvey.de/acoularsurvey). It only takes 2 minutes.
+
+- **Website:** https://acoular.org
+- **Blog:** https://blog.acoular.org
+- **Installation:** https://acoular.org/install
+- **Getting Started** https://acoular.org/user_guide/get_started.html
+- **User Guide:** https://acoular.org/user_guide
+- **API Reference:** https://acoular.org/api_ref
+- **Examples:** https://acoular.org/auto_examples
+- **Contributing:** https://acoular.org/contributing
+- **Questions?:** https://github.com/orgs/acoular/discussions
+- **Bug Reports:** https://github.com/acoular/acoular/issues
+- **Report a Security Vulnerability:** https://github.com/acoular/acoular/security/advisories/new
+
+## Highlights
+- frequency domain methods:
+  - **beamforming:** delay & sum, Capon (adaptive), MUSIC, functional and eigenvalue beamforming
+  - **deconvolution:** DAMAS, DAMAS+, Clean, CleanSC, (gridless) orthogonal deconvolution
+  - **inverse methods:** CMF (covariance matrix fitting), general inverse beamforming, SODIX
+- time domain methods:
+  - **beamforming:** delay & sum
+  - **deconvolution:** CleanT
 - 1D, 2D and 3D mapping grids for all methods
-- gridless option for orthogonal deconvolution
-- four different built-in steering vector formulations
-- arbitrary stationary background flow can be considered for all methods
-- efficient cross spectral matrix computation
-- flexible modular time domain processing: n-th octave band filters, fast, slow, and impulse weighting, A-, C-, and Z-weighting, filter bank, zero delay filters
-- time domain simulation of array microphone signals from fixed and arbitrarily moving sources in arbitrary flow
-- fully object-oriented interface
-- lazy evaluation: while processing blocks are set up at any time, (expensive) computations are only performed when needed
-- intelligent and transparent caching: computed results are automatically saved and loaded on the next run to avoid unnecessary re-computation
-- parallel (multithreaded) implementation with Numba for most algorithms
-- easily extendable with new algorithms
-
-# License
-Acoular is licensed under the BSD 3-clause. See [LICENSE](LICENSE)
-
-# Citing
-
+- arbitrary stationary background 🌬️ **flow** can be considered for all methods
+- frequency domain methods for 🌀 **rotating sources** via virtual array rotation for arbitrary arrays
+- all time domain methods can identify 🚂🛩️ **moving sources** with arbitrary trajectory
+- flexible & modular 🧮 **signal processing**:
+  - n-th octave band filters
+  - fast, slow, and impulse weighting
+  - A-, C-, and Z-weighting
+  - filter bank
+  - linear phase filters
+- intelligent and transparent :floppy_disk: **caching**: computed results are automatically saved and loaded on the next run to avoid unnecessary re-computation.
+- 🦥 **lazy** evaluation: while processing blocks are set up at any time, (expensive) computations are only performed when needed.
+- 🏎️ **efficient & parallel** (multithreaded) computation with [Numba](https://numba.pydata.org) for most algorithms.
+
+## Citing
 If you use Acoular for academic work, please consider citing both our
 [publication](https://doi.org/10.1016/j.apacoust.2016.09.015):
 
     Sarradj, E., & Herold, G. (2017). 
     A Python framework for microphone array data processing.
     Applied Acoustics, 116, 50–58. 
-    https://doi.org/10.1016/j.apacoust.2016.09
+    https://doi.org/10.1016/j.apacoust.2016.09.015
 
 and our [software](https://zenodo.org/doi/10.5281/zenodo.3690794):
 
@@ -163,41 +124,26 @@ and our [software](https://zenodo.org/doi/10.5281/zenodo.3690794):
     Acoular – Acoustic testing and source mapping software. 
     Zenodo. https://zenodo.org/doi/10.5281/zenodo.3690794
 
-# Dependencies
-Acoular runs under Linux, Windows and MacOS and needs Numpy, Scipy, Traits, scikit-learn, pytables, Numba packages available. 
-Matplotlib is needed for some of the examples.
-
-If you want to use input from a soundcard, you will also need to install the [sounddevice](https://python-sounddevice.readthedocs.io/en/0.3.12/installation.html) package. Some solvers for the CMF method need [Pylops](https://pylops.readthedocs.io/en/stable/installation.html).
+## Installation
 
-# Installation
+Acoular can be installed from [PyPI](https://pypi.org/project/acoular). It is recommended to use a [virtual environment](https://docs.python.org/3/library/venv.html). Inside the environment, run
 
-Acoular can be installed via [conda](https://docs.conda.io/en/latest/), which is also part of the [Anaconda Python distribution](https://www.anaconda.com/). It is recommended to install into a dedicated [conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). After activating this environment, run
+    pip install acoular
+    
+A second option is to install Acoular with [conda](https://docs.conda.io/en/latest/). It is recommended to install into a dedicated [conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). After activating the environment, run
 
     conda install -c acoular acoular
 
-This will install Acoular in your Anaconda Python environment and make the Acoular library available from Python. In addition, this will install all dependencies (those other packages mentioned above) if they are not already present on your system. 
-
-A second option is to install Acoular via [pip](https://pip.pypa.io/en/stable/). It is recommended to use a dedicated [virtual environment](https://virtualenv.pypa.io/en/latest/) and then run
-
-    pip install acoular
-
 For more detailed installation instructions, see the [documentation](https://acoular.org/install/index.html).
 
-# Documentation and help
+## Documentation and help
 Documentation is available [here](https://acoular.org) with a
-[getting started](https://acoular.org/get_started/index.html) section and
+[getting started](https://www.acoular.org/user_guide/get_started.html) section and
 [examples](https://acoular.org/auto_examples/index.html).
 
-The Acoular [blog](https://acoular.github.io/blog/) contains some tutorials.
-
 If you discover problems with the Acoular software, please report them using the [issue tracker](https://github.com/acoular/acoular/issues) on GitHub. Please use the [Acoular discussions forum](https://github.com/acoular/acoular/discussions) for practical questions, discussions, and demos.
 
-# Contributing
-
-We are always happy to welcome new contributors to the project. 
-If you are interested in contributing, have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file.
-
-# Example
+## Example
 This reads data from 64 microphone channels and computes a beamforming map for the 8kHz third octave band:
 
 ```python
@@ -244,4 +190,3 @@ plt.show()
 
 ![result](https://github.com/acoular/acoular/blob/master/docs/source/user_guide/three_source_py3_colormap.png?raw=true)
 
-