Creating a Github Repository

This guide will show you how to create a Github repository containing a Jupyter Notebook developed on CyberGISX; however, steps 2-7 can be followed for any file type, should you need to add files to your repository that are not .ipynb notebook files.

1. Download your notebook from CyberGISX

Navigate to the notebook you would like to add to Github in CyberGISX. In the Notebook Window, select File -> Download as -> Notebook (.ipynb)

2. Go to github.com and log in. If you do not have a Github account, follow this guide to set one up.

3. From your main dashboard in Github, select either ‘Create repository’ or click on your profile image and select ‘Your repositories.’

From the ‘Your repositories’ page, select the green ‘New’ button to create a new repository. If you click the ‘Create repository’ button on the main dashboard, you will be directed straight to the next page.

4.  You will be directed to a page where you can give your repository a name, description, and privacy status.

It is recommended that you give your repository the same name as your project. It is also very important that you set your repository’s privacy status to Public. The contents of your notebook cannot be posted on CyberGISX from a private repository. After you have given your repository a name and description, as well as have set its privacy static to Public, you can press ‘Create repository.’

5. Select the link uploading an existing file.

6. Either drag the .ipynb file containing your notebook to the box (pictured below) or select your files from the choose your files link. The file you upload will appear listed below the submission box after it has been successfully uploaded. At this point, you may provide a commit message, and then press ‘Commit changes’ to save your notebook to Github.

You can also add any other files you would like to be in your repository at this time. Think data files, other notebooks, etc. You only need to add one file to initialize the repository, so you can also add extra files later. Note that the manual submission process on Github has a file limit of 100 files. If you need to add more files than this to your repository, add the rest of your files to the same repository later.

7. At this point you will be directed to your repository. It will contain any files you added to it. To add more files, you can click ‘Add File’ and follow a similar upload process to that which is described above.