by Ned Thaddeus Taylor
graphstruc is a Fortran library that provides an implementation of graph structures in the form of a derived type.
graphstruc is distributed with the following directories:
| Directory | Description |
|---|---|
| example/ | A set of example programs utilising the library |
| src/ | Source code |
| test/ | A set of unit test programs to check functionality of the library works after compilation |
The library has a compilable documentation this can be accessed with the FORD (FORtran Documenter) tool. The documentation can be compiled using the following terminal command in the root directory of the repository:
ford ford.md
This will generate the doc/html directory, inside which, you will find index.html.
By opening this file in a browser window, you will be able to view a nagivable documentation.
The graphstruc library can be obtained from the git repository. Use the following commands to get started:
git clone https://github.com/nedtaylor/graphstruc.git
cd graphstruc
The library has the following dependencies
The library has been developed and tested using the following compilers:
- gfortran -- gcc 14.1.0
The library is set up to work with the Fortran Package Manager (fpm).
Run the following command in the repository main directory:
fpm build --profile release
To check whether graphstruc has installed correctly and that the compilation works as expected, the following command can be run:
fpm test
This runs a set of test programs (found within the test/ directory) to ensure the expected output occurs when layers and networks are set up.
Run the following commands in the directory containing CMakeLists.txt:
mkdir build
cd build
cmake [-DCMAKE_BUILD_TYPE="optim;mp"] ..
make install
This will build the library in the build/ directory. All library files will then be found in:
${HOME}/.local/graphstruc
Inside this directory, the following files will be generated:
include/graphstruc.mod
lib/libgraphstruc.a
To check whether graphstruc has installed correctly and that the compilation works as expected, the following command can be run:
ctest
This runs a set of test programs (found within the test/ directory) to ensure the expected output occurs when layers and networks are set up.
- Ned Thaddeus Taylor
Please note that this project adheres to the Contributing Guide. If you want to contribute to this project, please first read through the guide.
This work is licensed under an MIT license.