Skip to content

Commit

Permalink
changed README and change CI to reflect new main branch (#499)
Browse files Browse the repository at this point in the history
---------
  • Loading branch information
edwardhartnett authored Sep 24, 2024
1 parent ebdb023 commit bd31e78
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 15 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ name: docs

on:
push:
branches: [ "production/RRFS.v1" ]
branches: [ "main" ]
pull_request:
branches: [ "production/RRFS.v1" ]
branches: [ "main" ]

permissions:
contents: read
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/pytest_flake8.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ name: flake8

on:
push:
branches: [ "dev-sci" ]
branches: [ "main" ]
pull_request:
branches: [ "dev-sci" ]
branches: [ "main" ]

permissions:
contents: read
Expand All @@ -32,7 +32,7 @@ jobs:
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors
flake8 . --count --select=E9,F63,F7 --show-source --statistics
flake8 . --count --select=E9,F7 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
#flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: pytest
Expand Down
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
# rrfs-workflow

Workflow for the Rapid Refresh Forecast System (RRFS)
This repository contains the workflow code for the [Rapid Refresh
Forecast System
(RRFS)](https://gsl.noaa.gov/focus-areas/unified_forecast_system/rrfs).

Team Charter (draft): https://docs.google.com/document/d/1uLbPx-pOWp7eECz_7VHRt_tQyD8PLFdrwo8dr4oMgjo/edit?usp=sharing
For more information see the [RRFS-Workflow User's
guide](https://chanhoo-rrfs-workflow.readthedocs.io/en/latest/index.html).

## Build
## Team

1. Clone the `dev-sci` branch of the authoritative repository:
Code Manager: Matthew Pyle

For more information see the [Team
Charter](https://docs.google.com/document/d/1uLbPx-pOWp7eECz_7VHRt_tQyD8PLFdrwo8dr4oMgjo/edit?usp=sharing).

## Build Instructions

1. Clone the `main` branch of the authoritative repository:
```
git clone -b dev-sci https://github.com/NOAA-EMC/rrfs-workflow
git clone https://github.com/NOAA-EMC/rrfs-workflow
```

2. Move to the `sorc` directory:
Expand All @@ -32,11 +42,8 @@ where `[machine]` is `wcoss2`, `hera`, `jet`, `orion`, or `hercules`. The `--no
cd ..
```

## Engineering Tests

See the RRFS-Workflow User's guide:
https://chanhoo-rrfs-workflow.readthedocs.io/en/latest/index.html

5. Configure/build the workflow (see description of Engineering Tests in the [RRFS-Workflow User's
guide](https://chanhoo-rrfs-workflow.readthedocs.io/en/latest/index.html)
## Disclaimer

```
Expand Down

0 comments on commit bd31e78

Please sign in to comment.