Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Updated readme #19

Merged
merged 1 commit into from
May 19, 2020
Merged

[docs] Updated readme #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 101 additions & 88 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ add_executable(example example.cpp)
target_link_libraries(example PRIVATE cppcolormap)
```

Note that the target `cppcolormap` includes the target `xtensor` (itself automatically enforcing the minimal C++14 standard), which is automatically searched using `find_package(cppcolormap)`.
Note that the target *cppcolormap* includes the target *xtensor* (itself automatically enforcing the minimal C++14 standard), which is automatically searched using `find_package(cppcolormap)`.

Compilation can then proceed using

Expand Down Expand Up @@ -231,7 +231,7 @@ cd cppcolormap
python -m pip install .
```

Note that you have to install the dependencies pybind11, xtensor, and pyxtensor first.
Note that you have to install the dependencies *pybind11*, *xtensor*, and *pyxtensor* first.

## Usage

Expand Down Expand Up @@ -274,8 +274,8 @@ import numpy as np
import cppcolormap as cm

x, y = np.meshgrid(
np.linspace(0, 1, 100),
np.linspace(0, 1, 100))
np.linspace(0, 1, 100),
np.linspace(0, 1, 100))

d = np.sqrt(x ** 2.0 + y ** 2.0)

Expand Down Expand Up @@ -338,13 +338,26 @@ plt.show()

## matplotlib

| Name | Inverse colormap |
|----------|------------------|
| magma | magma_r |
| inferno | inferno_r |
| plasma | plasma_r |
| viridis | viridis_r |
| jet | jet_r |
| Name | Inverse colormap |
|---------------|------------------|
| spring | spring_r |
| summer | summer_r |
| autumn | autumn_r |
| winter | winter_r |
| bone | bone_r |
| cool | cool_r |
| hot | hot_r |
| copper | copper_r |
| hsv | hsv_r |
| nipy_spectral | nipy_spectral_r |
| terrain | terrain_r |
| seismic | seismic_r |
| afmhot | afmhot_r |
| magma | magma_r |
| inferno | inferno_r |
| plasma | plasma_r |
| viridis | viridis_r |
| jet | jet_r |

> Copyright (c) New matplotlib colormaps by Nathaniel J. Smith, Stefan van der Walt, and
> in the case of viridis) Eric Firing.
Expand All @@ -357,83 +370,83 @@ plt.show()

