Skip to content

Commit 0fd54a4

Browse files
committed
tweaks to docs that have already been copied to matplotlib docs
1 parent bd1529f commit 0fd54a4

File tree

1 file changed

+61
-28
lines changed

1 file changed

+61
-28
lines changed

docs/source/index.rst

+61-28
Original file line numberDiff line numberDiff line change
@@ -46,50 +46,72 @@ Colormap details
4646
thermal
4747
^^^^^^^
4848

49-
The *thermal* colormap is sequential with dark blue potentially representing lower values, transitioning through reds to yellow representing increased values. This colormap is meant to appeal to intuition of cooler colors representing cooler temperature and warmer colors as warmer temperature, but to be a sequential colormap to represent data between two temperatures (instead of a diverging, blue to white to red diverging colormap, for example). Several examples of this colormap are shown below, from Texas A&M University gliders and a simulation of the Texas and Louisiana shelf region. This colormap is based on matplotlib's YlGnBu, but was recreated from scratch using the viscm tool.
49+
The *thermal* colormap is sequential with dark blue representing lower, cooler values and transitioning through reds to yellow representing increased warmer values.
50+
51+
.. figure:: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_540/plots/sci_water_temp.png
52+
:target: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_540/plots/
53+
:scale: 100 %
54+
55+
.. figure:: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_541/plots/sci_water_temp.png
56+
:target: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_541/plots/
57+
58+
Glider data from Texas A&M's Geochemical and Environmental Research Group (`GERG <https://gerg.tamu.edu/>`_).
59+
60+
61+
.. figure:: http://pong.tamu.edu/~kthyng/movies/txla_plots/temp/2004-07-30T00.png
62+
:target: http://kristenthyng.com/gallery/txla_temp.html
63+
64+
Model output in the northwest Gulf of Mexico from the Physical Oceanography Numerical Group (`PONG <http://pong.tamu.edu>`_) at Texas A&M.
5065

51-
.. image:: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_540/plots/sci_water_temp.png
52-
:target: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_540/plots/sci_water_temp.png
53-
.. image:: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_541/plots/sci_water_temp.png
54-
:target: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_541/plots/sci_water_temp.png
55-
.. image:: http://pong.tamu.edu/~kthyng/movies/txla_plots/temp/2004-07-30T00.png
56-
:target: http://pong.tamu.edu/~kthyng/movies/txla_plots/temp/2004.mp4
5766

5867
haline
5968
^^^^^^
6069

61-
The *haline* colormap is sequential with dark blue potentially representing lower salinity or fresher water, transitioning through greens to light yellow representing increased salinity or saltier water. Several examples of this colormap are shown below, from Texas A&M University gliders and a simulation of the Texas and Louisiana shelf region. This colormap is based on matplotlib's YlGnBu, but was recreated from scratch using the viscm tool.
70+
The *haline* colormap is sequential, and might be used with dark blue representing lower salinity or fresher water, transitioning through greens to light yellow representing increased salinity or saltier water. This colormap is based on matplotlib's YlGnBu, but was recreated from scratch using the viscm tool.
71+
72+
.. figure:: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_540/plots/calc_salinity.png
73+
:target: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_540/plots/
74+
:scale: 100 %
75+
76+
.. figure:: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_541/plots/calc_salinity.png
77+
:target: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_541/plots/
78+
:scale: 100 %
79+
80+
Glider data from Texas A&M's Geochemical and Environmental Research Group (GERG).
81+
82+
83+
.. figure:: http://pong.tamu.edu/~kthyng/movies/txla_plots/salt/2010-07-30T00.png
84+
:target: http://kristenthyng.com/gallery/txla_salinity.html
85+
:scale: 100 %
86+
87+
Model output in the northwest Gulf of Mexico from the Physical Oceanography Numerical Group (PONG) at Texas A&M.
88+
6289

63-
.. image:: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_540/plots/calc_salinity.png
64-
:target: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_540/plots/calc_salinity.png
65-
.. image:: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_541/plots/calc_salinity.png
66-
:target: http://gcoos2.tamu.edu/gandalf_data/deployments/tamu/unit_541/plots/calc_salinity.png
67-
.. image:: http://pong.tamu.edu/~kthyng/movies/txla_plots/salt/2010-07-30T00.png
68-
:target: http://pong.tamu.edu/~kthyng/movies/txla_plots/salt/2010.mp4
90+
.. figure:: http://clarkrichards.org/figure/source/2016-04-25-making-section-plots/plot2-1.png
91+
:target: http://clarkrichards.org/r/oce/section/ctd/2016/04/25/making-section-plots/
92+
:scale: 100 %
93+
94+
Plotting CTD data (temperature and salinity) with the R `oce` package, by `Clark Richards <http://clarkrichards.org/r/oce/section/ctd/2016/04/25/making-section-plots/>`_
6995

7096
solar
7197
^^^^^
7298

