Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.55 KB

README.md

File metadata and controls

55 lines (38 loc) · 1.55 KB
Raw

plotnine examples

This repository contains examples in the form of jupyter notebooks that are also part of the plotnine documentation

Rebase Notice: When the repository gets large and the will be reduced by deleting the history.

Contributing

  1. Clone repository or pull in latest changes

    git clone https://github.com/has2k1/plotnine-examples

    Or

    cd plotnine-examples
git pull

  2. Create a notebook or edit an existing notebook. The name of the notebook should match the object. e.g if examples are for geom_tile the name should be geom_tile.ipynb.

  3. Execute the notebook once, top to bottom OR preferably if you can (Linux/OSX) run make changes from the command line.

  4. Add your github username and/or name to contributors.txt (sorted according to the username) and commit.

  5. Commit

  6. Push

    cd plotnine-examples
git pull

  7. Submit Pull Request

How to structure a notebook

The plotnine gallery consists of images extracted from the examples. For this to happen, each example in the file should have a ### Title (h3 header) that serves as the title of the example. It should be followed by a *Short Description* (emphasis) directly beneath. The last image of each of these sections in is selected and put in the gallery. Avoid creating # or ## sections.