added FPM support

updates to readme and added logo

Author: jacobwilliams

.github/workflows/CI.yml

@@ -28,11 +28,16 @@ jobs:
     - name: Setup Graphviz
       uses: ts-graphviz/setup-graphviz@v1
 
+    - name: Setup Fortran Package Manager
+      uses: fortran-lang/setup-fpm@v3
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+
     - name: Install Python dependencies
       if: contains( matrix.os, 'ubuntu')
       run: |
         python -m pip install --upgrade pip
-        pip install ford FoBiS.py
+        pip install ford 
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
 
     - name: Install GFortran Linux
@@ -46,13 +51,10 @@ jobs:
         --slave /usr/bingcov gcov /usr/bin/gcov-${GCC_V}
 
     - name: Compile
-      run: |
-        FoBiS.py build -f numdiff.fobis -mode tests-gnu
+      run: fpm build --profile release
 
     - name: Run tests
-      run: |
-        ./bin/dsm_test
-        ./bin/test1
+      run: fpm test
 
     - name: Build documentation
       run: ford ./numdiff.md

README.md

@@ -1,14 +1,15 @@
-# NumDiff
+![NumDiff](media/logo.png)
+============
 
 ## Brief description
 
-NumDiff provides a modern Fortran interface for computing the Jacobian (derivative) matrix of `m` nonlinear functions which depend on `n` variables. The Jacobian matrix is required for various applications, including numerical optimization. The library also provides for computing the sparsity of this matrix, and returning the Jacobian in sparse or dense form.
+**NumDiff** provides a modern Fortran interface for computing the Jacobian (derivative) matrix of `m` nonlinear functions which depend on `n` variables. The Jacobian matrix is required for various applications, including numerical optimization. It can also be used to test the accuracy of gradients computed by other means. The library also provides for computing the sparsity of this matrix, and returning the Jacobian in sparse or dense form.
 
 ## Status
 
 ![CI Status](https://github.com/jacobwilliams/NumDiff/actions/workflows/CI.yml/badge.svg)
 
-This is currently an experimental work in progress and is not production ready. The goal is a comprehensive library that contains a full suite of computationally efficient implementations of algorithms for sparsity determination and numerical differentiation. This code is hosted on GitHub at: https://github.com/jacobwilliams/NumDiff
+This is currently a work in progress. The goal is a comprehensive library that contains a full suite of computationally efficient implementations of algorithms for sparsity determination and numerical differentiation. This code is hosted on GitHub at: https://github.com/jacobwilliams/NumDiff
 
 ### To Do
 
@@ -43,6 +44,22 @@ This is currently an experimental work in progress and is not production ready.
 
 ## Building NumDiff
 
+### FPM
+
+A `fmp.toml` file is provided for compiling roots-fortran with the [Fortran Package Manager](https://github.com/fortran-lang/fpm). For example, to build:
+
+```
+  fpm build --profile release
+```
+
+And to run the unit tests:
+
+```
+  fpm test
+```
+
+### FoBiS
+
 A [FoBiS](https://github.com/szaghi/FoBiS) configuration file (`numdiff.fobis`) is also provided that can also build the library and examples. Use the `mode` flag to indicate what to build. For example:
 
   * To build all the examples using gfortran: `FoBiS.py build -f numdiff.fobis -mode tests-gnu`

fpm.toml

@@ -0,0 +1,29 @@
+name = "NumDiff"
+version = "1.5.0"
+author = "Jacob Williams"
+maintainer = "Jacob Williams"
+copyright = "Copyright (c) 2016-2021, Jacob Williams"
+license = "BSD-3"
+description = "Modern Fortran Numerical Differentiation Library"
+homepage = "https://github.com/jacobwilliams/NumDiff"
+
+[library]
+source-dir = "src"
+
+[install]
+library = true
+
+[build]
+auto-executables = false
+auto-examples = false
+auto-tests = false
+
+[[test]]
+name = "dsm_test"
+source-dir = "tests"
+main = "dsm_test.f90"
+
+[[test]]
+name = "test1"
+source-dir = "tests"
+main = "test1.f90"

media/logo.png

@@ -25,7 +25,7 @@ cflags_heritage = True
 build_dir       = ./lib/
 mod_dir         = ./mod/
 obj_dir         = ./obj/
-src             = ./src/
+src             = ./
 colors          = True
 quiet           = False
 log             = False
@@ -40,7 +40,7 @@ cflags_heritage = True
 build_dir       = ./lib/
 mod_dir         = ./mod/
 obj_dir         = ./obj/
-src             = ./src/
+src             = ./
 colors          = True
 quiet           = False
 log             = False
@@ -55,7 +55,7 @@ cflags_heritage = True
 build_dir       = ./bin/
 mod_dir         = ./mod/
 obj_dir         = ./obj/
-src             = ./src/
+src             = ./
 colors          = True
 quiet           = False
 log             = False

numdiff.fobis

@@ -1,6 +1,7 @@
 project: NumDiff
 project_dir: ./src
 output_dir: ./doc
+media_dir: ./media
 project_github: https://github.com/jacobwilliams/NumDiff
 summary: NumDiff -- Numerical Differentiation Library
 author: Jacob Williams