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

Text/us 64 #1

Draft
wants to merge 57 commits into
base: develop
Choose a base branch
from
Draft
Changes from 1 commit
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
b68b158
implement sphinx_rtd_theme; restructure docs
gspetro-NOAA Feb 15, 2024
08fb3ff
Added requirements.in and updated requirements files
jdkublnick Feb 26, 2024
cf1e221
re-organized links to match SRW and landDA documentation
jdkublnick Mar 11, 2024
50e9245
Revert "re-organized links to match SRW and landDA documentation"
jdkublnick Mar 11, 2024
076e10e
Reapply "re-organized links to match SRW and landDA documentation"
jdkublnick Mar 11, 2024
923a912
Changed Docs to match SRW
jdkublnick Mar 11, 2024
f22fde6
Merge branch 'text/us-64' of https://github.com/jdkublnick/HAFS into …
jdkublnick Mar 11, 2024
ccee31b
Updated some Links and added RST for Code contributors guide
jdkublnick Mar 19, 2024
0df4ab8
docs to doc
jdkublnick Mar 20, 2024
9ec7d23
Edited readthedocs.yaml
jdkublnick Mar 20, 2024
a275b8a
Reverting docs to doc change
jdkublnick Mar 20, 2024
924fa3a
Merge branch 'develop' into text/us-64
jdkublnick Mar 22, 2024
46c04bc
Changed docs to doc and made some other makelink fixes
jdkublnick Mar 25, 2024
3022038
Merge branch 'text/us-64' of https://github.com/jdkublnick/HAFS into …
jdkublnick Mar 25, 2024
79372d0
Changing docs to doc
jdkublnick Mar 25, 2024
d1fff1b
deleted build files
jdkublnick Mar 25, 2024
6c62213
Edited yaml file
jdkublnick Mar 25, 2024
85afeef
Update Reference/index.rst
jdkublnick Mar 26, 2024
23a35d6
Update Makefile
jdkublnick Mar 26, 2024
558c957
Update Makefile
jdkublnick Mar 26, 2024
0baee7a
Update requirements.txt
jdkublnick Mar 26, 2024
21d941f
Update requirements.txt
jdkublnick Mar 26, 2024
7430586
Update requirements.txt
jdkublnick Mar 26, 2024
90feb76
Update requirements.txt
jdkublnick Mar 26, 2024
fe5b686
Update conf.py
jdkublnick Mar 26, 2024
6951a97
Update GitHubBasicSteps.rst
jdkublnick Mar 26, 2024
4c60bd9
Update GitHubBasicSteps.rst
jdkublnick Mar 26, 2024
3660abc
Update HAFSCodeContributionGuidelines.rst
jdkublnick Mar 26, 2024
3982135
Revert "Edited yaml file"
gspetro-NOAA Mar 26, 2024
e4cfbb4
Updated changes to links and Contribution Guidelines
jdkublnick Mar 26, 2024
df48719
Adding contributors guide
jdkublnick Mar 26, 2024
47f2eba
Adjusting makefile to match SRW
jdkublnick Mar 27, 2024
5118689
Update links in ReferenceMaterials.rst
gspetro-NOAA Mar 30, 2024
20e8390
Changes that should of been pushed to begin with
jdkublnick Mar 31, 2024
054bbdf
git commid
jdkublnick Mar 31, 2024
4536216
Minor changes to some grammar and punctuation
jdkublnick Apr 1, 2024
489a68e
Merge branch 'text/us-64' of https://github.com/jdkublnick/HAFS into …
gspetro-NOAA Apr 1, 2024
98ef3e3
mv Makefile comment to correct place
gspetro-NOAA Apr 1, 2024
4fe5f22
update RTD.yaml and conf.py
gspetro-NOAA Apr 1, 2024
4badfc0
Made changes to version and release in conf py
jdkublnick Apr 1, 2024
2ba9b0d
update contrib guide
gspetro-NOAA Apr 2, 2024
7894ea7
misc edits
gspetro-NOAA Apr 2, 2024
3c88d21
misc edits
gspetro-NOAA Apr 2, 2024
41e079e
Merge pull request #1 from gspetro-NOAA/text/us-64
jdkublnick Apr 2, 2024
2da93a5
Test change
jdkublnick Apr 2, 2024
32de7b1
Revert change to hafs_tracker.fd hash 97a3b75
jdkublnick Apr 2, 2024
fd74d98
Revert change to hafs_graphics.fd/emc_graphics hash c1a0456
jdkublnick Apr 2, 2024
b5a08b2
Revert change to hafs_graphics.fd/hrd_gplot hash f1d8e26
jdkublnick Apr 2, 2024
38b740d
Update doc/UsersGuide/source/CustomizingTheWorkflow/CDEPS.rst
jdkublnick Apr 2, 2024
607aaec
Update doc/UsersGuide/source/Reference/ReferenceMaterials.rst
jdkublnick Apr 2, 2024
c6a6b5f
Update doc/UsersGuide/source/ContributorsGuide/HAFSCodeContributionGu…
jdkublnick Apr 2, 2024
f801b50
Update doc/UsersGuide/source/ContributorsGuide/HAFSCodeContributionGu…
jdkublnick Apr 2, 2024
f7e06a7
Update doc/UsersGuide/source/ContributorsGuide/HAFSCodeContributionGu…
jdkublnick Apr 2, 2024
7bfd581
Added release notes Page
jdkublnick Apr 30, 2024
2ad2738
Merge branch 'text/us-64' of github.com:jdkublnick/HAFS into text/us-64
jdkublnick Apr 30, 2024
85a82d1
Added release notes
jdkublnick Apr 30, 2024
94d460b
Undo Release notes
jdkublnick Apr 30, 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
Prev Previous commit
Next Next commit
Added release notes
  • Loading branch information
