Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation CI #489

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
03bc392
Fixes for adding ensemble member number to output filenames (#334)
BenjaminBlake-NOAA Apr 19, 2024
213b0e7
Set smoke_forecast=1 for all RRFS physics suites. (#337)
hu5970 Apr 19, 2024
a970efd
adding RTMA-specific conditions for BUFRSND workflow component. (#339)
EdwardColon-NOAA Apr 22, 2024
7ab6382
Update fix/lam and fix/gsi, and configure files for CONUS 13km grid. …
hu5970 Apr 22, 2024
c9a0268
Add FED cutoff to tile preprocessing (#345)
AmandaBack-NOAA Apr 22, 2024
b5a66bc
1) cycle the smoke at 18Z based on the tracer file during production …
hu5970 Apr 25, 2024
cd6c063
Disabling time decoding when reading RAVE v2 (#349)
JohanaRomeroAlvarez Apr 26, 2024
4ccd51b
Updates params_grib2_tbl_new for latest UPP. (#350)
EricJames-NOAA Apr 26, 2024
c89c6b5
Turn off FAA grib2 output for ensemble forecasts (#353)
BenjaminBlake-NOAA Apr 29, 2024
c5220fd
Update subsetting procedure in run_prdgen task (#354)
BenjaminBlake-NOAA Apr 29, 2024
d4341a1
Updates the UPP hash (picks up exp1 ceiling modification) (#359)
jaymes-kenyon May 3, 2024
b46c6f0
Updates RRFS postxconfig file to be consistent with latest UPP change…
EricJames-NOAA May 3, 2024
4667231
Adapts f00 and f01 .xml and postxconfig txt files for RRFS to the lat…
MatthewPyle-NOAA May 6, 2024
acc4e30
Remove smoke and dust products from ensemble member and firewx grib2 …
BenjaminBlake-NOAA May 6, 2024
dbd5f68
Update GSI and model hash, and fix small bugs. (#367)
hu5970 May 10, 2024
9beb277
Updating RRFS control files to be consistent with latest UPP, and upd…
EricJames-NOAA May 10, 2024
347e57d
Fixes build issues with latest workflow hash (#369)
MatthewPyle-NOAA May 14, 2024
0fc617c
Update remaining post control files for latest UPP updates (#368)
BenjaminBlake-NOAA May 15, 2024
b7024c6
Update GVF code and script for applying it in cold start cycle. (#372)
hu5970 May 15, 2024
a5189c4
Shifts stochastic pattern generation interval from 360 s to 180 s (#…
MatthewPyle-NOAA May 15, 2024
8d469d1
Add compiling option for parallel restart (#376)
hu5970 May 22, 2024
f1e01c3
Updates g2tmpl and fms modules for Hera and Jet compilation (#377)
hu5970 May 22, 2024
f72aac5
Appending the GRIB2 recod "CEIL:cloud ceiling" to the testbed files. …
jaymes-kenyon May 22, 2024
f369a8d
Updating diag tables to include clear sky downwelling solar. (#379)
EricJames-NOAA May 22, 2024
1e48e1b
Add WMO header processing for FAA and AWIPS (#370)
hsinmulin-NOAA May 31, 2024
faa76cd
[dev-sci] Brings in latest ensemble forecast settings (#385)
MatthewPyle-NOAA Jun 10, 2024
6e84e6b
Updates UPP hash, and sets SPPINT=36 everywhere. (#390)
MatthewPyle-NOAA Jun 12, 2024
96eb3c5
Update test period in real-time configure files. (#392)
hu5970 Jun 12, 2024
fa2e0cc
[dev-sci] Updates RRFS UPP flat files to match the latest from UPP (#…
MatthewPyle-NOAA Jun 17, 2024
bb3d95e
Switch EnKF spinup cycle prep_cyc and prep_cyc_ensinit task names (#416)
hu5970 Jul 2, 2024
3050755
Smoke emissions prep updates (#418)
JohanaRomeroAlvarez Jul 9, 2024
84e5c9a
Update model hash to latest version (#8c126a7) (#423)
BenjaminBlake-NOAA Jul 19, 2024
316e492
update 3 smoke and dust fix files provided by Johana (#420)
guoqing-noaa Jul 30, 2024
13660a3
The final smoke update PR to RRFS.v1 (#427)
LiamWedell-NOAA Aug 9, 2024
34066a5
Fixes an issue with the latest smoke update for RRFS (#430)
MatthewPyle-NOAA Aug 12, 2024
c6b680c
Fixed a bug in FV3LAM_wflow.xml. (#438)
hu5970 Aug 16, 2024
41b09ec
Updates resources for 1 h enkf forecast job (#446)
MatthewPyle-NOAA Aug 26, 2024
f4ade9b
Updates UPP to support MPAS runs initialized from RRFS (#448)
MatthewPyle-NOAA Aug 29, 2024
2c3442f
[dev-sci] Add SAS option for real-time parallel (#439)
BenjaminBlake-NOAA Sep 5, 2024
cc0fca3
Add RRFS_sas blocks to input yml files (#457)
BenjaminBlake-NOAA Sep 6, 2024
7e0decc
added legal disclaimer to README.md (#471)
edwardhartnett Sep 9, 2024
4575301
fix python syntax errors and turn on flake8 syntax error checking in …
edwardhartnett Sep 9, 2024
c71f21a
fixed invalid-print-syntax warnings from flake8 (#477)
edwardhartnett Sep 10, 2024
c32d9f8
first python test! (#478)
edwardhartnett Sep 10, 2024
a3f29f4
Update ufs-weather-model hash, and default CCPP suite for RRFS_NA_3km…
BenjaminBlake-NOAA Sep 11, 2024
6eb544e
Updates UPP tag to pick up new GTG version that reduces log prints. (…
MatthewPyle-NOAA Sep 13, 2024
7b74ff1
adding a documentation build to CI
edwardhartnett Sep 16, 2024
648eaff
adding a documentation build to CI
edwardhartnett Sep 16, 2024
27218e2
adding a documentation build to CI
edwardhartnett Sep 16, 2024
ba3116c
adding a documentation build to CI
edwardhartnett Sep 16, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# This workflow will build the documentation.
#
# Edward Hartnett, 9/16/24

name: docs

on:
push:
branches: [ "dev-sci" ]
pull_request:
branches: [ "dev-sci" ]

permissions:
contents: read

jobs:
docs:

runs-on: ubuntu-latest

steps:
- name: checkout
uses: actions/checkout@v4
with:
path: rrfs-workflow
submodules: true

- name: Set up Python 3.10
uses: actions/setup-python@v3
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinxcontrib-bibtex sphinx-rtd-theme
- name: Build docs
run: |
cd rrfs-workflow/doc/UsersGuide
sphinx-build -b html source build

- uses: actions/upload-artifact@v4
with:
name: docs
path: |
rrfs-workflow/doc/UsersGuide/build

40 changes: 40 additions & 0 deletions .github/workflows/pytest_flake8.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# This workflow will install Python dependencies, and run flake8 for syntax errors only.
#
# Edward Hartnett, 9/9/24

name: flake8

on:
push:
branches: [ "dev-sci" ]
pull_request:
branches: [ "dev-sci" ]

permissions:
contents: read

jobs:
flake8_build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Set up Python 3.10
uses: actions/setup-python@v3
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install flake8 pytest pytest-cov coverage numpy netCDF4 jinja2
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors
flake8 . --count --select=E9,F63,F7 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
#flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: pytest
run: |
pytest
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,22 @@ cd ..

See the RRFS-Workflow User's guide:
https://chanhoo-rrfs-workflow.readthedocs.io/en/latest/index.html

## Disclaimer

```
The United States Department of Commerce (DOC) GitHub project code is
provided on an "as is" basis and the user assumes responsibility for
its use. DOC has relinquished control of the information and no longer
has responsibility to protect the integrity, confidentiality, or
availability of the information. Any claims against the Department of
Commerce stemming from the use of its GitHub project will be governed
by all applicable Federal law. Any reference to specific commercial
products, processes, or services by service mark, trademark,
manufacturer, or otherwise, does not constitute or imply their
endorsement, recommendation or favoring by the Department of
Commerce. The Department of Commerce seal and logo, or the seal and
logo of a DOC bureau, shall not be used in any manner to imply
endorsement of any commercial product or activity by DOC or the United
States Government.

1 change: 0 additions & 1 deletion fix/gsi/RRFS_CONUS_13km/geo_em.d01.nc

This file was deleted.

2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775.facsf.tile7.halo0.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775.facsf.tile7.halo4.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775.facsf.tile7.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775.slope_type.tile7.halo0.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775.slope_type.tile7.halo4.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775.slope_type.tile7.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775.snowfree_albedo.tile7.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775.soil_type.tile7.halo0.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775.soil_type.tile7.halo4.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775.soil_type.tile7.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775.vegetation_type.tile7.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775_grid.tile7.halo0.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_grid.tile7.halo3.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_grid.tile7.halo4.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_grid.tile7.halo6.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775_grid.tile7.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775_mosaic.halo0.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_mosaic.halo3.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_mosaic.halo4.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_mosaic.halo6.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775_mosaic.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_oro_data.tile7.halo0.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_oro_data.tile7.halo4.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775_oro_data.tile7.halo6.nc
1 change: 1 addition & 0 deletions fix/lam/RRFS_CONUS_13km/C775_oro_data.tile7.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_oro_data_ls.tile7.halo0.nc
2 changes: 1 addition & 1 deletion fix/lam/RRFS_CONUS_13km/C775_oro_data_ss.tile7.halo0.nc
Loading
Loading