|
| 1 | +--- |
| 2 | +project: fftpack |
| 3 | +summary: A opensource package fftpack v4.0.0 for (modern) Fortran |
| 4 | +src_dir: src/ |
| 5 | +output_dir: API-doc |
| 6 | +page_dir: doc/ |
| 7 | +media_dir: doc/media |
| 8 | +display: public |
| 9 | + protected |
| 10 | +source: true |
| 11 | +proc_internals: true |
| 12 | +md_extensions: markdown.extensions.toc |
| 13 | +graph: true |
| 14 | +graph_maxnodes: 250 |
| 15 | +graph_maxdepth: 5 |
| 16 | +coloured_edges: true |
| 17 | +sort: permission-alpha |
| 18 | +extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html |
| 19 | + iso_c_binding:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fC_005fBINDING.html#ISO_005fC_005fBINDING |
| 20 | +print_creation_date: true |
| 21 | +creation_date: %Y-%m-%d %H:%M %z |
| 22 | +project_github: https://github.com/certik/fftpack |
| 23 | +license: by-sa |
| 24 | +author: Paul N. Swarztrauber & fftpack contributors |
| 25 | +github: https://github.com/certik/fftpack |
| 26 | +dbg: true |
| 27 | +parallel: 4 |
| 28 | +--- |
| 29 | + |
| 30 | +[TOC] |
| 31 | + |
| 32 | +@warning This API documentation for the certik/fftpack v4.0.0 is a work in progress. |
| 33 | + |
| 34 | +Fortran FFTPACK API Documentation |
| 35 | +================================= |
| 36 | + |
| 37 | +This is the main API documentation landing page generated by [FORD]. |
| 38 | +The documentation for comment markup in source code, running [FORD] and the [FORD project file] are all maintained on the [FORD wiki]. |
| 39 | + |
| 40 | +[FORD]: https://github.com/Fortran-FOSS-Programmers/ford#readme |
| 41 | +[FORD wiki]: https://github.com/Fortran-FOSS-Programmers/ford/wiki |
| 42 | +[FORD project file]: https://github.com/certik/fftpack/blob/master/API-doc-FORD-file.md |
| 43 | + |
| 44 | +A package of fortran subprograms for the fast fourier transform of periodic and other symmetric sequences. |
| 45 | + |
| 46 | +## Getting started |
| 47 | +### Get the code |
| 48 | +```bash |
| 49 | +git clone https://github.com/certik/fftpack.git |
| 50 | +cd fftpack |
| 51 | +``` |
| 52 | + |
| 53 | +### Build with [fortran-lang/fpm](https://github.com/fortran-lang/fpm) |
| 54 | +Fortran Package Manager (fpm) is a great package manager and build system for Fortran. |
| 55 | +You can build using provided `fpm.toml`: |
| 56 | +```bash |
| 57 | +fpm build --flag "-O2" |
| 58 | +fpm test --flag "-O2" tstfft |
| 59 | +``` |
| 60 | +To use `fftpack` within your `fpm` project, add the following to your `fpm.toml` file: |
| 61 | +```toml |
| 62 | +[dependencies] |
| 63 | +fftpack = { git="https://github.com/certik/fftpack.git" } |
| 64 | +``` |
| 65 | + |
| 66 | +## Build with Make |
| 67 | +Alternatively, you can build using provided `Makefile`: |
| 68 | +```bash |
| 69 | +make |
| 70 | +``` |
| 71 | + |
| 72 | +## Links |
| 73 | +[netlib/dfftpack1.0(fftpack4.0)](http://www.netlib.org/fftpack/) |
| 74 | + |
0 commit comments