Skip to content

Commit ad292d7

Browse files
jacobwilliamsjacobwilliams
committed
added CI
updated readme
1 parent acac0f4 commit ad292d7

File tree

5 files changed

+248
-2
lines changed

5 files changed

+248
-2
lines changed

‎.github/workflows/CI.yml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: CI
2+
on: [push]
3+
jobs:
4+
5+
Build:
6+
runs-on: ${{ matrix.os }}
7+
strategy:
8+
fail-fast: false
9+
matrix:
10+
os: [ubuntu-latest]
11+
gcc_v: [9] # Version of GFortran we want to use.
12+
python-version: [3.7]
13+
env:
14+
FC: gfortran-${{ matrix.gcc_v }}
15+
GCC_V: ${{ matrix.gcc_v }}
16+
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v2
20+
with:
21+
submodules: recursive
22+
23+
- name: Install Python
24+
uses: actions/setup-python@v1 # Use pip to install latest CMake, & FORD/Jin2For, etc.
25+
with:
26+
python-version: ${{ matrix.python-version }}
27+
28+
- name: Setup Graphviz
29+
uses: ts-graphviz/setup-graphviz@v1
30+
31+
- name: Install Python dependencies
32+
if: contains( matrix.os, 'ubuntu')
33+
run: |
34+
python -m pip install --upgrade pip
35+
pip install ford FoBiS.py
36+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
37+
38+
- name: Install GFortran Linux
39+
if: contains( matrix.os, 'ubuntu')
40+
run: |
41+
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
42+
sudo apt-get update
43+
sudo apt-get install -y gcc-${GCC_V} gfortran-${GCC_V}
44+
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-${GCC_V} 100 \
45+
--slave /usr/bin/gfortran gfortran /usr/bin/gfortran-${GCC_V} \
46+
--slave /usr/bingcov gcov /usr/bin/gcov-${GCC_V}
47+
48+
- name: Compile
49+
run: |
50+
FoBiS.py build -f astro-fortran.fobis -mode tests-gnu
51+
52+
- name: Run tests
53+
run: |
54+
./bin/t_sofa_f
55+
56+
- name: Build documentation
57+
run: ford ./astro-fortran.md
58+
59+
- name: Deploy Documentation
60+
if: github.ref == 'refs/heads/master'
61+
uses: JamesIves/github-pages-deploy-action@4.1.0
62+
with:
63+
branch: gh-pages # The branch the action should deploy to.
64+
folder: doc # The folder the action should deploy.

‎.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,7 @@
3535
bin
3636
doc
3737
lib
38-
archive
38+
archive
39+
40+
# mac
41+
.DS_Store

‎LICENSE.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ASTRO-FORTRAN: Modern Fortran implementations of standard models used in fundamental astronomy
22
https://github.com/jacobwilliams/astro-fortran
33

4-
Copyright (c) 2019, Jacob Williams
4+
Copyright (c) 2019-2021, Jacob Williams
55
All rights reserved.
66

77
Redistribution and use in source and binary forms, with or without modification,

‎README.md

+23
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,29 @@ A refactoring of the IAU SOFA library to modern Fortran standards.
55

66
This is based on the 2019-07-22 Fortran 77 SOFA Release.
77

