|
|
# OpenFOAM repositories
|
|
|
|
|
|
OpenFOAM repositories are accessible from https://develop.openfoam.com/Development/OpenFOAM-plus.
|
|
|
One can nevigate to required branch and download the snapshot as required. However to access advanced features of this repository, an account is needed.
|
|
|
OpenFOAM repositories are hosted at https://develop.openfoam.com/Development/OpenFOAM-plus.
|
|
|
Many are public-access and can be downloaded or cloned directly; to access other internal repositories and take advantage of advanced features users must create an account.
|
|
|
|
|
|
## Registration
|
|
|
|
... | ... | @@ -13,41 +13,44 @@ One can nevigate to required branch and download the snapshot as required. Howev |
|
|
|
|
|
## Exploring projects
|
|
|
|
|
|
* Begin with projects menu and you can navigate through various projects as shown below.
|
|
|
* From the projects menu you can navigate through various projects as shown below.
|
|
|
![GitLab All projects](images/KB-GL-ADV-AllProjects.png)
|
|
|
|
|
|
* You could select any of these projects (e.g. OpenFOAM, ThirdParty,...) to view further details. Since they follow similar web page pattern, an example of selecting the OpenFOAM repository is shown below.
|
|
|
* Selecting a project, e.g. OpenFOAM, ThirdParty, provides further details. Each project has a similar structure; the main OpenFOAM repository is shown below.
|
|
|
![GitLab OpenFOAM project](images/KB-GL-ADV-OpenFOAM-project.png)
|
|
|
|
|
|
* Options for managing notifications level, marking project in favorites (starred projects), or accessing git clone features one can see on right side of webpage as shown below. The clone feature will be discussed separately.
|
|
|
* Options for managing notifications, marking favourites (starred projects), or accessing git clone features are located on the right side of webpage as shown below. See the [Cloning section](#openfoam-repositories_terminal-mode-cloning) for more information.
|
|
|
![GitLab notification settings](images/KB-GL-ADV-project-notification.png)
|
|
|
|
|
|
* If you are looking for one-off download for any particular branch (with no git history), you could browse through required branch and select download options as shown below.
|
|
|
* If you are looking for a one-off download for any particular branch (with no git history), browse to the required branch and select from the download options:
|
|
|
![GitLab download options](images/KB-GL-ADV-project-download.png)
|
|
|
|
|
|
* An alternative way to browse through selected repository (for files, branches, tags,...) is via Repository section as shown below.
|
|
|
* Alternatively, browse a repository for files, branches, tags, etc. via the Repository section:
|
|
|
![GitLab repository view](images/KB-GL-ADV-OpenFOAM-repository-view.png)
|
|
|
|
|
|
|
|
|
## Terminal mode (cloning)
|
|
|
### Get a snapshot
|
|
|
* Cloning provides an easy way to synchronize with latest developments via git commands. Address for cloning is available on right hand side of "Project->Details" slider of repository as shown.
|
|
|
* Cloning allows you to synchronize your local code with the latest developments. The address for cloning is available on the right hand side of "Project->Details" slider of the repository:
|
|
|
|
|
|
![GitLab clone address](images/KB-GL-ADV-project-clone-address.png)
|
|
|
|
|
|
* As seeen in above image, you need to register your public SSH key, if you want to use SSH mode. Refer "Adding SSH key" section below.
|
|
|
* To use the SSH protocol (as shown above) you need to register your public SSH key. Refer to the [Adding an SSH key](#openfoam-repositories_terminal-mode-cloning_adding-an-ssh-key) section for further information.
|
|
|
|
|
|
* You can clone (the default i.e. 'master' branch) using
|
|
|
* Clone the default 'master' branch via SSH using
|
|
|
```
|
|
|
git clone git@develop.openfoam.com:Development/OpenFOAM-plus.git
|
|
|
```
|
|
|
or via http
|
|
|
```
|
|
|
git clone https://develop.openfoam.com:Development/OpenFOAM-plus.git
|
|
|
```
|
|
|
* **Optional:** You may choose to specify the required branch, resulting directory name directly using
|
|
|
|
|
|
* **Optional:** You may specify a target branch directly using
|
|
|
```
|
|
|
git clone -b <branch name> <address of git> <name of resulting directory>
|
|
|
```
|
|
|
e.g. to clone 'develop' branch from repository into OpenFOAM-plus.develop via SSH mode you could use
|
|
|
e.g. to clone the 'develop' branch to your local OpenFOAM-plus.develop directory via SSH:
|
|
|
```
|
|
|
git clone -b develop git@develop.openfoam.com:Development/OpenFOAM-plus.git OpenFOAM-plus.develop
|
|
|
```
|
... | ... | @@ -67,10 +70,9 @@ git pull |
|
|
```
|
|
|
git submodule update
|
|
|
```
|
|
|
* Note that, occasionally if there are merge conflicts during the pull, you might have to resolve them manually or reset the HEAD and pull a fresh.
|
|
|
* Also, one might have to 'force' initialize/ update submodules, if required.
|
|
|
* Note: if you experience merge conflicts during the pull due to your own local code changes, you will need to resolve them manually/reset the state of your repository and re-pull
|
|
|
|
|
|
### Adding SSH key
|
|
|
* On top-right of browser page, you can access your profile related settings as shown below. Follow the steps numbered in the snapshot and add a key to your profile.
|
|
|
### Adding an SSH key
|
|
|
* Access your profile related settings from the top-right of the browser page. Follow the steps numbered in the snapshot to add a key to your profile.
|
|
|
|
|
|
![GitLab Add SSH key](images/KB-GL-ADV-AddSSHKey.png) |
|
|
\ No newline at end of file |
|
|
![GitLab Add SSH key](images/KB-GL-ADV-AddSSHKey.png) |