Setting Up Your Fork

When working with a fork, follow these steps to set up your local development environment:

If you need help with git, have a look at the Git QuickSheet.

Fork the repository: Create your own copy of the repository on GitHub.

On GitHub, navigate to the Ocean4DVarNet repository : https://github.com/CIA-Oceanix/ocean4dvarnet
On the top-right corner of the page, click Fork.
Select create a new fork
Under "Owner", select your login in the dropdown menu
Under "Repository Name" don't use the same name as the upstream repository ocean4dvarnet, but customize it to distinguish it further. Keep a name including "ocean4dvarnet", ie my-ocean4dvarnet
In the "Description" field, type a description of your fork i.e "Fork of the ocean4dvarnet package"
Select Copy the DEFAULT branch only.. you only need to copy the default branch. If you do not select this option, all branches will be copied into the new fork.
Then click on Create fork, and wait. "It should only take a few seconds".

A this step, you have your own fork of the Ocean4DVarNet repository on you github account.

More informations following this GitHub forking a repository tutorial.

Clone your fork: Download your forked repository to your local machine

On GitHub, navigate to your fork of the Ocean4DVarNet repository, click on <>Code and get the SSH url.

Clone your fork of the Ocean4DVarNet repository on you local machine

$ git clone https://github.com/YOUR-USERNAME/my-ocean4dvarnet
> Cloning into 'my-ocean4dvarnet'...
> remote: Enumerating objects: 99, done.
> remote: Counting objects: 100% (99/99), done.
> remote: Compressing objects: 100% (65/65), done.
> remote: Total 99 (delta 58), reused 70 (delta 33), pack-reused 0 (from 0)
> Receiving objects: 100% (99/99), 50.73 KiB | 16.91 MiB/s, done.
> Resolving deltas: 100% (58/58), done.

To go up created directory :
```
$ cd my-ocean4dvarnet
```

More informations following this section of the tutorial.

Keep your fork Up to date : Configuring Git to sync your fork with the upstream repository

Display informations about the remote connexion of your fork repository : it is not connected to the upstream repository anymore, so it can not fetch updates.

$ git remote -v
> origin    git@github.com:YOUR-USERNAME/my-ocean4dvarnet.git (fetch)
> origin    git@github.com:YOUR-USERNAME/my-ocean4dvarnet.git (push)

Add the upstream remote, to connect your local repository to the original repository
```
$ git remote add upstream https://github.com/CIA-Oceanix/ocean4dvarnet.git
```

Verify the change with

$ git remote -v
> origin    git@github.com:YOUR-USERNAME/my-ocean4dvarnet.git (fetch)
> origin    git@github.com:YOUR-USERNAME/my-ocean4dvarnet.git (push)
> upstream  https://github.com/CIA-Oceanix/ocean4dvarnet.git (fetch)
> upstream  https://github.com/CIA-Oceanix/ocean4dvarnet.git (push)

Prevent accidental pushes to upstream: After setting up your fork and configuring the original repository as an upstream remote, it’s a good practice to prevent accidental pushes to the upstream repository. You can do this by explicitly setting the push URL of the upstream remote to no_push.
```
$ git remote set-url --push upstream no_push
```

Verify the change with

$ git remote -v
> origin      git@github.com:YOUR-USERNAME/my-ocean4dvarnet.git (fetch)
> origin      git@github.com:YOUR-USERNAME/my-ocean4dvarnet.git (push)
> upstream    https://github.com/CIA-Oceanix/ocean4dvarnet.git (fetch)
> upstream    no_push (push)

Now, you can keep your fork synced with the upstream repository with

$ git fetch upstream main
> From https://github.com/CIA-Oceanix/ocean4dvarnet
> * branch            main       -> FETCH_HEAD

With this configuration, you can still fetch updates from the upstream repository but won’t be able to accidentally push changes to it.

More informations by following this section of the tutorial.