.. _ReferenceMaterials:

********************
Reference Materials
********************

This chapter provides a collection of reference materials, including guidance documents 
(e.g., NCEP Implementation Standards), code management documents, and other useful resources.

.. _GuidanceDocs:

===================
Guidance Documents
===================

- `NCO Implementation Standards <https://www.nco.ncep.noaa.gov/idsb/implementation_standards/>`__
- `NCEP EE2 Consolidated Document <https://www.emc.ncep.noaa.gov/users/impldocs/EE2-Consolidated-Document.V2.pdf>`__ *
- `Code Management of Repositories Under EMC Management Using GitFlow <https://docs.google.com/document/d/1H5McooP-ZmDIOhcy4zJwdFVk3DyjbJt_Nyqj4QGBRBU/edit?usp=sharing>`__ *

\* Requires NOAA email for access

.. _CodeManagement:

=========================================
Useful Code Management Related Materials
=========================================

- `UFS Github Repository Code Management <https://docs.google.com/document/d/1leuJh1qVz2raTkUJz4CQf68ktqNHKEUsWrgPNtVaIH0/edit?usp=sharing>`_ *
- `Versioning for UFS Repositories <https://github.com/ufs-community/ufs/wiki/Versioning>`_
- :ref:`Contributing to HAFS <HAFSCodeContributionGuidelines>`
- More about GitFlow:

  - `A Successful Git Branching Model <https://nvie.com/posts/a-successful-git-branching-model/>`_ by Vincent Driessen
  - `GitFlow at GitHub <https://github.com/nvie/gitflow/>`_
  - `GitFlow Examples <https://gitversion.net/docs/>`_ from GitVersion

\* Requires NOAA email for access

.. _UsefulResources:

=================
Useful Resources
=================

- GFS `global-workflow repository <https://github.com/NOAA-EMC/global-workflow/>`_, `wiki <https://github.com/NOAA-EMC/global-workflow/wiki/>`_, and `documentation <https://global-workflow.readthedocs.io/en/latest/>`_
- `UFS Weather Model User's Guide <https://ufs-weather-model.readthedocs.io/en/develop/>`__
- Common Community Physics Package (CCPP):

  - `CCPP Technical Documentation (User’s Guide) <https://ccpp-techdoc.readthedocs.io/en/v6.0.0/>`_
  - `CCPP Scientific Documentation <https://dtcenter.ucar.edu/GMTB/v6.0.0/sci_doc/index.html>`_

- `UFS_UTILS repository <https://github.com/ufs-community/UFS_UTILS/>`_ 
  
  - `UFS_UTILS User’s Guide <https://noaa-emcufs-utils.readthedocs.io/en/latest/>`_
  - `UFS_UTILS Scientific Documentation <https://ufs-community.github.io/UFS_UTILS/>`_

- `UFS Short-Range Weather App User's Guide <https://ufs-srweather-app.readthedocs.io/en/develop/>`_
- `UPP repository <https://github.com/NOAA-EMC/UPP/>`_ (formerly *EMC_post*)

  - `UPP User’s Guide Documentation <https://upp.readthedocs.io/en/latest/index.html>`_
  - `UPP Scientific Documentation <https://noaa-emc.github.io/UPP/>`_

- `FV3 multinest presentation from GFDL <https://docs.google.com/presentation/d/1cgi8J1ZzVt1EqVyRR5tzhO223p9zHBoNHJ2UPcU5Hn8/edit?usp=sharing>`__ *
- JCSDA JEDI Academy Slides: `Nov 2020 Academy Slides <http://academy.jcsda.org/nov2020/pages/slides.html>`__
- `JEDI Documentation <https://jointcenterforsatellitedataassimilation-jedi-docs.readthedocs-hosted.com/en/latest/>`__
- About Rocoto Workflow Management: `GitHub repository <https://github.com/christopherwharrop/rocoto/>`__ and `documentation <http://christopherwharrop.github.io/rocoto/>`__
- `Some Git How-Tos <https://docs.google.com/document/d/1Q_WlICcDV64ejBBRxH2kI495sbZc_1hUHGPA1-AjdOI/edit?usp=sharing>`__ *
- `Configuring Git for Multiple GitHub Accounts <https://www.freecodecamp.org/news/manage-multiple-github-accounts-the-ssh-way-2dadc30ccaca>`__ (this information may be useful for users with multiple GitHub accounts for configuring where Git pushes your commits)
- `EIB Seminar CMake presentation <https://drive.google.com/open?id=1PaNgPaBlDWZnwD3-JOtWArdQwffAAsFJ>`__ *

\* Requires NOAA email for access