pyNFFT3 0.2.2__tar.gz → 0.2.3__tar.gz

{pynfft3-0.2.2 → pynfft3-0.2.3}/.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy cpufeature
+          pip install numpy py-cpuinfo packaging
       - name: Run tests
         run: |
-          python -m tests.run_tests
+          python -m tests.run_tests

pynfft3-0.2.3/.github/workflows/documentation.yml

@@ -0,0 +1,29 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser
+      - name: Sphinx build
+        run: |
+          cd docs
+          sphinx-apidoc -o ./source ../src -f
+          make html
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

{pynfft3-0.2.2 → pynfft3-0.2.3}/.github/workflows/release.yml

@@ -26,7 +26,7 @@ jobs:
     - name: Build a binary wheel and a source tarball
       run: python3 -m build
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -42,7 +42,7 @@ jobs:
       id-token: write
     steps:
     - name: Download the dists
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -80,9 +80,9 @@ jobs:
       id-token: write
     steps:
     - name: Download the dists
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
     - name: Publish distribution to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      uses: pypa/gh-action-pypi-publish@release/v1

pynfft3-0.2.3/.gitignore

@@ -0,0 +1,17 @@
+.vscode/
+build/
+dist/
+*.egg-info/
+*.egg
+*.py[cod]
+__pycache__/
+venv/
+
+bin/
+lib64/
+pyvenv.cfg
+lib/
+src/pyNFFT3/lib/AVX2/libfftw3-3.dll
+src/pyNFFT3/lib/AVX2/libgomp-1.dll
+src/pyNFFT3/lib/AVX2/libgcc_s_seh-1.dll
+src/pyNFFT3/lib/AVX2/libwinpthread-1.dll

{pynfft3-0.2.2 → pynfft3-0.2.3}/PKG-INFO

@@ -1,9 +1,10 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pyNFFT3
-Version: 0.2.2
+Version: 0.2.3
 Summary: Python interface for the NFFT C library
 Project-URL: Homepage, https://github.com/NFFT/pyNFFT3
 Author-email: Michael Nolander <nolander.michael@gmail.com>
+Maintainer-email: Pascal Schröter <pascal.schroeter@mathematik.tu-chemnitz.de>
 License-File: LICENSE
 Requires-Python: >=3.8
 Requires-Dist: numpy>=2.0.0
