Contents of the packageΒΆ

  • finufft-manual.pdf : the manual (auto-generated by sphinx)
  • docs : source files for documentation (.rst files are human-readable)
  • README.md : github-facing (and human text-reader) doc info
  • LICENSE : how you may use this software
  • CHANGELOG : list of changes, release notes
  • TODO : list of things needed to fix or extend (hackers please help)
  • makefile : GNU makefile (there are no makefiles in subdirectories)
  • src : main library source and headers. Compiled objects will be built here
  • lib : dynamic library will be built here
  • lib-static : static library will be built here
  • test : validation and performance tests, bash scripts driving compiled C++
    • test/check_finufft.sh is the main pass-fail validation bash script
    • test/nuffttestnd.sh is a simple uniform-point performance test bash script
    • test/results : validation comparison outputs (*.refout; do not remove these), and local test and performance outputs (*.out; you may remove these)
  • examples : simple example codes for calling the library from C++ and C
  • fortran : wrappers and drivers for Fortran (see fortran/README)
  • matlab : wrappers and examples for MATLAB/octave
  • finufftpy : python wrappers
  • python_tests : accuracy and speed tests and examples using the python wrappers
  • setup.py : needed so pip or pip3 can build and install the python wrappers
  • contrib : 3rd-party code