Skip to content

Commit 9550eac

Browse files
lukelbdlukelbd
committed
Standardize cmap/cycle file formats, add docs info
1 parent 051e617 commit 9550eac

51 files changed

Lines changed: 3089 additions & 1615 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/showcase/showcase_110_1.svg‎

Lines changed: 1308 additions & 1321 deletions
Loading

docs/showcase/showcase_134_0.svg renamed to docs/showcase/showcase_135_0.svg

File renamed without changes.

docs/showcase/showcase_137_0.svg renamed to docs/showcase/showcase_138_0.svg

File renamed without changes.

docs/showcase/showcase_139_0.svg renamed to docs/showcase/showcase_140_0.svg

File renamed without changes.

docs/showcase/showcase_143_0.svg renamed to docs/showcase/showcase_145_0.svg

File renamed without changes.

docs/showcase/showcase_144_0.svg renamed to docs/showcase/showcase_146_0.svg

File renamed without changes.

docs/showcase/showcase_147_0.svg renamed to docs/showcase/showcase_149_0.svg

File renamed without changes.

‎docs/showcase5.rst‎

Lines changed: 40 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ from other online data viz projects. Use `~proplot.demos.cmap_show` to
4949
generate a table of registered maps, as shown below. The figure is
5050
broken down into the following sections:
5151

52-
- “User” colormaps, i.e. colormaps saved to your ``~/.proplot`` folder.
53-
A great way to save colormaps to this folder is using the
52+
- “User” colormaps, i.e. colormaps saved to your ``~/.proplot/cmaps``
53+
folder. A great way to save colormaps to this folder is using the
5454
`~proplot.colortools.Colormap` constructor function. See
5555
:ref:`On-the-fly colormaps` for details.
5656
- Original matplotlib maps, created by the matplotlib team.
@@ -366,14 +366,29 @@ non-linear in saturation.
366366
Adding online colormaps
367367
-----------------------
368368

369+
There are plenty of online interactive tools for generating perceptually
370+
uniform colormaps, including
371+
`HCLWizard <http://hclwizard.org:64230/hclwizard/>`__,
372+
`Chroma.js <https://gka.github.io/palettes/#colors=lightyellow,orange,deeppink,darkred%7Csteps=7%7Cbez=1%7CcoL=1>`__,
373+
`SciVisColor <https://sciviscolor.org/home/colormaps/>`__, and `HCL
374+
picker <http://tristen.ca/hcl-picker/#/hlc/12/0.99/C6F67D/0B2026>`__.
375+
376+
To add colormaps downloaded from any of these sources, save the colormap
377+
data to a file in your ``~/.proplot/cmaps`` folder, then call
378+
`~proplot.colortools.register_cmaps`. The file should be named
379+
``name.ext``, where ``name`` is the registered colormap name and ``ext``
380+
is the file extension. See `~proplot.colortools.register_cmaps` for
381+
valid file extensions.
382+
369383
Registered color cycles
370384
-----------------------
371385

372386
Use `~proplot.demos.cycle_show` to generate a table of registered
373-
color cycles, and color cycles saved to your ``~/.proplot`` folder. You
374-
can make your own color cycles using the `~proplot.colortools.Cycle`
375-
constructor function. See the :ref:`Color usage` introduction for more
376-
on the differences between colormaps and color cycles.
387+
color cycles, and color cycles saved to your ``~/.proplot/cycles``
388+
folder. You can make your own color cycles using the
389+
`~proplot.colortools.Cycle` constructor function. See the
390+
:ref:`Color usage` introduction for more on the differences between
391+
colormaps and color cycles.
377392

378393
.. code:: ipython3
379394
@@ -382,7 +397,7 @@ on the differences between colormaps and color cycles.
382397
383398
384399
385-
.. image:: showcase/showcase_134_0.svg
400+
.. image:: showcase/showcase_135_0.svg
386401

387402

388403
On-the-fly color cycles
@@ -423,7 +438,7 @@ every time you import ProPlot.
423438
424439
425440
426-
.. image:: showcase/showcase_137_0.svg
441+
.. image:: showcase/showcase_138_0.svg
427442

428443

429444
Finally, *colormaps* (or combinations thereof) can be used as sources
@@ -455,12 +470,25 @@ the colormap before drawing colors from said map. See
455470
456471
457472
458-
.. image:: showcase/showcase_139_0.svg
473+
.. image:: showcase/showcase_140_0.svg
459474

460475

461476
Adding online color cycles
462477
--------------------------
463478

479+
There are plenty of online interactive tools for generating and testing
480+
color cycles, including `i want
481+
hue <http://tools.medialab.sciences-po.fr/iwanthue/index.php>`__,
482+
`coolers <https://coolors.co>`__, and `viz
483+
palette <https://projects.susielu.com/viz-palette>`__.
484+
485+
To add color cycles downloaded from any of these sources, save the cycle
486+
data to a file in your ``~/.proplot/cycles`` folder, then call
487+
`~proplot.colortools.register_cycles`. The file should be named
488+
``name.ext``, where ``name`` is the registered cycle name and ``ext`` is
489+
the file extension. See `~proplot.colortools.register_cmaps` for valid
490+
file extensions.
491+
464492
Registered color names
465493
----------------------
466494

@@ -495,7 +523,7 @@ selecting colors for scientific visualizations.
495523
496524
497525
498-
.. image:: showcase/showcase_143_0.svg
526+
.. image:: showcase/showcase_145_0.svg
499527

500528

501529
.. code:: ipython3
@@ -505,7 +533,7 @@ selecting colors for scientific visualizations.
505533
506534
507535
508-
.. image:: showcase/showcase_144_0.svg
536+
.. image:: showcase/showcase_146_0.svg
509537

510538

511539
Individual color sampling
@@ -544,4 +572,4 @@ by the `~proplot.colortools.ColorDictSpecial` class.
544572
545573
546574
547-
.. image:: showcase/showcase_147_0.svg
575+
.. image:: showcase/showcase_149_0.svg

proplot/cmaps/CoolWarm1.xrgb renamed to proplot/cmaps/BuPi.xrgb

File renamed without changes.

proplot/cmaps/CoolWarm2.xrgb renamed to proplot/cmaps/CoolWarm.xrgb

File renamed without changes.

0 commit comments

Comments
 (0)