jdkublnick committed Apr 30, 2024
commit 85a82d160a3c0fbe8ae0b76f1957dad217bafd47
150 changes: 150 additions & 0 deletions doc/UsersGuide/source/Backgroundinfo/ReleaseNotes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
.. _ReleaseNotes:

HAFS v2.0.0 Release Notes (Major)
=================================

**Model:** Hurricane Analysis and Forecast System (HAFS)

**Version:** hafs.v2.0.0

**Released:** July 01, 2024, 1200UTC

**Location on GitHub:** `HAFS GitHub Repository <https://github.com/hafs-community/HAFS/tree/production/hafs.v2>`

**Clone the repository:**

.. code-block:: bash

git clone -b production/hafs.v2 --recursive https://github.com/hafs-community/HAFS.git ./hafs.v2.0.0

**Purpose:**
Run HAFS.v2 HFSA configuration to provide hurricane track and intensity forecast guidance to 5.25 days over all global oceanic basins, including NATL, EPAC, CPAC, WPAC, NIO, and SH basins. Run HAFS.v2 HFSB configuration to provide hurricane track and intensity forecast guidance for 5.25 days over NHC/CPHC basins, including NATL, EPAC, CPAC basins.

**Developed by:**
EMC and the UFS Hurricane Application Team. See currently active HAFS developers `here <https://docs.google.com/presentation/d/1xBNxvAG8-Kk3GS93PndaPVZp_L8U-KqGRGNhnviXZMg/edit?usp=sharing>`.

**Runs on:** WCOSS2

Input/Output
------------

**Input:**
- Global Forecast System (GFS, including GFS/GDAS) NetCDF format analysis for atmospheric initial condition, and 3-hourly GRIB2 files (up to 129 h) for atmospheric lateral boundary conditions and atmospheric forcing for oceanic and wave model components.
- Global RTOFS for oceanic initial and boundary conditions for MOM6 and HYCOM.
- GFS/GDAS global wave analysis/forecast for HFSA wave component initial and lateral boundary conditions.
- OBSPROC observational data for HAFS data assimilation.

**Output:**
- ATCF track forecast files, 4x/day at 00Z/06Z/12Z/18Z.

Locations for Output
--------------------

- **WCOSS2:**
- HFSA: ``/lfs/h1/ops/prod/com/hafs/v2.0/hfsa.yyyymmdd/hh``
- HFSB: ``/lfs/h1/ops/prod/com/hafs/v2.0/hfsb.yyyymmdd/hh``
- **Other servers:**
- NCEP ftp server, NOMADS, NWS Gateway/SBN

Background
----------

Hurricane Analysis and Forecast System (HAFS), as the Unified Forecast System (UFS) hurricane application, is the FV3 (Finite­ Volume Cubed-Sphere Dynamical Core) based multi-scale model and data assimilation system capable of providing tropical cyclone (TC, including hurricane and typhoon) analyses and forecasts of the inner core structure key to improving storm size and intensity predictions, as well as the large-scale environment that is known to influence the TC's motion. HAFS development targets an operational data assimilation and modeling system, capable of providing reliable, robust and skillful model guidances for TC track, intensity (including rapid intensification), size, structure, rainfall and cyclone genesis, as well as for TC associated storm surge, sea surface waves, and tornadoes. HAFS is a community-based coupled earth modeling system specially calibrated for hurricane prediction with TC dynamics and physics, sophisticated vortex initialization and advanced inner-core data assimilation techniques, and various air-sea interaction processes.

HAFSv2 will replace NCEP's current operational hurricane forecast systems, HAFSv1 in the 2024 hurricane season. The goal of this project is to upgrade the HAFSv1 that was running in operations in 2023. The system will provide improved and comparable tropical cyclone track and intensity forecast guidance in all global oceanic basins, as demonstrated through evaluation of retrospective and real time experiments compared against the two current configurations of operational HFSAv1 and HFSBv1.

Scientific Changes to Improve Track and Intensity Forecast Skills
-----------------------------------------------------------------

**System and Infrastructure Upgrades:**
- Latest version of ufs-weather-model, HAFSv2 final scientific configuration freeze on 02/08/2024.
- Increase moving nesting horizontal resolution from 6-2 km to 5.4-1.8 km (HFSA only).
- Reduce model time step from 90 to 72s (HFSB only).
- Updated horizontal advection options.
- Improved model stability and runtime efficiency.

