|
|
<!-- --- title: Accessing the code -->
|
|
|
|
|
|
# OpenFOAM repositories
|
|
|
[[_TOC_]]
|
|
|
|
|
|
## OpenFOAM repositories
|
|
|
|
|
|
OpenFOAM repositories are hosted at the https://develop.openfoam.com webpage.
|
|
|
Many are **public-access** and can be downloaded or cloned directly;
|
... | ... | @@ -16,7 +18,7 @@ _If you have been using the [older OpenFOAM git repository][old-foam-repo] (prio |
|
|
and have code you need to migrate, you should see the [repository migration](Repository-migration) information._
|
|
|
|
|
|
|
|
|
## Organization of git branches
|
|
|
### Organization of git branches
|
|
|
|
|
|
The OpenFOAM repository follows a
|
|
|
[branching workflow](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows)
|
... | ... | @@ -39,7 +41,7 @@ Since they will also occasionally be rebased onto the lastest |
|
|
_develop_, there is ***no*** guarantee of continuity.
|
|
|
|
|
|
|
|
|
## Exploring projects
|
|
|
### Exploring projects
|
|
|
|
|
|
- From the projects menu you can navigate through various projects as shown below.
|
|
|
![GitLab All projects](images/KB-GL-ADV-AllProjects.png)
|
... | ... | @@ -57,9 +59,9 @@ _develop_, there is ***no*** guarantee of continuity. |
|
|
![GitLab repository view](images/KB-GL-ADV-OpenFOAM-repository-view.png)
|
|
|
|
|
|
|
|
|
## Terminal mode (cloning)
|
|
|
### Terminal mode (cloning)
|
|
|
|
|
|
### Get a snapshot
|
|
|
#### 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:
|
|
|
|
... | ... | @@ -87,7 +89,7 @@ git submodule init |
|
|
contains more information.
|
|
|
|
|
|
|
|
|
#### Shallow cloning
|
|
|
##### Shallow cloning
|
|
|
|
|
|
- Shallow cloning is a clone of the last repository state without its
|
|
|
entire history. This makes for a smaller repository and faster cloning.
|
... | ... | @@ -105,7 +107,7 @@ git clone --depth=8 https://develop.openfoam.com/Development/openfoam.git |
|
|
```
|
|
|
|
|
|
|
|
|
### Update existing snapshot
|
|
|
#### Update existing snapshot
|
|
|
|
|
|
- The repositories are updated regularly to include bug fixes and new features. Retrieve the updates using:
|
|
|
```
|
... | ... | @@ -124,7 +126,7 @@ git fetch |
|
|
```
|
|
|
|
|
|
|
|
|
## Registration
|
|
|
### 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)
|
... | ... | @@ -133,7 +135,7 @@ git fetch |
|
|
![GitLab User Registration](images/KB-GL-ADV-Register.png)
|
|
|
|
|
|
|
|
|
### Adding a SSH key
|
|
|
#### Adding a SSH key
|
|
|
|
|
|
If you use SSH for cloning, you can access your profile related
|
|
|
settings from the top-right of the browser page. Follow the steps
|
... | ... | |