• Be a member of yj27 project on NCI Gadi for data access. If you aren't a member yet then please request membership;

• Write permissions to this repository. If you don't have write permissions then please raise an issue. Include a description of the file you want to upload.

This will load required system libraries and automatically activate the coastal-commons-recipes python environment.

module use /g/data/yj27/public/modules 
module load pyvenv/coastal-commons-recipes

To facilitate the process which involve many steps, we have created a bash script to automate most of it. To start off, you need to be in the same folder where coastal-commons repo is. It is recommended to avoid any problem, that you create a new folder which will contain coastal-commons and source bare repository and the bash script "automate_github_recipes.sh". After cloning "coastal-commons" repo, copy the bash script to recentlty created folder as below:

mkdir temporary
cd temporary
git clone https://github.com/ACCESS-Community-Hub/coastal-commons.git
cp coastal-commons/automate_github_recipes.sh ../

To use the automate script you need to also inform the path to the file you want to copy (skipping the name of the source repo since it assumes by default it is "ACCESS-NRI-SEACOFS.git") and the commit comment as string:

bash automate_github_recipes.sh Recipes/OHC_calculation.ipynb "Copying OHC recipe"

After that you just need to monitor the terminal and press ENTER when it is requested and you don't run into any error.

When the copy is pushed to the remote repo, you will need to visit coastal-commons on Github. Click on the link printed on the terminal with a message like:

remote: Create a pull request for 'import-recipe' on GitHub by visiting:
remote:      https://github.com/ACCESS-Community-Hub/coastal-commons/pull/new/import-recipe

Do the pull request and if you have permissions merge into main. After you have done that, go back to your terminal and press ENTER. This will remove the branch created, clean, and pull your coastal-commons with the new changes to keep it updated.