A Fortran package search tool

The fpm-find tool searches fortran-lang's package index. Designed as a Fortran Package Manager (fpm) plugin, fpm-find also runs as a stand-alone program.

With fpm installed on macOS, Linux, or Windows Subsystem for Linux, and with your present working directory set to any directory inside the fpm-find source tree, enter the following at a terminal-window command line:

fpm install --compiler <compiler-name> --profile release

For help with customizing aspects of your installation, such as the installation path, run fpm install --help or fpm --help (or replace --help with -h).

With fpm and fpm-find in your PATH, search for information about packages that have a given string in their package-index entry by running a command of the following form:

fpm find <search-string> [--url|-u] [--name|-n] [--case|-c]

where angular brackets demarcate user input, square brackets indicate optional arguments, and pipes (|) separate equivalent alternatives. The table below provides more detailed explanations.

If fpm is not in your PATH but fpm-find is, replace fpm find with fpm-find in any commands in this document.

fpm find numerical         # search all package data for "numerical"
fpm find julienne --name   # search package names for "julienne"
fpm find nasa --url --name # search package names and URLs for "nasa"
fpm find BerkeleyLab -u -c # case-sensitive search for "BerkeleyLab" in package URLs 

Before accessing the index installed in $HOME/.local/share/fpm-find/package_index.yml, fpm-find tries to update the index by downloading it from fortran-lang.

Test fpm-find by issuing a command similar to the following one with your present working directory set to anywhere inside the fpm-find source tree:

fpm test --compiler <compiler-name> --profile release

Add compiler-specific flags from the Supported platforms table as needed. For example, with a Homebrew-installed gfortran-13, execute

fpm test --compiler gfortran-13 --profile release --flag -ffree-line-length-none

With the FORD Fortran documentation generator installed in your PATH and your present working directory set to fpm-find's root directory, run

ford ford.md

Open the generated file, doc/html/index.html, in a web browser to view the fpm-find documentation.

Please see LICENSE.txt for the copyright and license under which fpm-find is distributed. To report any issues with building, testing, or using fpm-find, please submit an issue. To contribute code, please submit a pull request from a fork of fpm-find.

fpm-find was developed with funding from the U.S. Department of Energy, Office of Science, Office of Advanced Scientific Computing Research via the Next- Generation Scientific Software Technologies (NGSST) program under Contract No. DE-AC02-05CH11231.