**Vortex Initialization Improvement:**
- Enhance vortex initialization to cycle hydrometeor variables and vertical velocity (HFSA only).
- Update compsitie vortex and reduce warm-cycling Vmax threshold from 50 to 40 kt (HFSA only).

**Data Assimilation Improvement:**
- Ingest new high-resolution GOES-R mesoscale AMVs.
- Scale-Dependent Localization for innercore DA.
- Refine GPS RO (Radio Occultation) DA.

**Model Physics Advancement:**
- Upgrade Thompson MP with bug fixes.
- Thompson Microphysics for NATL basin, GFDL Microphysics for EPAC/CPAC and JTWC basins (HFSA only).
- Update TKE EDMF PBL and SASAS CP schemes with vertical wind shear impacts.
- Change the radiation calling time step from 720s to 900s (HFSA only).
- Reduce radiation time step from 1800 to 720s (HFSB only).
- Update CO2 fix files.

**Ocean/Wave Coupling:**
- MOM6 ocean model coupling (HFSA only).
- CMEPS with inline-CDEPS coupling (HFSA only).

**Post-processing:**
- Upgrade GFDL Tracker.

**Software Dependencies:**
- See `here <https://github.com/hafs-community/HAFS/blob/production/hafs.v2/versions/run.ver>`

**Output Changes:**
- See `here <https://docs.google.com/presentation/d/1dGWu_k-CdiX_ndaRe89iDznyNwkEJfjVTagvvEVZQaw/edit?usp=sharing>`

Computer Resource Information
-----------------------------

**Computation resource updates:**
- See `here <https://docs.google.com/presentation/d/1otBHAi3hfB1Vu5lk9bfjOE-GZYalZiu9wjnFlevQRQw/edit?usp=sharing>`

**List of the module versions used in HAFS:**
- See `here <https://github.com/hafs-community/HAFS/blob/production/hafs.v2/versions/run.ver>`

**Data retention for files in:**
- ``/lfs/h1/ops/prod/com/hafs/v2.0/hfsa.yyyymmdd/hh`` and ``/lfs/h1/ops/prod/com/hafs/v2.0/hfsb.yyyymmdd/hh``
- **Disk space usage:** Increased from 145/140 GB (HFSAv1/HFSBv1) per cycle to ~295/195 GB (HFSAv2/HFSBv2).
- **HPSS disk requirement:** Increased from ~142/126 GB (HFSAv1/HFSBv1) to ~228/133 GB (HFSAv2/HFSBv2).
- **Preferred data retention in COM:** Files to be kept for 7 days.

**Input Datasets**
- Global Forecast System (GFS, including GFS/GDAS) NetCDF format analysis for atmospheric initial condition, and 3-hourly GRIB2 files (up to 129 h) for atmospheric lateral boundary conditions and atmospheric forcing for oceanic and wave model components. Global RTOFS for oceanic initial and boundary conditions for the ocean model component. GFS/GDAS global wave analysis/forecast for HFSA wave component initial and lateral boundary conditions. OBSPROC observational data for HAFS data assimilation.


**Input DCOM Dependencies**

- The following scripts require input files from DCOM directory:
- ``./scripts/exhafs_obs_prep.sh``: to decode/dump TDR/HDOB/TEMPDROP data
- ``./scripts/exhafs_msg_check.py``: to check the message files are properly created by checking the original NHC/JTWC message files in the DCOM directory.
- ``./ush/setup_hurricane``: for SDM to set up hurricane message files by extracting info from the original NHC/JTWC message files in the DCOM directory.


Pre-implementation Testing
--------------------------

All jobs should be tested as part of this implementation.

**Does this change require a 30-day evaluation (for major implementations only)?**
No, but all changes have been tested successfully using available input as per the following list: `IT tests list <https://docs.google.com/presentation/d/1qttu6HhZC3I2yEWLIcsTM7BUGxGyevhtZMUU61kSyYI/edit?usp=sharing>`

**Who are the suggested evaluators?**
NHC, CPHC, and JTWC for model products and MAG for GEMPAK files.

Dissemination and Archiving
---------------------------

**Dissemination Information:**
- The ATCF files to NHC (and CPHC for Central Pacific Basin storms), and JTWC (for all global basins, including SH basins), GRIB files for NOMADS and GEMPAK files for MAG.
- The users are NHC, CPHC, JTWC, MAG and NOMADS
- All the files in COM directory should be transferred from PROD WCOSS2 to DEV WCOSS2
- None of the codes are proprietary and there is no restricted data

**Archive to HPSS:**
All the files in the COM directory are preferred to be archived in 5-year retention HPSS directory.

Implementation Details
----------------------

See `here <https://docs.google.com/document/d/1dKV_jAHs9TkOhS_qA-Nr3PPE_NtbGxaAgC5FSPI6BwQ/edit?usp=sharing>`