From 642354ece7045a1b270c70025fcc43c37f7ed80d Mon Sep 17 00:00:00 2001 From: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com> Date: Fri, 8 Dec 2023 11:40:41 -0500 Subject: [PATCH] [develop]: Update doc URL in README.md (#38) * fix doc URL in README.md * update text around git clone command to branch (not tag) * update .gitmodules --------- Co-authored-by: rhaesung --- .gitmodules | 2 +- README.md | 2 +- docs/source/BuildingRunningTesting/BuildRunLandDA.rst | 2 +- docs/source/conf.py | 1 + 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.gitmodules b/.gitmodules index a581b0c8..09f544dc 100644 --- a/.gitmodules +++ b/.gitmodules @@ -5,7 +5,7 @@ [submodule "DA_update"] path = DA_update url = https://github.com/ufs-community/land-DA.git - branch = develop + branch = release/land-da-public-v1.2.0 [submodule "vector2tile"] path = vector2tile url = https://github.com/NOAA-PSL/land-vector2tile.git diff --git a/README.md b/README.md index 98c6927b..0037634c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The offline Noah-MP LSM is a standalone, uncoupled model used to execute land su The Noah-MP LSM has evolved through community efforts to pursue and refine a modern-era LSM suitable for use in the National Centers for Environmental Prediction (NCEP) operational weather and climate prediction models. This collaborative effort continues with participation from entities such as NCAR, NCEP, NASA, and university groups. The development branch of the Land DA System is continually evolving as the system undergoes open development. The latest Land DA release (v1.2.0) represents a snapshot of this continuously evolving system. -The Land DA System User's Guide associated with the development branch is at: https://land-da.readthedocs.io/en/develop/, while the guide specific to the Land DA v1.2.0 release can be found at: https://land-da-workflow.readthedocs.io/en/release/public-v1.2.0/. Users may download data for use with the most recent release from the [Land DA data bucket](https://noaa-ufs-land-da-pds.s3.amazonaws.com/index.html#current_land_da_release_data/v1.2.0). The [Land DA Docker Hub](https://hub.docker.com/r/noaaepic/ubuntu20.04-intel-landda) hosts Land DA containers. These containers package the Land DA System together with all its software dependencies for an easier experience building and running Land DA. +The Land DA System User's Guide associated with the development branch is at: https://land-da.readthedocs.io/en/develop/, while the guide specific to the Land DA v1.2.0 release can be found at: https://land-da-workflow.readthedocs.io/en/release-public-v1.2.0/. Users may download data for use with the most recent release from the [Land DA data bucket](https://noaa-ufs-land-da-pds.s3.amazonaws.com/index.html#current_land_da_release_data/v1.2.0). The [Land DA Docker Hub](https://hub.docker.com/r/noaaepic/ubuntu20.04-intel-landda) hosts Land DA containers. These containers package the Land DA System together with all its software dependencies for an easier experience building and running Land DA. For any publications based on work with the UFS Offline Land Data Assimilation System, please include a citation to the DOI below: diff --git a/docs/source/BuildingRunningTesting/BuildRunLandDA.rst b/docs/source/BuildingRunningTesting/BuildRunLandDA.rst index cc86606f..85880701 100644 --- a/docs/source/BuildingRunningTesting/BuildRunLandDA.rst +++ b/docs/source/BuildingRunningTesting/BuildRunLandDA.rst @@ -71,7 +71,7 @@ Clone the Land DA repository. To clone the ``develop`` branch, run: git clone -b develop --recursive https://github.com/ufs-community/land-DA_workflow.git -To clone the most recent release, run the same command with |tag| in place of ``develop``: +To clone the most recent release, run the same command with |branch| in place of ``develop``: .. code-block:: console diff --git a/docs/source/conf.py b/docs/source/conf.py index 2a23b7c9..baa156c3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -48,6 +48,7 @@ rst_prolog = """ .. |latestr| replace:: v1.2.0 .. |tag| replace:: ``ufs-land-da-v1.2.0`` +.. |branch| replace:: ``release/public-v1.2.0`` """ # -- Options for HTML output -------------------------------------------------