Skip to content

Latest commit

 

History

History
77 lines (67 loc) · 2.53 KB

API-doc-FORD-file.md

File metadata and controls

77 lines (67 loc) · 2.53 KB
Error in user YAML: (<unknown>): found character that cannot start any token while scanning for the next token at line 20 column 16
---
project: fftpack
summary: A opensource package fftpack v4.0.0 for (modern) Fortran
src_dir: src/
output_dir: API-doc
page_dir: doc/
media_dir: doc/media
display: public
         protected
source: true
proc_internals: true
md_extensions: markdown.extensions.toc
graph: true
graph_maxnodes: 250
graph_maxdepth: 5
coloured_edges: true
sort: permission-alpha
extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html
            iso_c_binding:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fC_005fBINDING.html#ISO_005fC_005fBINDING
print_creation_date: true
creation_date: %Y-%m-%d %H:%M %z
project_github: https://github.com/fortran-lang/fftpack
license: by-sa
author: Paul N. Swarztrauber & fftpack contributors
github: https://github.com/fortran-lang/fftpack
dbg: true
parallel: 4
---

[TOC]

@warning This API documentation for the fortran-lang/fftpack v4.0.0 is a work in progress.

Fortran FFTPACK API Documentation

This is the main API documentation landing page generated by FORD. The documentation for comment markup in source code, running FORD and the FORD project file are all maintained on the FORD wiki.

A package of fortran subprograms for the fast fourier transform of periodic and other symmetric sequences.

Getting started

Get the code

git clone https://github.com/fortran-lang/fftpack.git
cd fftpack

Build with fortran-lang/fpm

Fortran Package Manager (fpm) is a great package manager and build system for Fortran.
You can build using provided fpm.toml:

fpm build --flag "-O2"
fpm test --flag "-O2" --list
fpm test --flag "-O2" <test_name, see `fpm.toml` or list>

To use fftpack within your fpm project, add the following to your fpm.toml file:

[dependencies]
fftpack = { git="https://github.com/fortran-lang/fftpack.git" }

Build with Make

Alternatively, you can build using provided Makefile:

make

Links

netlib/dfftpack1.0(fftpack4.0)
Documents of fft routines in GNU/gsl based on netlib/fftpack
Documents of scipy.fftpack NACR/FFTPACK 5.1