8+
### Status
9+
10+
![CI Status](https://github.com/jacobwilliams/astro-fortran/actions/workflows/CI.yml/badge.svg)
11+
12+
## Building
13+
14+
A [FoBiS](https://github.com/szaghi/FoBiS) configuration file (`astro-fortran.fobis`) is also provided that can also build the library and examples. Use the `mode` flag to indicate what to build. For example:
15+
16+
* To build all the examples using gfortran: `FoBiS.py build -f astro-fortran.fobis -mode tests-gnu`
17+
* To build all the examples using ifort: `FoBiS.py build -f astro-fortran.fobis -mode tests-intel`
18+
* To build a static library using gfortran: `FoBiS.py build -f astro-fortran.fobis -mode static-gnu`
19+
* To build a static library using ifort: `FoBiS.py build -f astro-fortran.fobis -mode static-intel`
20+
21+
The full set of modes are: `static-gnu`, `static-gnu-debug`, `static-intel`, `static-intel-debug`, `shared-gnu`, `shared-gnu-debug`, `shared-intel`, `shared-intel-debug`, `tests-gnu`, `tests-gnu-debug`, `tests-intel`, `tests-intel-debug`
22+
23+
To generate the documentation using [ford](https://github.com/Fortran-FOSS-Programmers/ford), run: ```FoBis.py rule --execute makedoc -f astro-fortran.fobis```
24+
25+
To run the test programs, run: ```FoBis.py rule --execute tests -f astro-fortran.fobis```
26+
27+
## Documentation
28+
29+
The latest API documentation can be found [here](http://jacobwilliams.github.io/astro-fortran/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford) (note that the included `build.sh` script will also generate these files).
30+
831
### License
932

1033
The astro-fortran source code and related files and documentation are distributed under a permissive free software [license](https://github.com/jacobwilliams/astro-fortran/blob/master/LICENSE.txt) (BSD-style).

‎astro-fortran.fobis

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
[modes]
2+
modes = static-gnu static-gnu-debug
3+
static-intel static-intel-debug
4+
shared-gnu shared-gnu-debug
5+
shared-intel shared-intel-debug
6+
tests-gnu tests-gnu-debug
7+
tests-intel tests-intel-debug
8+
9+
[common-variables]
10+
$MOD_FILE = astro_module.f90
11+
$FORD_FILE = astro-fortran.md
12+
$STATIC_LIB = libastrofortran.a
13+
$SHARED_LIB = libastrofortran.so
14+
$OPTIMIZE = -O2
15+
$CSTATIC_GNU = -c -fbacktrace -Wall -Wextra -Wno-maybe-uninitialized -Wno-unused-function -pedantic -std=f2008ts
16+
$DEBUG_GNU = -O0 -g3 -Warray-bounds -Wcharacter-truncation -Wline-truncation -Wimplicit-interface -Wimplicit-procedure -Wunderflow -fcheck=all -fmodule-private -ffree-line-length-132 -fimplicit-none -fbacktrace -fdump-core -finit-real=nan -std=f2008ts -fall-intrinsics
17+
$CSTATIC_INT = -c -std18
18+
$DEBUG_INT = -O0 -debug all -check all -warn all -extend-source 132 -traceback -gen-interfaces -fpe-all=0 -fp-stack-check -fstack-protector-all -ftrapuv -no-ftz -std18
19+
$EXCLUDE_DIRS = ./archive
20+
./tmp
21+
22+
# modes templates
23+
[template-static]
24+
cflags_heritage = True
25+
build_dir = ./lib/
26+
mod_dir = ./mod/
27+
obj_dir = ./obj/
28+
src = ./src/
29+
colors = True
30+
quiet = False
31+
log = False
32+
jobs = 2
33+
mklib = static
34+
target = $MOD_FILE
35+
output = $STATIC_LIB
36+
exclude_dirs = $EXCLUDE_DIRS
37+
38+
[template-shared]
39+
cflags_heritage = True
40+
build_dir = ./lib/
41+
mod_dir = ./mod/
42+
obj_dir = ./obj/
43+
src = ./src/
44+
colors = True
45+
quiet = False
46+
log = False
47+
jobs = 2
48+
mklib = shared
49+
target = $MOD_FILE
50+
output = $SHARED_LIB
51+
exclude_dirs = $EXCLUDE_DIRS
52+
53+
[template-tests]
54+
cflags_heritage = True
55+
build_dir = ./bin/
56+
mod_dir = ./mod/
57+
obj_dir = ./obj/
58+
src = ./src/
59+
colors = True
60+
quiet = False
61+
log = False
62+
jobs = 2
63+
exclude_dirs = $EXCLUDE_DIRS
64+
65+
# main modes
66+
67+
# library
68+
[static-gnu]
69+
description = Build library with GNU gfortran by optimized-static flags
70+
compiler = gnu
71+
cflags = $CSTATIC_GNU $OPTIMIZE
72+
template = template-static
73+
74+
[static-gnu-debug]
75+
description = Build library with GNU gfortran by debug-static flags
76+
compiler = gnu
77+
cflags = $CSTATIC_GNU $DEBUG_GNU
78+
template = template-static
79+
80+
[static-intel]
81+
description = Build library with Intel Fortran by optimized-static flags
82+
compiler = intel
83+
cflags = $CSTATIC_INT $OPTIMIZE
84+
template = template-static
85+
86+
[static-intel-debug]
87+
description = Build library with Intel Fortran by debug-static flags
88+
compiler = intel
89+
cflags = $CSTATIC_INT $DEBUG_INT
90+
template = template-static
91+
92+
[shared-gnu]
93+
description = Build library with GNU gfortran by optimized-shared flags
94+
compiler = gnu
95+
cflags = $CSTATIC_GNU $OPTIMIZE
96+
template = template-shared
97+
98+
[shared-gnu-debug]
99+
description = Build library with GNU gfortran by debug-shared flags
100+
compiler = gnu
101+
cflags = $CSTATIC_GNU $DEBUG_GNU
102+
template = template-shared
103+
104+
[shared-intel]
105+
description = Build library with Intel Fortran by optimized-shared flags
106+
compiler = intel
107+
cflags = $CSTATIC_INT $OPTIMIZE
108+
template = template-shared
109+
110+
[shared-intel-debug]
111+
description = Build library with Intel Fortran by debug-shared flags
112+
compiler = intel
113+
cflags = $CSTATIC_INT $DEBUG_INT
114+
template = template-shared
115+
116+
# test programs
117+
[tests-gnu]
118+
description = Build all tests with GNU gfortran by optimized-static flags
119+
compiler = gnu
120+
cflags = $CSTATIC_GNU $OPTIMIZE
121+
template = template-tests
122+
123+
[tests-gnu-debug]
124+
description = Build all tests with GNU gfortran by debug-static flags
125+
compiler = gnu
126+
cflags = $CSTATIC_GNU $DEBUG_GNU
127+
template = template-tests
128+
129+
[tests-intel]
130+
description = Build all tests with Intel Fortran by optimized-static flags
131+
compiler = intel
132+
cflags = $CSTATIC_INT $OPTIMIZE
133+
template = template-tests
134+
135+
[tests-intel-debug]
136+
description = Build all tests with Intel Fortran by debug-static flags
137+
compiler = intel
138+
cflags = $CSTATIC_INT $DEBUG_INT
139+
template = template-tests
140+
141+
# auxiliary rules
142+
[rule-makedoc]
143+
help = Rule for building documentation from source files
144+
rule_1 = ford $FORD_FILE
145+
146+
[rule-tests]
147+
help = Rule for running the test programs
148+
rule_1 = (cd bin
149+
GLOBIGNORE='*.*'
150+
ls slsqp_test_* | sed 's/^\([^0-9]*\)\([0-9]*\)/\1 \2/' | sort -k2,2n | tr -d ' ' |
151+
while read TEST; do
152+
echo ""
153+
echo "Running ${TEST}"
154+
"./${TEST}"
155+
done)
156+

0 commit comments

Comments
 (0)