Skip to content

Commit

Permalink
Merge pull request #24 from GEOS-ESM/mathomp4-patch-1
Browse files Browse the repository at this point in the history
Update README.md with develop option
  • Loading branch information
mathomp4 authored Aug 1, 2019
2 parents 52440c0 + a8c0dbd commit 1a8fcc8
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,13 @@ git clone [email protected]:GEOS-ESM/GEOSgcm.git

If all you wish is to build the model, you can run `parallel_build.csh` from a head node. Doing so will checkout all the external repositories of the model and build it. When done, the resulting model build will be found in `build/` and the installation will be found in `install/` with setup scripts like `gcm_setup` and `fvsetup` in `install/bin`.

#### Develop Version of GEOS

The user will notice two files in the main directory: `Externals.cfg` and `Develop.cfg`. The difference between these two is that `Externals.cfg` always refers to stable tested released subrepositories. The `Develop.cfg` points to the `develop` branch of `@GEOSgcm_GridComp` and `@GEOSgcm_App`. This is equivalent in the CVS days of the difference between `Jason-3_1` and `Jason-UNSTABLE`. In order to build the `Develop.cfg` version of the model with `parallel_build.csh` do:
```
parallel_build.csh -develop
```

#### Debug Version of GEOS

To obtain a debug version, you can run `parallel_build.csh -debug` which will build with debugging flags. This will build in `build-Debug/` and install into `install-Debug/`.
Expand All @@ -62,6 +69,11 @@ The steps detailed below are essentially those that `parallel_build.csh` perform
cd GEOSgcm
checkout_externals
```
###### Checking out develop
To use the `Develop.cfg` file, run:
```
checkout_externals -e Develop.cfg
```

#### Build the Model

Expand Down

0 comments on commit 1a8fcc8

Please sign in to comment.