Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/cqc.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Code Quality Checks
on:
pull_request:
pull_request_target:
types:
- opened
- reopened
Expand Down
5 changes: 4 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ on:
branches:
- develop
- main/*
pull_request:
- global_eagle_instructions
pull_request_target:
types: [opened, reopened, synchronize]
paths:
- docs/**
Expand All @@ -15,6 +16,8 @@ jobs:

permissions:
pull-requests: write
contents: read
issues: write

runs-on: ubuntu-22.04
name: Build and deploy documentation
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/nested_eagle.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: NRT EAGLE CI Pipeline (uwtools)

on:
pull_request:
pull_request_target:
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]

permissions:
Expand Down
36 changes: 36 additions & 0 deletions docs/eagle_models/global_eagle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,39 @@ The graph configuration connects targets to nodes through nearest neighbors in
the encoder and decoder, with ``encoder_knn=12`` and ``decoder_knn=3``.

The latent mesh is four times coarser than the native data resolution.

Near-Real-Time Forecasting
--------------------------

The global-EAGLE model can be run in near real time (NRT) using the
``feature/global_eagle`` branch in this repository. That branch includes the required
dependencies (including compatible ``anemoi`` versions) and is the recommended
starting point for NRT runs of global-EAGLE.

To run NRT:

#. Check out the ``feature/global_eagle`` branch.

.. code-block:: bash

git checkout feature/global_eagle

#. Follow the :ref:`NRT workflow <NRT>`.

#. EPIC hosts the checkpoint on Azure. To download the checkpoint to your machine, simply run:

.. code-block:: bash

wget -O inference-last.ckpt https://eaglecheckpoints.blob.core.windows.net/eagle-checkpoints/global-eagle/era5_gdas_global_check.ckpt

Before running ``make realize``, update:

* ``app.base`` to the absolute path of your local repository root
* ``inference.anemoi.checkpoint_dir`` to the checkpoint you downloaded from Azure (inference-last.ckpt)

After those updates, realize the config and continue with the remaining quickstart
NRT steps.

EPIC runs this global-EAGLE workflow in near-real-time every 6 hours. You can
view project information and current forecast results on the `NOAA EPIC website <https://www.epic.noaa.gov/ai/eagle-overview/>`_.

6 changes: 3 additions & 3 deletions docs/eagle_models/nested_eagle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,17 +70,17 @@ Near-Real-Time Forecasting
--------------------------

The nested-EAGLE model can be run in near real time (NRT) using the
``nested-eagle-v1`` branch in this repository. That branch includes the required
``release/public-v1.1.0`` branch in this repository. That branch includes the required
dependencies (including compatible ``anemoi`` versions) and is the recommended
starting point for NRT runs of nested-EAGLE.

To run NRT:

#. Check out the ``nested-eagle-v1`` branch.
#. Check out the ``release/public-v1.1.0`` branch.

.. code-block:: bash

git checkout nested-eagle-v1
git checkout release/public-v1.1.0

#. Follow the :ref:`NRT workflow <NRT>`.

Expand Down