Skip to content

API Reference ​

The API section documents every module, type and procedure, generated from the source comments by formal:

bash
cd docs
npm run docs:api      # formal generate --mirror-sources --diagrams --project ford.md --output api

npm run docs:dev and npm run docs:build regenerate it first.

Public entry point ​

use foresight exports:

EntityModulePurpose
figure_objectforesight_figurefigure with the gnuplot-like API — see Fortran Library
script_objectforesight_scriptgnuplot subset interpreter — see Scripts from Fortran
rename_file, sleep_msforesight_sysatomic rename and sub-second sleep (libc)
I4P, I8P, R4P, R8PPENFkind parameters

The other modules are internal: their interfaces may change without notice.