... | ... | @@ -5,41 +5,45 @@ |
|
|
OpenFOAM repositories are hosted at the https://develop.openfoam.com webpage.
|
|
|
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
|
|
|
|
|
|
* Go to https://develop.openfoam.com and create a new user account
|
|
|
* A confirmation email will be sent to the registered address (check the spam folder if no emails are received after a few minutes)
|
|
|
* Follow the link to complete the sign-up process
|
|
|
- Go to https://develop.openfoam.com and create a new user account
|
|
|
- A confirmation email will be sent to the registered address (check the spam folder if no emails are received after a few minutes)
|
|
|
- Follow the link to complete the sign-up process
|
|
|
|
|
|
![GitLab User Registration](images/KB-GL-ADV-Register.png)
|
|
|
|
|
|
|
|
|
## Exploring projects
|
|
|
|
|
|
* From the projects menu 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)
|
|
|
|
|
|
* Selecting a project, e.g. OpenFOAM, ThirdParty, provides further details. Each project has a similar structure; the main 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, 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.
|
|
|
- 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 a one-off download for any particular branch (with no git history), browse to the required branch and select from the download options:
|
|
|
- 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)
|
|
|
|
|
|
* Alternatively, browse a repository for files, branches, tags, etc. via the Repository section:
|
|
|
- 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 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:
|
|
|
|
|
|
- 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)
|
|
|
|
|
|
* 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.
|
|
|
- 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.
|
|
|
|
|
|
* Clone the default *master* branch via HTTPS using
|
|
|
- Clone the default _master_ branch via HTTPS using
|
|
|
```
|
|
|
git clone https://develop.openfoam.com:Development/OpenFOAM-plus.git
|
|
|
```
|
... | ... | @@ -48,16 +52,16 @@ or via SSH |
|
|
git clone git@develop.openfoam.com:Development/OpenFOAM-plus.git
|
|
|
```
|
|
|
|
|
|
* **Optional:** You may specify a target branch 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 the *develop* branch to your local OpenFOAM-plus.develop directory via HTTPS:
|
|
|
e.g. to clone the _develop_ branch to your local OpenFOAM-plus.develop directory via HTTPS:
|
|
|
```
|
|
|
git clone -b develop https://develop.openfoam.com:Development/OpenFOAM-plus.git OpenFOAM-plus.develop
|
|
|
```
|
|
|
|
|
|
* Since [OpenFOAM-v1712](https://www.openfoam.com/releases/openfoam-v1712) community contributions may be included using the git submodule system. To initialise the submodules located in the [$WM_PROJECT_DIR/modules](https://develop.openfoam.com/Development/OpenFOAM-plus/tree/master/modules) directory:
|
|
|
- Since [OpenFOAM-v1712](https://www.openfoam.com/releases/openfoam-v1712) community contributions may be included using the git submodule system. To initialise the submodules located in the [$WM_PROJECT_DIR/modules](https://develop.openfoam.com/Development/OpenFOAM-plus/tree/master/modules) directory:
|
|
|
```
|
|
|
git submodule init
|
|
|
```
|
... | ... | @@ -67,17 +71,19 @@ git submodule init |
|
|
|
|
|
### Update existing snapshot
|
|
|
|
|
|
* The repositories are updated regularly to include bug fixes and new features. Retrieve the updates using:
|
|
|
- The repositories are updated regularly to include bug fixes and new features. Retrieve the updates using:
|
|
|
```
|
|
|
git pull
|
|
|
```
|
|
|
* To update the additional community repositories, issue the command:
|
|
|
- To update the additional community repositories, issue the command:
|
|
|
```
|
|
|
git submodule update
|
|
|
```
|
|
|
* 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
|
|
|
- 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 a 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. You may add multiple SSH keys and distinguish them with proper title.
|
|
|
|
|
|
- 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. You may add multiple SSH keys and distinguish them with proper title.
|
|
|
|
|
|
![GitLab Add SSH key](images/KB-GL-ADV-AddSSHKey.png) |