Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.22 KB

README.md

File metadata and controls

43 lines (31 loc) · 1.22 KB

pyqg_gallery

A collection of pyqg examples. This gallery is rendered on nbviewer, but examples need to be cloned or downloaded, and executed locally.

Contributing

The workflow for contributing to pyqg_gallery is similar to pyqg's. First fork the repository. Then clone it to your local machine

$ git clone [email protected]:USERNAME/pyqg_gallery

and set you repository to track the upstream repository

$ cd pyqg_gallery
$ git remote add upstream git://github.com/pyqg/pyqg_gallery.git

Make sure to sync your local master branch with upstream/master

$ git fetch upstream
$ git rebase upstream/master

To implement a new example branch off of master

$ git checkout -b new_example

add the new example, test it, and commit you all your changes. Finally push it to github

$ git push new_example

and submit a pull request.

If the example is based on a paper or section of a book, please provide detailed reference or link within the notebook.