Skip to content

Latest commit

 

History

History
20 lines (10 loc) · 1.52 KB

README.md

File metadata and controls

20 lines (10 loc) · 1.52 KB
Raw

Documentation

This directory contains the documentation for the arcadia_pycolor package.

Quickstart guide

If you are new to using the package, we recommend starting with the quickstart guide. This provides a quick introduction to the arcadia_pycolor package and how to use it to style Matplotlib and seaborn plots so that they comply with the Arcadia style guide.

Detailed documentation

  • color_usage.ipynb: This notebook explains how to use the built-in color palettes and gradients and how to modify them to create your own custom color palettes and gradients.

  • style_usage.ipynb: This notebook explains in more detail how the package sets the default styles for Matplotlib and how to use the style_plot function to apply the Arcadia style guide to individual plots. It also explains additional features of the apc.mpl module, like pre-defined figure sizes and a way to save figures with the correct resolution.

  • color_vision_deficiency_tools.ipynb: This notebook explains how to use the color vision deficiency tools in the package to simulate color vision deficiencies in your plots. These tools are for testing the accessibility of your plots to people with color vision deficiencies. They are primarly intended for expert users and graphic designers.

Examples

The examples directory contains examples of some common plot types that demonstrate how to use the package to style Matplotlib and seaborn plots.