bump to 2.4.0, the future release that master works towards

flatironinstitute · Jan 7, 2025 · c6c4104 · c6c4104
1 parent 0a9efc2
commit c6c4104
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 16 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,9 +1,11 @@
 List of features / changes made / release notes, in reverse chronological order.
 If not stated, FINUFFT is assumed (cuFINUFFT <=1.3 is listed separately).
 
-Master (11/29/24)
+Master, working towards V 2.4.0 (1/7/25)
 
-* exit codes of many-vector tests now insensitive to one-mode randomness.
+* unified separate-dim arrays (eg X,Y,Z->XYZ), simplifiying core (Reinecke #592)
+* exit codes of many-vector tests now insensitive to one-mode randomness
+  (Barnett)
 * various bugfixes (DUCC+Python, Python dtype chk, Fortran opts)
 * Large re-org of CPU lib code to remove C-style macros (Martin Reinecke)
   PR 558: de-macroize FFT (FFT plan now a class), and OMP funcs.
@@ -21,8 +23,6 @@ Master (11/29/24)
   Note: tests still use macros (test_defs.h). And C++ interface will solidify.
 * Single-argument spreading kernel Horner evaluator available for deconv step
   (onedim_* funcs), to unify ker eval. PR 541, Libin Lu. Not yet exploited.
-* Support and docs for opts.gpu_spreadinterponly=1 for MRI "density compensation
-  estimation" type 1&2 use-case with upsampfac=1.0 PR564 (Chaithya G R).
 * Simplify building of Python source distributions. PR 555 (J Anden).
 * reduced roundoff error in a[n] phase calc in CPU onedim_fseries_kernel().
    PR534 (Barnett).
@@ -39,6 +39,11 @@ Master (11/29/24)
   can be be used to prevent crashes when a user is creating/destroying FFTW
   plans and FINUFFT plans in threads simultaneously.
 
+V 2.3.1 (11/25/24) minor update release (continued support on 2.3.X branch)
+
+* Support and docs for opts.gpu_spreadinterponly=1 for MRI "density compensation
+  estimation" type 1&2 use-case with upsampfac=1.0 PR564 (Chaithya G R).
+
 V 2.3.0 (9/5/24)
 
 * Switched C++ standards from C++14 to C++17, allowing various templating

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.19...3.30)
 project(
   FINUFFT
-  VERSION 2.3.1
+  VERSION 2.4.0
   LANGUAGES C CXX)
 
 # windows MSVC runtime flags policy

diff --git a/docs/conf.py b/docs/conf.py
@@ -66,17 +66,17 @@
 
 # General information about the project.
 project = u'finufft'
-copyright = u'2017-2024 The Simons Foundation, Inc. - All Rights Reserved'
+copyright = u'2017-2025 The Simons Foundation, Inc. - All Rights Reserved'
 author = u'Alex Barnett, Ludvig af Klinteberg, Joakim Andén, Libin Lu, Jeremy Magland, Andrea Malleo, Yu-Hsuan Shih, Marco Barbone, Robert Blackwell, and others.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'2.3'
+version = u'2.4'
 # The full version, including alpha/beta/rc tags.
-release = u'2.3.1'
+release = u'2.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/devnotes.rst b/docs/devnotes.rst
@@ -11,7 +11,7 @@ Developer notes
 
   - ``CMakeLists.txt`` for cmake
   - ``docs/conf.py`` for sphinx
-  - ``docs/install.rst`` cmake git tags
+  - ``docs/install.rst`` cmake git tags (3 places)
   - ``python/finufft/finufft/__init__.py`` for the python pkg version
   - ``python/cufinufft/cufinufft/__init__.py`` for the GPU python pkg version
   - ``include/finufft/finufft_core.h`` for debug output

diff --git a/docs/install.rst b/docs/install.rst
@@ -51,13 +51,13 @@ Then add the following to your ``CMakeLists.txt``:
 .. code-block:: cmake
 
   # short version
-  CPMAddPackage("gh:flatironinstitute/finufft@2.3.1")
+  CPMAddPackage("gh:flatironinstitute/finufft@2.4.0")
 
   # alternative in case custom options are needed
   CPMAddPackage(
     NAME             Finufft
     GIT_REPOSITORY   https://github.com/flatironinstitute/finufft.git
-    GIT_TAG          2.3.1
+    GIT_TAG          2.4.0
     GIT_SHALLOW      Yes
     GIT_PROGRESS     Yes
     EXCLUDE_FROM_ALL Yes
@@ -79,7 +79,7 @@ Add the following to your ``CMakeLists.txt``:
     FetchContent_Declare(
       finufft
       GIT_REPOSITORY https://github.com/flatironinstitute/finufft.git
-      GIT_TAG 2.3.1
+      GIT_TAG 2.4.0
     )
 
     # Make the content available

diff --git a/include/finufft/finufft_core.h b/include/finufft/finufft_core.h
@@ -71,7 +71,7 @@ using UBIGINT = uint64_t;
 // ------------- Library-wide algorithm parameter settings ----------------
 
 // Library version (is a string)
-#define FINUFFT_VER "2.3.1"
+#define FINUFFT_VER "2.4.0"
 
 // Smallest possible kernel spread width per dimension, in fine grid points
 // (used only in spreadinterp.cpp)

diff --git a/matlab/Contents.m b/matlab/Contents.m
@@ -1,5 +1,5 @@
 % FINUFFT: Flatiron Institute Nonuniform Fast Fourier Transform
-% Version 2.3.1
+% Version 2.4.0
 %
 % Basic and many-vector interfaces
 %   finufft1d1 - 1D complex nonuniform FFT of type 1 (nonuniform to uniform).

diff --git a/python/cufinufft/cufinufft/__init__.py b/python/cufinufft/cufinufft/__init__.py
@@ -8,4 +8,4 @@
            "nufft3d1", "nufft3d2",
            "Plan"]
 
-__version__ = '2.3.1'
+__version__ = '2.4.0'
diff --git a/python/finufft/finufft/__init__.py b/python/finufft/finufft/__init__.py
@@ -17,4 +17,4 @@
 from finufft._interfaces import nufft2d1,nufft2d2,nufft2d3
 from finufft._interfaces import nufft3d1,nufft3d2,nufft3d3
 
-__version__ = '2.3.1'
+__version__ = '2.4.0'