From 9f23325e0eac44f303cd0998c116f8a06b23abc9 Mon Sep 17 00:00:00 2001 From: Nicolas Tessore Date: Tue, 16 Jul 2024 14:49:38 +0100 Subject: [PATCH] REL: glass 2024.1 (#165) First GLASS release of 2024. --- CHANGELOG.md | 37 ++++++++++++++++++++++++++++++ docs/manual/releases.rst | 49 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a9473447..9b911060 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,42 @@ All notable changes to the project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com). +[2024.1] (16 Jul 2024) +----------------------- + +### Added + +* A new function `combine()` that evaluates the linear combination + of radial window functions with given weights. +* A new function `effective_cls()` which combines power spectra + using a list of weights, which models what happens in the simulation. +* A new function `position_weights()` that returns weights for + `effective_cls()` to model the result of `positions_from_delta()`. +* A new function `multi_plane_weights()` that returns weights for + `effective_cls()` to model the result of `MultiPlaneConvergence`. +* The `glass.core.algorithm` module. +* The new `partition(method="nnls")` function computes a partition + with non-negative contributions for each shell. +* Function `redshifts()` to sample redshifts following a radial + window function. + +### Changed + +* The default method for `partition()` is now `"nnls"`. +* Both `partition(method="nnls")` and `partition(method="lstsq")` + now have an additional integral constraint so that the sum of the + partition recovers the integral of the input function. +* The output of `partition()` now has the shells axis as its first. + +### Fixed + +* Now uses the updated intersphinx URL for the GLASS examples. +* A bug in `effective_cls()` that caused arrays to be one entry too + long if `lmax` was not given explicitly. +* A bug in `partition()` with the default method. +* `partition()` now works correctly with functions having extra axes. + + [2023.7] (1 Aug 2023) ---------------------- @@ -123,6 +159,7 @@ based on [Keep a Changelog](https://keepachangelog.com). - Initial wide release for GLASS paper +[2024.1]: https://github.com/glass-dev/glass/compare/v2023.7...v2024.1 [2023.7]: https://github.com/glass-dev/glass/compare/v2023.6...v2023.7 [2023.6]: https://github.com/glass-dev/glass/compare/v2023.5...v2023.6 [2023.5]: https://github.com/glass-dev/glass/compare/v2023.2...v2023.5 diff --git a/docs/manual/releases.rst b/docs/manual/releases.rst index 1d9a1f27..e4a00794 100644 --- a/docs/manual/releases.rst +++ b/docs/manual/releases.rst @@ -5,6 +5,55 @@ Release notes These notes document the changes between individual *GLASS* releases. +2024.1 (16 Jul 2024) +--------------------- + +* Further changes to the :func:`~glass.shells.partition()` function. + + * The output of ``partition()`` now has the shells axis as its first. **This + means that the new output is the transpose of the previous output.** + + * A new ``partition(..., method="nnls")`` method that computes a partition + with non-negative contributions for each shell. **This is now the + default.** The ``"nnls"`` method works much better than ``"lstsq"`` since + it does not introduce small negative densities, and should almost always be + preferred. + + * Both ``partition(method="nnls")`` and ``partition(method="lstsq")`` now + have an additional integral constraint so that the sum of the partition + recovers the integral of the input function. + + * The ``partition()`` function now works correctly with functions having + extra axes. + +* A new function :func:`~glass.shells.combine()` that evaluates the linear + combination of radial window functions with given weights. This function is + the inverse of :func:`~glass.shells.partition()` and can be used to obtain + the effect of the discretisation on, e.g., a redshift distribution. + +* There is now a way to compute the effective angular power spectra that can + be expected from a *GLASS* simulation, including all discretisations and + approximations. + + * A new function :func:`~glass.fields.effective_cls()` which combines power + spectra using a list of weights. This function essentially models the + linear combinations that happen in the simulation. + + * A new function :func:`~glass.points.position_weights()` that returns weights + for ``effective_cls()`` to model the result of + :func:`~glass.points.positions_from_delta()`. + + * A new function :func:`~glass.lensing.multi_plane_weights()` that returns + weights for ``effective_cls()`` to model the result of + :class:`~glass.lensing.MultiPlaneConvergence`. + +* A new function :func:`~glass.galaxies.redshifts()` to sample redshifts + following a radial window function. This should always be preferred to the + existing :func:`~glass.galaxies.redshifts_from_nz()` function, since the + redshift distribution entering the two-point statistics is in fact fixed by + the window functions. + + 2023.7 (1 Aug 2023) -------------------