Editing Colorblindfriendly (section)

=== Import as a module ===

[[File:colorblindfriendly_menu.png|thumb|Screenshot of the <code>cb_colors</code> color menu in the OpenGL GUI in PyMOL 2.0.]]

After importing the module, call the <code>set_colors()</code> function to add the colors to PyMOL's color palette.  Then, use these color names just like any other named color, using the <code>[[color]]</code> command.

<syntaxhighlight lang="python">
import colorblindfriendly as cbf

# Add the new colors
cbf.set_colors()
color cb_red, myObject
</syntaxhighlight>

The colors can also be made to replace the built-in colors (i.e. they are created both with and without the "<code>cb_</code>" prefix.). Do this by passing the <code>replace</code> keyword argument.

<syntaxhighlight lang="python">
# Replace built-in colors with cbf ones
cbf.set_colors(replace=True)
color yellow, myOtherObject   # actually cb_yellow
</syntaxhighlight>

One can also add an entry to the color menu in the right-side OpenGL GUI.  So clicking on [C], there will now be a <code>cb_colors</code> menu item, which expands to give all the color blind-friendly colors, except black, which is available in the <code>grays</code> menu.

<syntaxhighlight lang="python">
# Add a `cb_colors` menu to the OpenGL GUI (see screenshot)
# This will also add the colors if `set_colors()` hasn't yet been run.
cbf.add_menu()
</syntaxhighlight>