Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-390: release 2024.2 #426

Merged
merged 4 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,23 @@

# Changelog

All notable changes to the project are documented in this file. The format is
based on [Keep a Changelog](https://keepachangelog.com).
All functional changes to the project are documented in this file.

## [2024.2] (15 Nov 2024)
ntessore marked this conversation as resolved.
Show resolved Hide resolved

- gh-188: add docstrings to all functions and tidy docs (#381)
- gh-336: support Python 3.13 (#337)
- gh-358: add static types support (#368)
- gh-131: rename `gaussian_gls` to `discretized_cls` (#345)
- gh-328: efficient resampling in `ellipticity_ryden04` (#341)
- gh-137: deprecate `redshifts_from_nz` in favor of `redshifts` (#333)
- gh-328: fix shape mismatch bug in ellipticity_ryden04 (#332)
- gh-315: add broadcasting rule in ellipticity_ryden04 + tests (#317)
- gh-198: enforce `python>3.8` & `numpy>1.21` (#326)
- gh-260: remove glass.core.constants (#261)
- gh-107: add all public functions/classes under glass namespace (#221)
- gh-168: move examples into repository (#169)
- gh-156: add FITS catalogue writer tool (#158)

## [2024.1] (16 Jul 2024)

Expand Down Expand Up @@ -143,6 +158,7 @@ based on [Keep a Changelog](https://keepachangelog.com).

- Initial wide release for GLASS paper

[2024.2]: https://github.com/glass-dev/glass/compare/v2024.1...v2024.2
[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
Expand Down
20 changes: 9 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,12 @@ any browser by opening the `index.html` file.

## Releases

To release a new version of _GLASS_, there should be a commit titled
`REL: glass yyyy.mm` that includes the following changes:
To release a new version of _GLASS_, there should be a commit that includes the
following changes:

- The changelog trailers since the last release are parsed into the
[changelog](CHANGELOG.md) under a section titled `[yyyy.mm] (DD Mon YYYY)`. A
new link to the changeset is added at the bottom of the file.
- The changes since the last release are added to the [changelog](CHANGELOG.md)
under a section titled `[yyyy.mm] (DD Mon YYYY)`. A new link to the changeset
is added at the bottom of the file.
- The [release notes](docs/manual/releases.rst) are updated with the new
version. The release notes should translate the changelog entries into prose
that can be understood by non-developer users of the code. If there are
Expand All @@ -129,14 +129,12 @@ PyPI.
_GLASS_ follows [CalVer](https://calver.org). There is no difference between
releases that increment the year and releases that increment the month; in
particular, releases that increment the month may introduce breaking changes.
The version is generate dynamically through VCS using
[`hatch-vcs`](https://github.com/ofek/hatch-vcs).

The target is to have a new _GLASS_ release at the beginning of each month, as
long as there have been changes.
The current version number is automatically inferred from the last release
(i.e., git tag), subsequent unreleased commits, and local changes, if any.

The current version number is automatically inferred from the last release (i.e.
git tag), subsequent unreleased commits, and local changes, if any.
The target is to have a new _GLASS_ release once there are significant changes
to the code's functionality.

## Nox

Expand Down
40 changes: 38 additions & 2 deletions docs/manual/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,44 @@ Release notes
These notes document the changes between individual *GLASS* releases.


2024.1 (16 Jul 2024)
---------------------
2024.2 (15 Nov 2024)
--------------------

* All GLASS user functionality is now available directly from the main
``glass`` namespace. No more imports!

* Changes to the functions dealing with Gaussian spectra:

* ``gaussian_gls()`` was renamed to :func:`glass.discretized_cls`, which
better reflects what the function does.

* The implicit call to :func:`glass.discretized_cls` was removed from
:func:`glass.lognormal_gls`. Call :func:`glass.discretized_cls` explicitly
ntessore marked this conversation as resolved.
Show resolved Hide resolved
with the desired ``ncorr=``, ``lmax=``, and ``nside=`` parameters.

* ``redshifts_from_nz()`` is deprecated in favour of :func:`glass.redshifts`,
as the former is almost never the right choice: the two-point statistics in a
linear bias model are coming from the shells, so the redshift distribution is
implicitly the same as the radial profile of the shells.

* Several fixes to :func:`glass.ellipticity_ryden04`.

* Added a FITS catalogue writer tool :func:`glass.write_catalog`.

* Much improved documentation with docstring for all functions.

* Examples now live in the main GLASS repository and documentation.

* GLASS is now fully typed and passes mypy.

* Python 3.13 is now supported. Python 3.8 and NumPy 1.21 are no longer
supported.

* The ``glass.core.constants`` module was removed.


2024.1 (16 Jul 2024)
--------------------

* Further changes to the :func:`~glass.shells.partition()` function.

Expand Down