Merge pull request #25 from ludvigak/github-actions

Switch CI to GitHub Actions

.github/workflows/CI.yml

@@ -0,0 +1,46 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+    tags: '*'
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.3'
+          - '1.4'
+#          - 'nightly'
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v1
+        with:
+          file: lcov.info

.github/workflows/Documenter.yml

@@ -0,0 +1,18 @@
+name: Documenter
+on:
+  push:
+    branches: [master]
+    tags: [v*]
+  pull_request:
+
+jobs:
+  Documenter:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/julia-buildpkg@latest
+      - uses: julia-actions/julia-docdeploy@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

README.md

@@ -1,7 +1,7 @@
 # FINUFFT.jl
 
-[![Build Status](https://travis-ci.org/ludvigak/FINUFFT.jl.svg?branch=master)](https://travis-ci.org/ludvigak/FINUFFT.jl)
-[![Coverage Status](https://coveralls.io/repos/github/ludvigak/FINUFFT.jl/badge.svg?branch=master)](https://coveralls.io/github/ludvigak/FINUFFT.jl?branch=master)
+![CI](https://github.com/ludvigak/FINUFFT.jl/workflows/CI/badge.svg?branch=master)
+[![codecov](https://codecov.io/gh/ludvigak/FINUFFT.jl/branch/master/graph/badge.svg?token=Tkx7kma18J)](https://codecov.io/gh/ludvigak/FINUFFT.jl)
 [![](https://img.shields.io/badge/docs-latest-blue.svg)](https://ludvigak.github.io/FINUFFT.jl/latest/)
 
 This is a Julia interface to [FINUFFT](https://github.com/flatironinstitute/finufft), a lightweight and fast nonuniform FFT (nufft) library released by the Flatiron Institute.

src/FINUFFT.jl

@@ -27,11 +27,9 @@ const BIGINT = Int64 # defined in src/finufft.h
     mutable struct nufft_opts    
         modeord             :: Cint
         chkbnds             :: Cint              
-        # 
         debug               :: Cint                
         spread_debug        :: Cint         
         showwarn            :: Cint
-        # 
         nthreads            :: Cint
         fftw                :: Cint                 
         spread_sort         :: Cint          
@@ -48,54 +46,86 @@ Options struct passed to the FINUFFT library.
 
 # Fields
 
-modeord :: Cint 
-    (type 1,2 only):    0: CMCL-style increasing mode order
-                        1: FFT-style mode order
-chkbnds :: Cint
-    0: don't check NU pts in [-3pi,3pi)
-    1: do (<few % slower)
-
-# diagnostic opts...
-debug :: Cint
-    0: silent
-    1: some timing/debug
-    2: more
-spread_debug :: Cint
-    0: silent
-    1: some timing/debug
-    2: tonnes
-showwarn :: Cint
-    0: don't print warnings to stderr
-    1: do
-
-# algorithm performance opts...
-nthreads :: Cint
-    number of threads to use, or 0 uses all available
-fftw :: Cint
-    plan flags to FFTW (FFTW_ESTIMATE=64, FFTW_MEASURE=0,...)
-spread_sort :: Cint
-    0: don't sort
-    1: do
-    2: heuristic choice
-spread_kerevalmeth :: Cint
-    0: exp(sqrt()) spreading kernel
-    1: Horner piecewise poly (faster)
-spread_kerpad :: Cint
-    option only for exp(sqrt())
-    0: don't pad kernel to 4n
-    1: do
-upsampfac :: Cdouble
-    upsampling ratio sigma: 2.0 std, 1.25 small FFT, 0.0 auto
-spread_thread :: Cint
-    (vectorized ntr>1 only):    0: auto, 1: seq multithreaded,
-                                2: parallel single-thread spread
-maxbatchsize :: Cint
-    option for vectorized ntr>1 only
-    max transform batch, 0 auto
-spread_nthr_atomic :: Cint
-    if >=0, threads above which spreader OMP critical goes atomic
-spread_max_sp_size :: Cint
-    if >0, overrides spreader (dir=1) max subproblem size
+## Data handling opts
+
+    modeord :: Cint 
+
+(type 1,2 only):    0: CMCL-style increasing mode order,
+                    1: FFT-style mode order
+
+    chkbnds :: Cint
+    
+0: don't check NU pts in [-3pi,3pi),
+1: do (<few % slower)
+
+## Diagnostic opts
+
+    debug :: Cint
+
+0: silent,
+1: some timing/debug,
+2: more
+
+    spread_debug :: Cint
+
+0: silent,
+1: some timing/debug,
+2: tonnes
+
+    showwarn :: Cint
+
+0: don't print warnings to stderr,
+1: do
+
+
+## Algorithm performance opts
+
+    nthreads :: Cint
+
+number of threads to use, or 0 uses all available
+
+    fftw :: Cint
+
+plan flags to FFTW (`FFTW_ESTIMATE`=64, `FFTW_MEASURE`=0,...)
+
+    spread_sort :: Cint
+
+0: don't sort,
+1: do,
+2: heuristic choice
+
+    spread_kerevalmeth :: Cint
+
+0: exp(sqrt()) spreading kernel,
+1: Horner piecewise poly (faster)
+
+    spread_kerpad :: Cint
+
+option only for exp(sqrt()).
+0: don't pad kernel to 4n,
+1: do
+
+    upsampfac :: Cdouble
+
+upsampling ratio sigma: 2.0 std, 1.25 small FFT, 0.0 auto
+
+    spread_thread :: Cint
+
+(vectorized ntr>1 only):    0: auto, 1: seq multithreaded,
+                            2: parallel single-thread spread
+
+    maxbatchsize :: Cint
+
+option for vectorized ntr>1 only:
+max transform batch, 0 auto
+
+    spread_nthr_atomic :: Cint
+
+if >=0, threads above which spreader OMP critical goes atomic
+
+    spread_max_sp_size :: Cint
+
+if >0, overrides spreader (dir=1) max subproblem size
 
 """
 mutable struct nufft_opts