Skip to content

Commit a6f5983

Browse files
rem1776rem1776
authored andcommitted
update the various .md files
1 parent f13435f commit a6f5983

4 files changed

Lines changed: 46 additions & 42 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ enough information so someone can reproduce your tests.
1414
- [ ] My code follows the style guidelines of this project
1515
- [ ] I have performed a self-review of my own code
1616
- [ ] I have commented my code, particularly in hard-to-understand areas
17-
- [ ] I have made corresponding changes to the documentation
18-
- [ ] My changes generate no new warnings
19-
- [ ] Any dependent changes have been merged and published in downstream modules
20-
- [ ] New check tests, if applicable, are included
21-
- [ ] `make distcheck` passes
17+
- [ ] I have made corresponding changes to the inline documentation (see STYLE_GUIDE.md for more info)
18+
- [ ] My changes generate no new compiler warnings
19+
- [ ] All added code is tested by a unit test, either by modifying an existing test or creating a new one
20+
- [ ] Code compiles with both build systems (cmake and autotools)
21+
- [ ] `make distcheck` is able to compile, test, and package the library
2222

CI.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ Required CI for pull requests are listed first.
77

88
## Pull Request CI and checks
99

10-
### Build libFMS with autotools
10+
### Build libFMS with autotools using GCC
1111

1212
Required GNU build test for all pull requests/pushes.
1313
Runs `make distcheck` after configuring via GNU autotools.
1414

1515
Runs on a container image with spack installed dependencies, on top a rocky linux base.
1616

17-
Dockerfile for image is stored at .github/workflows/Dockerfile.gnu for more specific information on the CI environment.
17+
Dockerfile for image is stored in the [HPC-ME repository](github.com/noaa-gfdl/hpc-me).
1818

1919
Container environment:
20-
gcc v12.3.0
20+
gcc v13.2.0
2121
mpich v4.0.2
22-
netcdf v4.9.0
23-
netcdf-fortran v4.6.0
22+
netcdf-c v4.9.2
23+
netcdf-fortran v4.6.1
2424
autoconf v2.69
2525
libyaml v0.2.5
2626

@@ -33,25 +33,39 @@ libyaml v0.2.5
3333
- `--enable-test-input=/home/unit_tests_input`
3434

3535

36-
### Build libfms with cmake
36+
### Build libfms with cmake using GCC
3737
Required GNU build test for all pull requests/pushes.
3838
Runs `make` after configuring via cmake.
3939

40-
Container environment:
41-
gcc v7.3.0
42-
mpich v3.3a2
43-
netcdf v4.6.0
44-
netcdf-fortran v4.4.4
45-
cmake v3.22.0
46-
47-
container hosted at [noaagfdl/ubuntu_libfms_gnu:latest](https://hub.docker.com/r/noaagfdl/ubuntu_libfms_gnu)
48-
4940
cmake flags:
5041
- `-DOPENMP=on`
5142
- `-DOPENMP=on`
5243
- `-DWITH_YAML=on`
5344
- `-D64BIT=on`
5445

46+
47+
### Build libfms with autotools using Intel Oneapi Compilers
48+
49+
Required build test for all pull requests. Workflow will build hdf5, netcdf, and libyaml and cache them for reuse. Cache can be used for a week before clearing.
50+
51+
Test Environment:
52+
intel-oneapi v2025.3.0
53+
hdf5 v1.14.6
54+
netcdf-c v4.9.3
55+
netcdf-fortran v4.6.2
56+
libyaml v0.2.5
57+
58+
### Build libfms with autotools using Intel Classic Compilers
59+
60+
This test is triggered weekly on Sundays @ midnight and uses the intel 2023.1 classic compilers (ie. ifort/icc).
61+
62+
Test Environment:
63+
intel-oneapi v2025.3.0
64+
hdf5 v1.12.2
65+
netcdf-c v4.8.1
66+
netcdf-fortran v4.6.0
67+
libyaml v0.2.5
68+
5569
### libFMS lint tests
5670
Required test for all pull requests.
5771
Checks code for line lengths, tabs, and trailing whitespace in accordance with
@@ -60,9 +74,9 @@ The action is hosted on github [here](https://github.com/NOAA-GFDL/simple_lint).
6074

6175
## Parallelworks CI
6276
The following CI workflows run on self-hosted runners through the parallelworks platform.
63-
### Pull Request CI libFMS with intel
64-
Optional(does not need to pass to merge) intel build test hosted on the parallelworks platform.
65-
Runs `make check` with intel 18 and 21 compilers for all pull requests.
6677

67-
### Tag CI libFMS with AM4 regression
68-
On alpha or beta tag creation, compiles and runs full AM4 model regression testing using the new FMS tag on parallelworks.
78+
### AM5 testing
79+
80+
On all pull requests, a full scale model test is compiled using the `c96L65_am5f11d12r0_amip` experiment from AM5 and run on a parallelworks cluster.
81+
82+
This test will compile with debug flags and openmp enabled for a basic regression test.

INSTALL.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,6 @@ For more information on building with autotools and build options please see
7676

7777
To build using CMake, follow the instructions in
7878
[CMAKE_INSTRUCTIONS.mk](https://github.com/NOAA-GFDL/FMS/blob/main/CMAKE_INSTRUCTIONS.md).
79-
Currently the CMake configuration is the most restrictive build option as the
80-
compiler flags are immutable.
8179

8280
### GFDL MKMF
8381

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# License Announcement
2-
3-
FMS will switch to the
4-
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
5-
with the 2025.04 release scheduled for September 2025. Please refer to
6-
[issue 1683 on changing the license](https://github.com/NOAA-GFDL/FMS/issues/1683)
7-
to participate in or follow any discussion on the topic.
8-
91
# Modeling Framework: Flexible Modeling System (FMS)
102

113
Today’s climate models simulate highly complex systems. In response to
@@ -97,13 +89,13 @@ Compilers used in our Github continuous integration testing are in bold.
9789

9890
|Compiler | Version |Builds Successfully | Unit Testing |
9991
|------------------------|---------|---------------------------|---------------------|
100-
|**intel classic(ifort)**| 2021.6.0| yes | passes |
101-
|**GNU (gfortran)** | 9.3.0 | yes | passes |
102-
|intel oneapi (ifx) | 2021.6.0| yes | passes |
103-
|GNU (gfortran) | 11.2.0 | yes | passes |
104-
|HP/Cray (cce) | 9.1.1 | yes | not passing |
105-
|Nvidia/PGI(nvfortran) | 22.9 | no | not passing |
106-
|AMD (aocc) | 3.2.0 | no(compiles,fails to link)| not passing |
92+
|**intel oneapi(ifx)** | 2025.3.0| yes | passes |
93+
|**intel classic(ifort)**| 2023.2.0| yes | passes |
94+
|**GNU (gfortran)** | 13.2.0 | yes | passes |
95+
|GNU (gfortran) | 15.3.0 | yes | not all passing |
96+
|HP/Cray (cce) | 9.1.1 | yes | not all passing |
97+
|Nvidia(nvfortran) | 24.9 | no | n/a |
98+
|AMD (aocc) | 3.2.0 | no(compiles,fails to link)| n/a |
10799

108100
## Documentation
109101

0 commit comments

Comments
 (0)