Skip to content

Latest commit

 

History

History
70 lines (58 loc) · 2.19 KB

API-doc-FORD-file.md

File metadata and controls

70 lines (58 loc) · 2.19 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: FORLAB
summary: A opensource package FORLAB v1.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-fans/forlab
project_download: https://github.com/fortran-fans/forlab
favicon: doc/media/favicon.png
license: by-sa
author: FORLAB v1.0 contributors
author_pic: doc/media/Fortran-Fans.png
author_email: [email protected]
github: https://github.com/fortran-fans
dbg: true
parallel: 4
---

[TOC]

@warning This API documentation for the fortran-fans/FORLAB v1.0 is a work in progress

@note Use the navigation bar at the top of the screen to browse modules, procedures, source files, etc. The listings near the bottom of the page are incomplete.

Fortran FORLAB 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.

Goals and Motivation

The Fortran FORLAB v1.0 is a Fortran module that provides a lot of functions for scientific computing mostly inspired by Matlab and Python's module NumPy.
FORLAB is mainly developed by Keurfon Luu. (see keurfonluu/Forlab)

Scope

The goal of the FORLAB is to achieve the following general scope:

  • forlab easy-to-use interface
  • ford-api-doc
  • multi-precision forlab
  • benchmarks

License

FORLAB is released under the MIT License.