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.

Sign up for GitHub

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

Update Quickstart.rst #540

Merged
merged 3 commits into from
Nov 1, 2024
Merged

Update Quickstart.rst #540

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb72297
Update Quickstart.rst
MatthewPyle-NOAA Oct 31, 2024
788f63e
Update Quickstart.rst
MatthewPyle-NOAA Oct 31, 2024
45ef096
Update Quickstart.rst
MatthewPyle-NOAA Nov 1, 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
21 changes: 11 additions & 10 deletions docs/source/Quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,29 @@ Building RRFS workflow

.. code-block:: console

git clone https://github.com/NOAA-EMC/rrfs-workflow.git
git clone https://github.com/NOAA-EMC/rrfs-workflow.git

#. Check out the external components:
#. Move to the sorc directory:

.. code-block:: console

cd rrfs-workflow/sorc
./manage_externals/checkout_externals
cd rrfs-workflow/sorc

#. Set up the build environment and build the executables:
#. Build the needed executables for the workflow:

.. code-block:: console

./app_build.sh

Alternatively, the above command can be followed by the platform (machine) name as follows:
./app_build.sh --extrn --noifi --nogtg
The above command uses the ``--extrn`` flag to do the code checkout, the ``--noifi`` flag avoids building the IFI (icing) library, and the ``--nogtg`` flag avoids building the GTG (turbulence) library. Most users do not have access to the IFI and GTG codes.

#. The above command is equal to:

.. code-block:: console

./app_build.sh --platform=<machine>
./manage_externals/checkout_externals
./app_build.sh -p=[machine] --noifi --nogtg

where ``<machine>`` is ``wcoss2``, ``hera``, ``jet``, ``orion``, or ``hercules``.
where ``<machine>`` is one of ``wcoss2``, ``hera``, ``jet``, ``orion``, or ``hercules``

#. Move to the home directory (rrfs-workflow):

Expand Down
Loading