@@ -21,6 +22,8 @@ Python interface for the [NFFT C library](https://github.com/NFFT/nfft). Based o
 - nonequispaced fast Fourier transform (NFFT) 
 - nonequispaced fast cosine transform (NFCT) 
 - nonequispaced fast sine transform (NFST)
+- nonequispaced fast spherical Fourier transforms (NFSFT)
+- fast spherical Fourier transforms (FSFT)
 - fast summation (fastsum) 
 
 ## Getting started
@@ -38,4 +41,5 @@ Requirements
 
 - Python 3.8 or greater
 - Numpy 2.0.0 or greater
-- cpufeature 0.2.1 or greater
+- py-cpuinfo 9.0.0 or greater
+- packaging 24.1 or greater

{pynfft3-0.2.2 → pynfft3-0.2.3}/README.md

@@ -8,6 +8,8 @@ Python interface for the [NFFT C library](https://github.com/NFFT/nfft). Based o
 - nonequispaced fast Fourier transform (NFFT) 
 - nonequispaced fast cosine transform (NFCT) 
 - nonequispaced fast sine transform (NFST)
+- nonequispaced fast spherical Fourier transforms (NFSFT)
+- fast spherical Fourier transforms (FSFT)
 - fast summation (fastsum) 
 
 ## Getting started
@@ -25,4 +27,5 @@ Requirements
 
 - Python 3.8 or greater
 - Numpy 2.0.0 or greater
-- cpufeature 0.2.1 or greater
+- py-cpuinfo 9.0.0 or greater
+- packaging 24.1 or greater

pynfft3-0.2.3/docs/source/_static/custom.css

@@ -0,0 +1,8 @@
+div.body {
+    min-width: 360px;
+    max-width: 1200px;
+}
+
+div.bodywrapper {
+    margin: 0 0 0 250px;
+}

{pynfft3-0.2.2 → pynfft3-0.2.3}/docs/source/api/fastsum.rst

@@ -33,7 +33,7 @@ fastsum Attributes
 
       The degree of smoothness. Must be a positive integer.
 
-   .. attribute:: kernel <string>
+   .. attribute:: kernel <str>
 
       Name of kernel function *K*.
 

pynfft3-0.2.3/docs/source/api/fsft.rst

@@ -0,0 +1,77 @@
+``pyNFFT3.FSFT`` - FSFT Class
+================================
+
+FSFT Methods
+-------------
+
+.. autoclass:: pyNFFT3.FSFT
+   :members:
+   :undoc-members:
+   :member-order: bysource
+   :exclude-members: f, fhat, __init__
+
+FSFT Attributes
+----------------
+
+   .. attribute:: plan <fsft_plan>
+
+      FSFT plan (C pointer)
+
+   .. attribute:: N <int>
+
+      The bandwidth :math:`N \epsilon N_0`. Must be a positive integer.
+
+   .. attribute:: M <int>
+
+      The number of nodes. Must be a positive integer.
+
+   .. attribute:: flags <ctypes.c_uint32>
+
+      The FSFT flags.
+
+   .. attribute:: nfft_flags <ctypes.c_unit32>
+
+      The NFFT flags.
+
+   .. attribute:: nfft_cutoff <int>
+
+      The NFFT cutoff.
+
+   .. attribute:: f <numpy.ndarray>
+
+      Complex array for FSFT values or coefficients for the adjoint FSFT.
+
+   .. attribute:: fhat <numpy.ndarray>
+
+      Complex array of spherical Fourier coefficients for the FSFT or values for the adjoint FSFT.
+
+   .. attribute:: init_done <boolean>
+
+      Boolean to indicate if the FSFT plan is initialized.
+
+   .. attribute:: finalized <boolean>
+
+      Boolean to indicate if the FSFT plan is finalized.
+
+NFSFT Flags
+------------
+.. autodata:: pyNFFT3.flags.NFSFT_NORMALIZED
+.. autodata:: pyNFFT3.flags.NFSFT_USE_NDFT
+.. autodata:: pyNFFT3.flags.NFSFT_USE_DPT
+.. autodata:: pyNFFT3.flags.NFSFT_MALLOC_X
+.. autodata:: pyNFFT3.flags.NFSFT_MALLOC_F_HAT
+.. autodata:: pyNFFT3.flags.NFSFT_MALLOC_F
+.. autodata:: pyNFFT3.flags.NFSFT_PRESERVE_F_HAT
+.. autodata:: pyNFFT3.flags.NFSFT_PRESERVE_X
+.. autodata:: pyNFFT3.flags.NFSFT_PRESERVE_F
+.. autodata:: pyNFFT3.flags.NFSFT_DESTROY_F_HAT
+.. autodata:: pyNFFT3.flags.NFSFT_DESTROY_X
+.. autodata:: pyNFFT3.flags.NFSFT_DESTROY_F
+.. autodata:: pyNFFT3.flags.NFSFT_NO_DIRECT_ALGORITHM 
+.. autodata:: pyNFFT3.flags.NFSFT_NO_FAST_ALGORITHM
+.. autodata:: pyNFFT3.flags.NFSFT_ZERO_F_HAT
+.. autodata:: pyNFFT3.flags.NFSFT_EQUISPACED
+.. autodata:: pyNFFT3.flags.nfsft_default
+.. autodata:: pyNFFT3.flags.nfsft_nfft_default
+.. autodata:: pyNFFT3.flags.nfsft_default_nfft_cut_off
+.. autodata:: pyNFFT3.flags.nfsft_default_threshold

{pynfft3-0.2.2 → pynfft3-0.2.3}/docs/source/api/nfct.rst

@@ -33,11 +33,11 @@ NFCT Attributes
 
       The window size. A larger m results in more accuracy but at a higher computational cost.
 
-   .. attribute:: f1 <c_uint32>
+   .. attribute:: f1 <ctypes.c_uint32>
 
       The NFCT flags.
 
-   .. attribute:: f2 <c_unit32>
+   .. attribute:: f2 <ctypes.c_unit32>
 
       The FFTW flags.
 
@@ -63,4 +63,13 @@ NFCT Attributes
 
    .. attribute:: finalized <boolean>
 
-      Boolean to indicate if the NFCT plan is finalized.
+      Boolean to indicate if the NFCT plan is finalized.
+
+NFCT Flags
+------------
+.. autodata:: pyNFFT3.flags.NFCT_SORT_NODES
+.. autodata:: pyNFFT3.flags.NFCT_OMP_BLOCKWISE_ADJOINT
+.. autodata:: pyNFFT3.flags.f1_default_1d
+.. autodata:: pyNFFT3.flags.f1_default
+.. autodata:: pyNFFT3.flags.f2_default
+.. autodata:: pyNFFT3.flags.default_window_cut_off

{pynfft3-0.2.2 → pynfft3-0.2.3}/docs/source/api/nfft.rst

@@ -33,11 +33,11 @@ NFFT Attributes
 
       The window size. A larger m results in more accuracy but at a higher computational cost.
 
-   .. attribute:: f1 <c_uint32>
+   .. attribute:: f1 <ctypes.c_uint32>
 
       The NFFT flags.
 
-   .. attribute:: f2 <c_unit32>
+   .. attribute:: f2 <ctypes.c_unit32>
 
       The FFTW flags.
 
@@ -63,4 +63,22 @@ NFFT Attributes
 
    .. attribute:: finalized <boolean>
 
-      Boolean to indicate if the NFFT plan is finalized.
+      Boolean to indicate if the NFFT plan is finalized.
+
+NFFT Flags
+------------
+.. autodata:: pyNFFT3.flags.PRE_PHI_HUT
+.. autodata:: pyNFFT3.flags.FG_PSI
+.. autodata:: pyNFFT3.flags.PRE_LIN_PSI
+.. autodata:: pyNFFT3.flags.PRE_FG_PSI
+.. autodata:: pyNFFT3.flags.PRE_FULL_PSI
+.. autodata:: pyNFFT3.flags.MALLOC_X
+.. autodata:: pyNFFT3.flags.MALLOC_F_HAT
+.. autodata:: pyNFFT3.flags.MALLOC_F
+.. autodata:: pyNFFT3.flags.FFT_OUT_OF_PLACE
+.. autodata:: pyNFFT3.flags.FFTW_INIT
+.. autodata:: pyNFFT3.flags.PRE_ONE_PSI
+.. autodata:: pyNFFT3.flags.f1_default_1d
+.. autodata:: pyNFFT3.flags.f1_default
+.. autodata:: pyNFFT3.flags.f2_default
+.. autodata:: pyNFFT3.flags.default_window_cut_off

pynfft3-0.2.3/docs/source/api/nfsft.rst

@@ -0,0 +1,81 @@
+``pyNFFT3.NFSFT`` - NFSFT Class
+=============================================
+
+NFSFT Methods
+-------------
+
+.. autoclass:: pyNFFT3.NFSFT
+   :members:
+   :undoc-members:
+   :member-order: bysource
+   :exclude-members: f, fhat, x, __init__
+
+NFSFT Attributes
+----------------
+
+   .. attribute:: plan <nfsft_plan>
+
+      NFSFT plan (C pointer)
+
+   .. attribute:: N <int>
+
+      The bandwidth :math:`N \epsilon N_0`. Must be a positive integer.
+
+   .. attribute:: M <int>
+
+      The number of nodes. Must be a positive integer.
+
+   .. attribute:: flags <ctypes.c_uint32>
+
+      The NFSFT flags.
+
+   .. attribute:: nfft_flags <ctypes.c_unit32>
+
+      The NFFT flags.
+
+   .. attribute:: nfft_cutoff <int>
+
+      The NFFT cutoff.
+
+   .. attribute:: x <numpy.ndarray>
+
+      Float array for sampling nodes.
+
+   .. attribute:: f <numpy.ndarray>
+
+      Complex array for NFSFT values or coefficients for the adjoint NFSFT.
+
+   .. attribute:: fhat <numpy.ndarray>
+
+      Complex array of spherical Fourier coefficients for the NFSFT or values for the adjoint NFSFT.
+
+   .. attribute:: init_done <boolean>
+
+      Boolean to indicate if the NFSFT plan is initialized.
+
+   .. attribute:: finalized <boolean>
+
+      Boolean to indicate if the NFSFT plan is finalized.
+
+NFSFT Flags
+------------
+.. autodata:: pyNFFT3.flags.NFSFT_NORMALIZED
+.. autodata:: pyNFFT3.flags.NFSFT_USE_NDFT
+.. autodata:: pyNFFT3.flags.NFSFT_USE_DPT
+.. autodata:: pyNFFT3.flags.NFSFT_MALLOC_X
+.. autodata:: pyNFFT3.flags.NFSFT_MALLOC_F_HAT
+.. autodata:: pyNFFT3.flags.NFSFT_MALLOC_F
+.. autodata:: pyNFFT3.flags.NFSFT_PRESERVE_F_HAT
+.. autodata:: pyNFFT3.flags.NFSFT_PRESERVE_X
+.. autodata:: pyNFFT3.flags.NFSFT_PRESERVE_F
+.. autodata:: pyNFFT3.flags.NFSFT_DESTROY_F_HAT
+.. autodata:: pyNFFT3.flags.NFSFT_DESTROY_X
+.. autodata:: pyNFFT3.flags.NFSFT_DESTROY_F
+.. autodata:: pyNFFT3.flags.NFSFT_NO_DIRECT_ALGORITHM 
+.. autodata:: pyNFFT3.flags.NFSFT_NO_FAST_ALGORITHM
+.. autodata:: pyNFFT3.flags.NFSFT_ZERO_F_HAT
+.. autodata:: pyNFFT3.flags.NFSFT_EQUISPACED
+.. autodata:: pyNFFT3.flags.nfsft_default
+.. autodata:: pyNFFT3.flags.nfsft_nfft_default
+.. autodata:: pyNFFT3.flags.nfsft_default_nfft_cut_off
+.. autodata:: pyNFFT3.flags.nfsft_default_threshold

{pynfft3-0.2.2 → pynfft3-0.2.3}/docs/source/api/nfst.rst

@@ -33,11 +33,11 @@ NFST Attributes
 
       The window size. A larger m results in more accuracy but at a higher computational cost.
 
-   .. attribute:: f1 <c_uint32>
+   .. attribute:: f1 <ctypes.c_uint32>
 
       The NFST flags.
 
-   .. attribute:: f2 <c_unit32>
+   .. attribute:: f2 <ctypes.c_unit32>
 
       The FFTW flags.
 
@@ -63,4 +63,13 @@ NFST Attributes
 
    .. attribute:: finalized <boolean>
 
-      Boolean to indicate if the NFST plan is finalized.
+      Boolean to indicate if the NFST plan is finalized.
+
+NFST Flags
+------------
+.. autodata:: pyNFFT3.flags.NFST_SORT_NODES
+.. autodata:: pyNFFT3.flags.NFST_OMP_BLOCKWISE_ADJOINT
+.. autodata:: pyNFFT3.flags.f1_default_1d
+.. autodata:: pyNFFT3.flags.f1_default
+.. autodata:: pyNFFT3.flags.f2_default
+.. autodata:: pyNFFT3.flags.default_window_cut_off

{pynfft3-0.2.2 → pynfft3-0.2.3}/docs/source/api.rst

@@ -6,4 +6,6 @@ API Contents
    /api/nfft
    /api/nfct
    /api/nfst
+   /api/nfsft
+   /api/fsft
    /api/fastsum

{pynfft3-0.2.2 → pynfft3-0.2.3}/docs/source/conf.py

@@ -72,3 +72,4 @@ exclude_patterns = []
 
 html_theme = "default"
 html_static_path = ["_static"]
+html_css_files = ["custom.css"]

{pynfft3-0.2.2 → pynfft3-0.2.3}/docs/source/index.rst

@@ -15,6 +15,8 @@ pyNFFT3 Documentation
 - nonequispaced fast Fourier transform (NFFT) 
 - nonequispaced fast cosine transform (NFCT) 
 - nonequispaced fast sine transform (NFST)
+- nonequispaced fast spherical Fourier transforms (NFSFT)
+- fast spherical Fourier transforms (FSFT)
 - fast summation (fastsum)
 
 Contents