Release candidate 1.0.0 (#386)

* prepare release 1.0.0

* fix: conflicts in README.md

* fix: conflicts in building.rst

* replace OPENMPTARGET with OPENACC, because it has been deleted

* update warnings based on review

* format CHANGELOG.md

* update CHANGELOG.md

* Introduce internal changes section in CHANGELOG.md

* Only keep relevant changes in General Enhancement

* update CHANGELOG.md

* update CHANGELOG.md and experimental warnings

* use upper case for the experimental namespaces

* update dates in CHANGELOG.md

---------

Co-authored-by: Yuuichi Asahi <[email protected]>

Author: yasahi-hpc

CHANGELOG.md

@@ -6,65 +6,138 @@ SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception
 
 # Change Log
 
-## [0.4.0](https://github.com/kokkos/kokkos-kernels/tree/0.4.0) (2025-07-29)
+## [1.0.0](https://github.com/kokkos/kokkos-fft/tree/1.0.0) (2026-01-26)
 
-**Implemented enhancements:**
+**Documentation:**
+
+- Rename kokkos-fft to Kokkos-FFT[\#388](https://github.com/kokkos/kokkos-fft/pull/388)
+- Align prerequisites with Kokkos 5.0[\#387](https://github.com/kokkos/kokkos-fft/pull/387)
+- Add docstring to get_map_axes[\#340](https://github.com/kokkos/kokkos-fft/pull/340)
+- Add a link to JOSS paper [\#304](https://github.com/kokkos/kokkos-fft/pull/304)
+
+**CI:**
+
+- Add spack spec and fix install-test in spack CI [\#324](https://github.com/kokkos/kokkos-fft/pull/324)
+- Add spack installation CI for SYCL backend [\#323](https://github.com/kokkos/kokkos-fft/pull/323)
+- Add spack installation CI for HIP backend [\#318](https://github.com/kokkos/kokkos-fft/pull/318)
+- Update rocm Dockerfile to use hipcc 6.2.0 [\#316](https://github.com/kokkos/kokkos-fft/pull/316)
+- Update C++ version to 20 in nightly workflow [\#314](https://github.com/kokkos/kokkos-fft/pull/314)
+- Add spack installation CI for CUDA backend [\#312](https://github.com/kokkos/kokkos-fft/pull/312)
+
+**General Enhancement:**
+
+- Update to kokkos4.6 [\#385](https://github.com/kokkos/kokkos-fft/pull/385)
+- Use std::size_t to manipulate extents [\#384](https://github.com/kokkos/kokkos-fft/pull/384)
+- Refactor normalization and unit-tests [\#381](https://github.com/kokkos/kokkos-fft/pull/381)
+- Expose DynPlans [\#376](https://github.com/kokkos/kokkos-fft/pull/376)
+- Rephrase the static assertion message regarding data accessibility [\#370](https://github.com/kokkos/kokkos-fft/pull/370)
+
+**Bug fix:**
+
+- Add const in order to suppress warnings by nvcc [\#365](https://github.com/kokkos/kokkos-fft/pull/365)
+- Interpret the array of perturbations relative to the original array [\#357](https://github.com/kokkos/kokkos-fft/pull/357)
+- Use the new name of a Kokkos option [\#322](https://github.com/kokkos/kokkos-fft/pull/322)
+
+**Internal Changes:**
+
+- Define is_AllowedSpace in default_types.hpp [\#390](https://github.com/kokkos/kokkos-fft/pull/390)
+- Introduce layout header [\#380](https://github.com/kokkos/kokkos-fft/pull/380)
+- Move get_map_axes into KokkosFFT_Mapping.hpp [\#377](https://github.com/kokkos/kokkos-fft/pull/377)
+- Add dynamic plan for SYCL backend [\#373](https://github.com/kokkos/kokkos-fft/pull/373)
+- Add dynamic plan for ROCM backend [\#372](https://github.com/kokkos/kokkos-fft/pull/372)
+- Add dynamic plan for HIPFFT backend [\#371](https://github.com/kokkos/kokkos-fft/pull/371)
+- Rename ger_r2c_extent and make it public [\#369](https://github.com/kokkos/kokkos-fft/pull/369)
+- Add dynamic plan for CUDA backend [\#366](https://github.com/kokkos/kokkos-fft/pull/366)
+- Add extents test for dynamic rank case [\#364](https://github.com/kokkos/kokkos-fft/pull/364)
+- Improve iteration pattern in transpose [\#355](https://github.com/kokkos/kokkos-fft/pull/355)
+- Testing transpose with bound checks [\#352](https://github.com/kokkos/kokkos-fft/pull/352)
+- Rename iType to IndexType to align with mdspan convention [\#351](https://github.com/kokkos/kokkos-fft/pull/351)
+- Allow is_transpose_needed to work on std::size_t based array [\#350](https://github.com/kokkos/kokkos-fft/pull/350)
+- Introduce a helper to make a reference for transposed view [\#349](https://github.com/kokkos/kokkos-fft/pull/349)
+- Use execution space instance in Transpose Unit tests [\#348](https://github.com/kokkos/kokkos-fft/pull/348)
+- Introduce helper function to wrap std::reverse [\#343](https://github.com/kokkos/kokkos-fft/pull/343)
+- Make compute_strides function a public function [\#342](https://github.com/kokkos/kokkos-fft/pull/342)
+- Use std::size_t in transpose test [\#341](https://github.com/kokkos/kokkos-fft/pull/341)
+- Extract the core logic of get_map_axes helper [\#337](https://github.com/kokkos/kokkos-fft/pull/337)
+- Add base type convert helper of containers [\#336](https://github.com/kokkos/kokkos-fft/pull/336)
+- Add base type convert helper of containers [\#336](https://github.com/kokkos/kokkos-fft/pull/336)
+- Improve convert negative axis to work on containers [\#334](https://github.com/kokkos/kokkos-fft/pull/334)
+- Add product helper [\#328](https://github.com/kokkos/kokkos-fft/pull/328)
+
+## [0.4.0](https://github.com/kokkos/kokkos-fft/tree/0.4.0) (2025-07-29)
+
+**Documentation:**
+
+- Detail license in README [\#299](https://github.com/kokkos/kokkos-fft/pull/299)
+- Fixes a link in the documentation [\#296](https://github.com/kokkos/kokkos-fft/pull/296)
+- Suppress disclaimer [\#282](https://github.com/kokkos/kokkos-fft/pull/282)
+- Typo fix in README.md [\#281](https://github.com/kokkos/kokkos-fft/pull/281)
+
+**CI:**
 
-- Documentation: Detail license in README [\#299](https://github.com/kokkos/kokkos-fft/pull/299)
-- Documentation: Fixes a link in the documentation [\#296](https://github.com/kokkos/kokkos-fft/pull/296)
-- Documentation: Suppress disclaimer [\#282](https://github.com/kokkos/kokkos-fft/pull/282)
-- Documentation: Typo fix in README.md [\#281](https://github.com/kokkos/kokkos-fft/pull/281)
 - CI: Build CUDA backend with cxx20 in CI and enable testing-tools [\#272](https://github.com/kokkos/kokkos-fft/pull/272)
-- General Enhancement: Print in/out view details and axes in case of extent errors [\#301](https://github.com/kokkos/kokkos-fft/pull/301)
-- General Enhancement: Improve error message of a failing find_package for FFTW [\#293](https://github.com/kokkos/kokkos-fft/pull/293)
-- General Enhancement: Update to kokkos 4.5.1 [\#292](https://github.com/kokkos/kokkos-fft/pull/292)
-- General Enhancement: Define KOKKOSFFT_ENABLE_TPL_\<NAME\> through KokkosFFT_config.hpp [\#291](https://github.com/kokkos/kokkos-fft/pull/291)
-- General Enhancement: Make convert_negative_axis a templated function again [\#288](https://github.com/kokkos/kokkos-fft/pull/288)
-- General Enhancement: Allow index_sequence to work on unsigned integers [\#287](https://github.com/kokkos/kokkos-fft/pull/287)
-- General Enhancement: Refactor convert_negative_axis to unuse View [\#286](https://github.com/kokkos/kokkos-fft/pull/286)
-- General Enhancement: Use value_or instead of maybe_null_to_shape [\#276](https://github.com/kokkos/kokkos-fft/pull/276)
-- General Enhancement: Delegating Plan class constructor [\#275](https://github.com/kokkos/kokkos-fft/pull/275)
-- General Enhancement: Merging transpose implementation details into a single functor [\#274](https://github.com/kokkos/kokkos-fft/pull/274)
-- General Enhancement: Refactor 1D-8D roll functors [\#273](https://github.com/kokkos/kokkos-fft/pull/273)
-- General Enhancement: Add const for container types [\#270](https://github.com/kokkos/kokkos-fft/pull/270)
-- General Enhancement: Allow real input to fft and hfft [\#263](https://github.com/kokkos/kokkos-fft/pull/263)
-- General Enhancement: Introduce a helper to convert a view type with different base value type [\#262](https://github.com/kokkos/kokkos-fft/pull/262)
+
+**General Enhancement:**
+
+- Print in/out view details and axes in case of extent errors [\#301](https://github.com/kokkos/kokkos-fft/pull/301)
+- Improve error message of a failing find_package for FFTW [\#293](https://github.com/kokkos/kokkos-fft/pull/293)
+- Update to kokkos 4.5.1 [\#292](https://github.com/kokkos/kokkos-fft/pull/292)
+- Define KOKKOSFFT_ENABLE_TPL_\<NAME\> through KokkosFFT_config.hpp [\#291](https://github.com/kokkos/kokkos-fft/pull/291)
+- Make convert_negative_axis a templated function again [\#288](https://github.com/kokkos/kokkos-fft/pull/288)
+- Allow index_sequence to work on unsigned integers [\#287](https://github.com/kokkos/kokkos-fft/pull/287)
+- Refactor convert_negative_axis to unuse View [\#286](https://github.com/kokkos/kokkos-fft/pull/286)
+- Use value_or instead of maybe_null_to_shape [\#276](https://github.com/kokkos/kokkos-fft/pull/276)
+- Delegating Plan class constructor [\#275](https://github.com/kokkos/kokkos-fft/pull/275)
+- Merging transpose implementation details into a single functor [\#274](https://github.com/kokkos/kokkos-fft/pull/274)
+- Refactor 1D-8D roll functors [\#273](https://github.com/kokkos/kokkos-fft/pull/273)
+- Add const for container types [\#270](https://github.com/kokkos/kokkos-fft/pull/270)
+- Allow real input to fft and hfft [\#263](https://github.com/kokkos/kokkos-fft/pull/263)
+- Introduce a helper to convert a view type with different base value type [\#262](https://github.com/kokkos/kokkos-fft/pull/262)
 
 **Bug fix:**
 
-## [0.3.0](https://github.com/kokkos/kokkos-kernels/tree/0.3.0) (2025-04-16)
-
-**Implemented enhancements:**
-
-- Documentation: Fix docs with CMake build [\#259](https://github.com/kokkos/kokkos-fft/pull/259)
-- Documentation: Fixes a link in the documentation [\#258](https://github.com/kokkos/kokkos-fft/pull/258)
-- Documentation: Add developer guide in docs [\#232](https://github.com/kokkos/kokkos-fft/pull/232)
-- CI: Introduce link checker in CI [\#260](https://github.com/kokkos/kokkos-fft/pull/260)
-- CI: Update dependabot.yml [\#245](https://github.com/kokkos/kokkos-fft/pull/245)
-- CI: Introduce version check [\#238](https://github.com/kokkos/kokkos-fft/pull/238)
-- CI: Simplify the creation of Docker/Singularity images [\#237](https://github.com/kokkos/kokkos-fft/pull/237)
-- CI: Introduce pylinter in CI [\#234](https://github.com/kokkos/kokkos-fft/pull/234)
-- CI: Introduce cmake-format in CI [\#229](https://github.com/kokkos/kokkos-fft/pull/229)
-- CI: Add a spell check in CI [\#227](https://github.com/kokkos/kokkos-fft/pull/227)
-- CI: Simplify CMake installation in Dockerfiles [\#222](https://github.com/kokkos/kokkos-fft/pull/222)
-- CI: Add nightly tests using Kokkos develop branch [\#213](https://github.com/kokkos/kokkos-fft/pull/213)
-- Build system: Linking library logic is moved from common/src/CMake to fft/src/CMake [\#251](https://github.com/kokkos/kokkos-fft/pull/251)
-- Build system: Allow compilation while disabling device fft libraries [\#249](https://github.com/kokkos/kokkos-fft/pull/249)
-- Build system: Add CMake options to specify backend FFT libs [\#239](https://github.com/kokkos/kokkos-fft/pull/239)
-- Build system: Add check to ensure complex alignment [\#228](https://github.com/kokkos/kokkos-fft/pull/228)
-- General Enhancement: Set commit SHA instead of version of github actions [\#257](https://github.com/kokkos/kokkos-fft/pull/257)
-- General Enhancement: Unuse KokkosFFT_ENABLE_HOST_AND_DEVICE [\#256](https://github.com/kokkos/kokkos-fft/pull/256)
-- General Enhancement: Improve roll function [\#254](https://github.com/kokkos/kokkos-fft/pull/254)
-- General Enhancement: Refactor roll operation used in fftshift/ifftshift [\#253](https://github.com/kokkos/kokkos-fft/pull/253)
-- General Enhancement: Run fill_random on a given execution space instance [\#250](https://github.com/kokkos/kokkos-fft/pull/250)
-- General Enhancement: Refactor unit-tests [\#241](https://github.com/kokkos/kokkos-fft/pull/241)
-- General Enhancement: Improve example docs [\#236](https://github.com/kokkos/kokkos-fft/pull/236)
-- General Enhancement: Cleanup implementation details [\#235](https://github.com/kokkos/kokkos-fft/pull/235)
-- General Enhancement: Make execute a free function [\#223](https://github.com/kokkos/kokkos-fft/pull/223)
-- General Enhancement: Introduce global setup/cleanup in APIs [\#220](https://github.com/kokkos/kokkos-fft/pull/220)
-- General Enhancement: Remove unnecessary cufftCreate and hipfftCreate to avoid creating plans twice [\#212](https://github.com/kokkos/kokkos-fft/pull/212)
-- General Enhancement: Fix RAII issue by introducing wrapper classes for backend plans [\#208](https://github.com/kokkos/kokkos-fft/pull/208)
-- General Enhancement: Add missing checks [\#196](https://github.com/kokkos/kokkos-fft/pull/196)
+## [0.3.0](https://github.com/kokkos/kokkos-fft/tree/0.3.0) (2025-04-16)
+
+**Documentation:**
+
+- Fix docs with CMake build [\#259](https://github.com/kokkos/kokkos-fft/pull/259)
+- Fixes a link in the documentation [\#258](https://github.com/kokkos/kokkos-fft/pull/258)
+- Add developer guide in docs [\#232](https://github.com/kokkos/kokkos-fft/pull/232)
+
+**CI:**
+
+- Introduce link checker in CI [\#260](https://github.com/kokkos/kokkos-fft/pull/260)
+- Update dependabot.yml [\#245](https://github.com/kokkos/kokkos-fft/pull/245)
+- Introduce version check [\#238](https://github.com/kokkos/kokkos-fft/pull/238)
+- Simplify the creation of Docker/Singularity images [\#237](https://github.com/kokkos/kokkos-fft/pull/237)
+- Introduce pylinter in CI [\#234](https://github.com/kokkos/kokkos-fft/pull/234)
+- Introduce cmake-format in CI [\#229](https://github.com/kokkos/kokkos-fft/pull/229)
+- Add a spell check in CI [\#227](https://github.com/kokkos/kokkos-fft/pull/227)
+- Simplify CMake installation in Dockerfiles [\#222](https://github.com/kokkos/kokkos-fft/pull/222)
+- Add nightly tests using Kokkos develop branch [\#213](https://github.com/kokkos/kokkos-fft/pull/213)
+
+**Build system:**
+
+- Linking library logic is moved from common/src/CMake to fft/src/CMake [\#251](https://github.com/kokkos/kokkos-fft/pull/251)
+- Allow compilation while disabling device fft libraries [\#249](https://github.com/kokkos/kokkos-fft/pull/249)
+- Add CMake options to specify backend FFT libs [\#239](https://github.com/kokkos/kokkos-fft/pull/239)
+- Add check to ensure complex alignment [\#228](https://github.com/kokkos/kokkos-fft/pull/228)
+
+**General Enhancement:**
+
+- Set commit SHA instead of version of github actions [\#257](https://github.com/kokkos/kokkos-fft/pull/257)
+- Unuse KokkosFFT_ENABLE_HOST_AND_DEVICE [\#256](https://github.com/kokkos/kokkos-fft/pull/256)
+- Improve roll function [\#254](https://github.com/kokkos/kokkos-fft/pull/254)
+- Refactor roll operation used in fftshift/ifftshift [\#253](https://github.com/kokkos/kokkos-fft/pull/253)
+- Run fill_random on a given execution space instance [\#250](https://github.com/kokkos/kokkos-fft/pull/250)
+- Refactor unit-tests [\#241](https://github.com/kokkos/kokkos-fft/pull/241)
+- Improve example docs [\#236](https://github.com/kokkos/kokkos-fft/pull/236)
+- Cleanup implementation details [\#235](https://github.com/kokkos/kokkos-fft/pull/235)
+- Make execute a free function [\#223](https://github.com/kokkos/kokkos-fft/pull/223)
+- Introduce global setup/cleanup in APIs [\#220](https://github.com/kokkos/kokkos-fft/pull/220)
+- Remove unnecessary cufftCreate and hipfftCreate to avoid creating plans twice [\#212](https://github.com/kokkos/kokkos-fft/pull/212)
+- Fix RAII issue by introducing wrapper classes for backend plans [\#208](https://github.com/kokkos/kokkos-fft/pull/208)
+- Add missing checks [\#196](https://github.com/kokkos/kokkos-fft/pull/196)
 
 **Bug fix:**
 

CMakeLists.txt

@@ -7,13 +7,12 @@ cmake_minimum_required(VERSION 3.22)
 set(KOKKOSFFT_TOP_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
 # Set project
-project(KokkosFFT VERSION 0.4.0 LANGUAGES CXX)
+project(KokkosFFT VERSION 1.0.0 LANGUAGES CXX)
 
 # Add cmake helpers
 list(PREPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 
 # Options
-option(KokkosFFT_ENABLE_HOST_AND_DEVICE "Enable FFT on both host and device" OFF)
 option(KokkosFFT_ENABLE_INTERNAL_KOKKOS "Build internal Kokkos instead of relying on external one" OFF)
 option(KokkosFFT_ENABLE_EXAMPLES "Build KokkosFFT examples" OFF)
 option(KokkosFFT_ENABLE_TESTS "Build KokkosFFT tests" OFF)
@@ -44,11 +43,7 @@ endif()
 # Device specific options
 set(KokkosFFT_TO_ENABLE_FFTW ON)
 if(Kokkos_ENABLE_CUDA OR Kokkos_ENABLE_HIP OR Kokkos_ENABLE_SYCL)
-  if(KokkosFFT_ENABLE_HOST_AND_DEVICE)
-    message(WARNING "KokkosFFT_ENABLE_HOST_AND_DEVICE is deprecated. Please enable FFTW explicitly with -DKokkosFFT_ENABLE_FFTW=ON")
-  else()
-    set(KokkosFFT_TO_ENABLE_FFTW OFF)
-  endif()
+  set(KokkosFFT_TO_ENABLE_FFTW OFF)
 endif()
 
 option(KokkosFFT_ENABLE_FFTW "Enable fftw as a KokkosFFT backend on CPUs" ${KokkosFFT_TO_ENABLE_FFTW})

README.md

@@ -11,9 +11,6 @@ SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception
 [![docs](https://readthedocs.org/projects/kokkosfft/badge/?version=latest)](https://kokkosfft.readthedocs.io/en/latest/?badge=latest)
 [![DOI](https://joss.theoj.org/papers/10.21105/joss.08391/status.svg)](https://doi.org/10.21105/joss.08391)
 
-> [!WARNING]
-> EXPERIMENTAL FFT interfaces for Kokkos C++ Performance Portability Programming EcoSystem
-
 Kokkos-FFT implements local interfaces between [Kokkos](https://github.com/kokkos/kokkos) and de facto standard FFT libraries, including [FFTW](http://www.fftw.org), [cufft](https://developer.nvidia.com/cufft), [hipfft](https://github.com/ROCm/hipFFT) ([rocfft](https://github.com/ROCm/rocFFT)), and [oneMKL](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html). "Local" means not using MPI, or running within a single MPI process without knowing about MPI. We are inclined to implement the [numpy.fft](https://numpy.org/doc/stable/reference/routines.fft.html)-like interfaces adapted for [Kokkos](https://github.com/kokkos/kokkos).
 A key concept is that **"As easy as numpy, as fast as vendor libraries"**. Accordingly, our API follows the API by [numpy.fft](https://numpy.org/doc/stable/reference/routines.fft.html) with minor differences. A fft library dedicated to Kokkos Device backend (e.g. [cufft](https://developer.nvidia.com/cufft) for CUDA backend) is automatically used. If something is wrong with runtime values (say `View` extents), it will raise runtime errors (C++ `std::runtime_error`). See [documentations](https://kokkosfft.readthedocs.io/) for more information.
 
@@ -84,6 +81,7 @@ In this example, the 1D batched `rfft` over 2D View along `axis -1` is executed.
 ## Using Kokkos-FFT
 
 For the moment, there are two ways to use Kokkos-FFT: including as a subdirectory in CMake project or installing as a library. First of all, you need to clone this repo.
+
 ```bash
 git clone --recursive https://github.com/kokkos/kokkos-fft.git
 ```
@@ -102,6 +100,7 @@ To use Kokkos-FFT, we need the following:
 > A compatible C++ compiler that supports at least C++20 is necessary
 
 ### CMake
+
 Since Kokkos-FFT is a header-only library, it is enough to simply add as a subdirectory. It is assumed that kokkos and Kokkos-FFT are placed under `<project_directory>/tpls`.
 
 Here is an example to use Kokkos-FFT in the following CMake project.

docs/api_reference.rst

@@ -9,9 +9,13 @@ API Reference
 
 This section documents the public user interface of ``Kokkos-FFT``. 
 APIs are defined in ``KokkosFFT`` namespace and implementation details are defined in ``KokkosFFT::Impl`` namespace. 
-Thus, it is highly discouraged for users to access functions in ``KokkosFFT::Impl`` namespace. 
+Thus, it is highly discouraged for users to access functions in ``KokkosFFT::Impl`` namespace.
 Except for ``KokkosFFT::Plan``, there are corresponding functions in ``numpy.fft`` as shown below.
 
+.. note::
+
+   For the moment, APIs under ``KokkosFFT::Distributed`` and ``KokkosFFT::Testing`` are considered experimental and may be subject to changes without warnings.
+
 FFT Plan
 --------
 

docs/developer/CI.rst

@@ -90,7 +90,7 @@ For Intel GPUs (Intel PVC), you can test locally in the following way.
       cmake --build build -j 8
       cd build && ctest --output-on-failure
 
-Here is the summary of our compile and run tests for each backend. For GPU backends, we compile with and without ``KokkosFFT_ENABLE_HOST_AND_DEVICE`` option (see :doc:`CMake options<../intro/building>`).
+Here is the summary of our compile and run tests for each backend. For GPU backends, we compile with and without ``KokkosFFT_ENABLE_FFTW`` option (see :doc:`CMake options<../intro/building>`).
 
 .. list-table:: Test summary
    :widths: 15 15 15 15 15 15
@@ -127,7 +127,7 @@ Here is the summary of our compile and run tests for each backend. For GPU backe
      - x (Aazure)
      - x (Aazure)
    * - cuda
-     - gcc, 17
+     - gcc, 20
      - ``Kokkos_ENABLE_CUDA``
      -
      - x (Aazure)