Getting Started for Developers

This page is under construction....

Getting started for developers

Development of the UFS Short-Range Weather App and its subcomponents such as the regional workflow is typically done on a user's fork. A fork is a copy of the authoritative repository and allows the user to make code changes without affecting the original repository. To set up for development work, a user will need to:

1. Create a GitHub account

2. Create fork(s) via GitHub. It is generally good practice to create a fork of the repository where you are doing development work, and any parent repository. For example, if you are modifying the regional_workflow repository, create a fork of the regional_workflow and the ufs-srweather-app repositories:

   • Login to your GitHub account
   • Go to the authoritative repository website (e.g. https://github.com/ufs-community/ufs-srweather-app or https://github.com/NOAA-EMC/regional_workflow)
   • Click on "fork" in the top right corner. You will see the repository in your GitHub account.

3. Clone the top-level ufs-srweather-app repository:

    git clone https://github.com/ufs-community/ufs-srweather-app.git

   or your fork

   git clone https://github.com/<your_github_username>/ufs-srweather-app.git

   Check that you are on the develop branch:

   git branch -a

4. stuff

Information about code development in the regional_workflow repository is here.

Information about code development in the UFS Weather Model is here.

Code Management