| Name | Inverse colormap | Source |
|----------------|------------------|--------|
| White | - | - |
| Grey | - | - |
| Black | - | - |
| Red | - | - |
| Blue | - | - |
| tuedarkblue | - | 1 |
| tueblue | - | 1 |
| tuelightblue | - | 1 |
| tuewarmred | - | 1 |
| Apricot | - | 2 |
| Aquamarine | - | 2 |
| Bittersweet | - | 2 |
| Black | - | 2 |
| Blue | - | 2 |
| BlueGreen | - | 2 |
| BlueViolet | - | 2 |
| BrickRed | - | 2 |
| Brown | - | 2 |
| BurntOrange | - | 2 |
| CadetBlue | - | 2 |
| CarnationPink | - | 2 |
| Cerulean | - | 2 |
| CornflowerBlue | - | 2 |
| Cyan | - | 2 |
| Dandelion | - | 2 |
| DarkOrchid | - | 2 |
| Emerald | - | 2 |
| ForestGreen | - | 2 |
| Fuchsia | - | 2 |
| Goldenrod | - | 2 |
| Gray | - | 2 |
| Green | - | 2 |
| GreenYellow | - | 2 |
| JungleGreen | - | 2 |
| Lavender | - | 2 |
| LimeGreen | - | 2 |
| Magenta | - | 2 |
| Mahogany | - | 2 |
| Maroon | - | 2 |
| Melon | - | 2 |
| MidnightBlue | - | 2 |
| Mulberry | - | 2 |
| NavyBlue | - | 2 |
| OliveGreen | - | 2 |
| Orange | - | 2 |
| OrangeRed | - | 2 |
| Orchid | - | 2 |
| Peach | - | 2 |
| Periwinkle | - | 2 |
| PineGreen | - | 2 |
| Plum | - | 2 |
| ProcessBlue | - | 2 |
| Purple | - | 2 |
| RawSienna | - | 2 |
| Red | - | 2 |
| RedOrange | - | 2 |
| RedViolet | - | 2 |
| Rhodamine | - | 2 |
| RoyalBlue | - | 2 |
| RoyalPurple | - | 2 |
| RubineRed | - | 2 |
| Salmon | - | 2 |
| SeaGreen | - | 2 |
| Sepia | - | 2 |
| SkyBlue | - | 2 |
| SpringGreen | - | 2 |
| Tan | - | 2 |
| TealBlue | - | 2 |
| Thistle | - | 2 |
| Turquoise | - | 2 |
| Violet | - | 2 |
| VioletRed | - | 2 |
| White | - | 2 |
| WildStrawberry | - | 2 |
| Yellow | - | 2 |
| YellowGreen | - | 2 |
| YellowOrange | - | 2 |
| White | - | |
| Grey | - | |
| Black | - | |
| Red | - | |
| Blue | - | |
| tuedarkblue | - | [1] |
| tueblue | - | [1] |
| tuelightblue | - | [1] |
| tuewarmred | - | [1] |
| Apricot | - | [2] |
| Aquamarine | - | [2] |
| Bittersweet | - | [2] |
| Black | - | [2] |
| Blue | - | [2] |
| BlueGreen | - | [2] |
| BlueViolet | - | [2] |
| BrickRed | - | [2] |
| Brown | - | [2] |
| BurntOrange | - | [2] |
| CadetBlue | - | [2] |
| CarnationPink | - | [2] |
| Cerulean | - | [2] |
| CornflowerBlue | - | [2] |
| Cyan | - | [2] |
| Dandelion | - | [2] |
| DarkOrchid | - | [2] |
| Emerald | - | [2] |
| ForestGreen | - | [2] |
| Fuchsia | - | [2] |
| Goldenrod | - | [2] |
| Gray | - | [2] |
| Green | - | [2] |
| GreenYellow | - | [2] |
| JungleGreen | - | [2] |
| Lavender | - | [2] |
| LimeGreen | - | [2] |
| Magenta | - | [2] |
| Mahogany | - | [2] |
| Maroon | - | [2] |
| Melon | - | [2] |
| MidnightBlue | - | [2] |
| Mulberry | - | [2] |
| NavyBlue | - | [2] |
| OliveGreen | - | [2] |
| Orange | - | [2] |
| OrangeRed | - | [2] |
| Orchid | - | [2] |
| Peach | - | [2] |
| Periwinkle | - | [2] |
| PineGreen | - | [2] |
| Plum | - | [2] |
| ProcessBlue | - | [2] |
| Purple | - | [2] |
| RawSienna | - | [2] |
| Red | - | [2] |
| RedOrange | - | [2] |
| RedViolet | - | [2] |
| Rhodamine | - | [2] |
| RoyalBlue | - | [2] |
| RoyalPurple | - | [2] |
| RubineRed | - | [2] |
| Salmon | - | [2] |
| SeaGreen | - | [2] |
| Sepia | - | [2] |
| SkyBlue | - | [2] |
| SpringGreen | - | [2] |
| Tan | - | [2] |
| TealBlue | - | [2] |
| Thistle | - | [2] |
| Turquoise | - | [2] |
| Violet | - | [2] |
| VioletRed | - | [2] |
| White | - | [2] |
| WildStrawberry | - | [2] |
| Yellow | - | [2] |
| YellowGreen | - | [2] |
| YellowOrange | - | [2] |

1. [Eindhoven University of Technology](http://www.tue.nl)
2. [LaTeX xcolor (dvipsnames)](https://en.wikibooks.org/wiki/LaTeX/Colors)
Expand Down