Skip to content

Commit

Permalink
Adding more forking info.
Browse files Browse the repository at this point in the history
  • Loading branch information
mwaxmonsky committed Jul 24, 2024
1 parent ca1badd commit 5546d06
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/conversion/ccpp-conversion-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ Make sure you have github forks for both ESCOMP/CAM-SIMA and ESCOMP/atmospheric_
To begin, fork ESCOMP/CAM-SIMA:
![text](fork-cam-sima.png "Forking CAM-SIMA")

```bash
git clone https://github.com/<GithubUserID>/CAM-SIMA
cd CAM-SIMA
And select the `Create new fork` option. This will bring you to the "Create new fork" screen:
![text](fork-cam-sima-2.png "Forking CAM-SIMA")

```
!!! note Uncheck the "Copy the `main` branch only" option

Failure to uncheck this will prevent you from pulling in updates from the `development` branch easily.

As you make changes and want to commit them to your github repos, you’ll be managing two separate repos. When you issue git commands, be aware of where you are in your code tree. If you want to see changes in CAM-SIMA, you can issue a `git status` in the main CAM-SIMA directory. If you want to see changes in the atmospheric_physics repo, make sure you are in `src/physics/ncar_ccpp` before you issue the `git status` command. All other git commands will be relative to your current working directory as well.

NOTE: As you make changes and want to commit them to your github repos, you’ll be managing two separate repos. When you issue git commands, be aware of where you are in your code tree. If you want to see changes in CAM-SIMA, you can issue a “git status” in the main CAM-SIMA directory. If you want to see changes in the atmospheric_physics repo, make sure you are in src/physics/ncar_ccpp before you issue the “git status” command. All other git commands will be relative to your current working directory as well.
Binary file added docs/conversion/fork-cam-sima-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ markdown_extensions:
custom_checkbox: true
- attr_list
- md_in_html
- admonition

extra_css:
- stylesheets/extra.css

0 comments on commit 5546d06

Please sign in to comment.