7399
The *solar* colormap is sequential from dark brown for low values to increasingly bright yellow to potentially represent an increase in radiation in the water.
74100

75-
.. plot::
76-
:include-source:
101+
.. figure:: https://plot.ly/~empet/13620.png
102+
:target: https://plot.ly/~empet/13620/_2d-histogram-and-associated-marginals/#plot
77103

78-
import cmocean
79-
import matplotlib.pyplot as plt
80-
81-
fig = plt.figure(figsize=(8, 3))
82-
ax = fig.add_subplot(1, 2, 1)
83-
cmocean.plots.test(cmocean.cm.solar, ax=ax)
84-
ax = fig.add_subplot(1, 2, 2)
85-
cmocean.plots.quick_plot(cmocean.cm.solar, ax=ax)
104+
Histogram from `plotly <https://plot.ly/>`_.
86105

87106
ice
88107
^^^
89108

90-
The *ice* colormap is sequential from very dark blue (almost black) to very light blue (almost white). A use for this could be representations of sea ice. An example is provided by Chad Greene showing sea ice concentration around Antarctica.
109+
The *ice* colormap is sequential from very dark blue (almost black) to very light blue (almost white). A use for this could be representations of sea ice.
110+
111+
.. figure:: http://www.mathworks.com/matlabcentral/mlc-downloads/downloads/submissions/50126/versions/4/previews/seaice/html/SeaIceTimeSeries_20160620.gif
112+
:target: https://www.mathworks.com/matlabcentral/fileexchange/47638-antarctic-mapping-tools
91113

92-
.. image:: http://www.mathworks.com/matlabcentral/mlc-downloads/downloads/submissions/50126/versions/4/previews/seaice/html/SeaIceTimeSeries_20160620.gif
114+
An example is provided by `Chad Greene <http://www.chadagreene.com/>`_ showing sea ice concentration around Antarctica.
93115

94116
gray
95117
^^^^
@@ -254,10 +276,17 @@ The *balance* colormap is diverging with dark blue to off-white to dark red repr
254276
delta
255277
^^^^^
256278

257-
The *delta* colormap is diverging from darker blues to just off-white through shades of yellow green and could be used to represent diverging velocity values around a critical value (usually zero). An example of this colormap is from a numerical simulation of the Texas and Louisiana shelf. This colormap was inspired by `Francesca Samsel's <http://www.francescasamsel.com/>`_ similar colormap, but generated from scratch using the viscm tool.
279+
The *delta* colormap is diverging from darker blues to just off-white through shades of yellow green and could be used to represent diverging velocity values around a critical value (usually zero). This colormap was inspired by `Francesca Samsel's <http://www.francescasamsel.com/>`_ similar colormap, but generated from scratch using the viscm tool.
258280

259-
.. image:: http://pong.tamu.edu/~kthyng/movies/txla_plots/u/2010-07-30T00.png
281+
.. figure:: https://pbs.twimg.com/media/CkIWDFRWkAEdArC.jpg
282+
:target: https://www.instagram.com/p/BGPoO-0Ryg8/
283+
284+
From plotly.
285+
286+
.. figure:: http://pong.tamu.edu/~kthyng/movies/txla_plots/u/2010-07-30T00.png
260287
:target: http://pong.tamu.edu/~kthyng/movies/txla_plots/u/2010.mp4
288+
289+
Model output in the northwest Gulf of Mexico from the Physical Oceanography Numerical Group (PONG) at Texas A&M.
261290

262291
curl
263292
^^^^
@@ -345,6 +374,10 @@ cmocean available elsewhere!
345374

346375
* For `MATLAB <http://www.mathworks.com/matlabcentral/fileexchange/57773-cmocean-perceptually-uniform-colormaps>`_ by `Chad Greene <http://www.chadagreene.com/>`_
347376
* For R: `Oce <http://dankelley.github.io/oce/>`_ oceanographic analysis package by `Dan Kelley <http://www.dal.ca/faculty/science/oceanography/people/faculty/daniel-e-kelley.html>`_ and `Clark Richards <http://clarkrichards.org/>`_
377+
* For `Ocean Data Viewer <https://github.com/kthyng/cmocean-odv>`_
378+
* For `Generic Mapping Tools (GMT) <https://github.com/kthyng/cmocean-gmt>`_
379+
* For `Paraview <https://github.com/kthyng/cmocean-paraview>`_, inspired by `Phillip Wolfram <https://github.com/pwolfram>`_.
380+
* In `Plotly <https://plot.ly/python/cmocean-colorscales/>`_
348381
* Chad Greene's `Antartic Mapping Tools <http://www.mathworks.com/matlabcentral/fileexchange/47638-antarctic-mapping-tools>`_ in Matlab uses cmocean
349382
* In PyNcView: coming soon!
350383

0 commit comments

Comments
 (0)