diff --git a/.github/workflows/cqc.yml b/.github/workflows/cqc.yml index e17f9cbf..74082c73 100644 --- a/.github/workflows/cqc.yml +++ b/.github/workflows/cqc.yml @@ -1,6 +1,6 @@ name: Code Quality Checks on: - pull_request: + pull_request_target: types: - opened - reopened diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e638f1d5..1d66095a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,7 +4,8 @@ on: branches: - develop - main/* - pull_request: + - global_eagle_instructions + pull_request_target: types: [opened, reopened, synchronize] paths: - docs/** @@ -15,6 +16,8 @@ jobs: permissions: pull-requests: write + contents: read + issues: write runs-on: ubuntu-22.04 name: Build and deploy documentation diff --git a/.github/workflows/nested_eagle.yml b/.github/workflows/nested_eagle.yml index db241eac..c1e903c1 100644 --- a/.github/workflows/nested_eagle.yml +++ b/.github/workflows/nested_eagle.yml @@ -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: diff --git a/docs/eagle_models/global_eagle.rst b/docs/eagle_models/global_eagle.rst index 60077be1..027c0eae 100644 --- a/docs/eagle_models/global_eagle.rst +++ b/docs/eagle_models/global_eagle.rst @@ -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 `. + +#. 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 `_. + diff --git a/docs/eagle_models/nested_eagle.rst b/docs/eagle_models/nested_eagle.rst index 97f23789..fec39288 100644 --- a/docs/eagle_models/nested_eagle.rst +++ b/docs/eagle_models/nested_eagle.rst @@ -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 `.