Skip to content

Commit 4de7b1c

Browse files
committed
working on updating docs
1 parent abd8ed3 commit 4de7b1c

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

docs/source/index.rst

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Beautiful colormaps for oceanography: `cmocean <http://github.com/matplotlib/cmo
88

99
This package contains colormaps for commonly-used oceanographic variables. Most of the colormaps started from `matplotlib <http://matplotlib.org/>`_ colormaps, but have now been adjusted using the `viscm tool <https://github.com/BIDS/viscm>`_ to be `perceptually uniform <http://bids.github.io/colormap/>`_.
1010

11+
We have a paper with guidelines to colormap selection for your application and a description of the `cmocean` colormaps:
12+
Thyng, K. M., Greene, C. A., Hetland, R. D., Zimmerle, H. M., & DiMarco, S. F. (2016). True colors of oceanography. Oceanography, 29(3), 10.
13+
link: `<http://tos.org/oceanography/assets/docs/29-3_thyng.pdf>`_
14+
1115
Here is our gallery:
1216

1317
.. plot::
@@ -64,6 +68,20 @@ The *thermal* colormap is sequential with dark blue representing lower, cooler v
6468
Model output in the northwest Gulf of Mexico from the Physical Oceanography Numerical Group (`PONG <http://pong.tamu.edu>`_) at Texas A&M.
6569

6670

71+
.. figure:: https://media.springernature.com/m685/springer-static/image/art%3A10.1038%2Fs41598-017-16760-0/MediaObjects/41598_2017_16760_Fig5_HTML.jpg
72+
:target: https://www.nature.com/articles/s41598-017-16760-0
73+
:scale: 100 %
74+
75+
Data from publication: Kenel, C., et al. "In situ investigation of phase transformations in Ti-6Al-4V under additive manufacturing conditions combining laser melting and high-speed micro-X-ray diffraction." Scientific reports 7.1 (2017): 16358.
76+
77+
78+
.. figure:: http://www.mdpi.com/sensors/sensors-17-02679/article_deploy/html/images/sensors-17-02679-g002-550.jpg
79+
:target: http://www.mdpi.com/1424-8220/17/11/2679/htm
80+
:scale: 100 %
81+
82+
Usamentiaga, Rubén, et al. "Nondestructive evaluation of carbon fiber bicycle frames using infrared thermography." Sensors 17.11 (2017): 2679.
83+
84+
6785
haline
6886
^^^^^^
6987

@@ -269,7 +287,7 @@ The *delta* colormap is diverging from darker blues to just off-white through sh
269287

270288
.. figure:: http://pong.tamu.edu/~kthyng/movies/txla_plots/u/2010-07-30T00.png
271289
:target: http://pong.tamu.edu/~kthyng/movies/txla_plots/u/2010.mp4
272-
290+
273291
Model output in the northwest Gulf of Mexico from the Physical Oceanography Numerical Group (PONG) at Texas A&M.
274292

275293
curl
@@ -312,7 +330,7 @@ The colormap instances can be accessed with:
312330
.. ipython:: python
313331
314332
import cmocean
315-
333+
316334
cmaps = cmocean.cm.cmap_d;
317335
318336
Print all of the available colormaps to text files with 256 rgb entries with:
@@ -364,7 +382,13 @@ cmocean available elsewhere!
364382
* In `Plotly <https://plot.ly/python/cmocean-colorscales/>`_
365383
* Chad Greene's `Antartic Mapping Tools <http://www.mathworks.com/matlabcentral/fileexchange/47638-antarctic-mapping-tools>`_ in Matlab uses cmocean
366384
* For `Tableau <https://www.tableau.com>`_ as a preferences file on `github <https://github.com/shaunwbell/cmocean_tableau>`_
367-
.. * In PyNcView: coming soon!
385+
* For `ImageJ <https://imagej.nih.gov/ij/>`_ as a preferences file on `LUTs <https://github.com/mikeperrins/cmocean-LUT-ImageJ>`_
386+
* In `iGOTM <https://igotm.bolding-bruggeman.com/>`_, which simulates a water column anywhere in the world.
387+
* cmocean colormaps are included in the package `colormap <https://github.com/bpostlethwaite/colormap>`_
388+
* cmocean colormaps are used in the following publications:
389+
* Kenel, C., et al. "In situ investigation of phase transformations in Ti-6Al-4V under additive manufacturing conditions combining laser melting and high-speed micro-X-ray diffraction." Scientific reports 7.1 (2017): 16358. `<https://www.nature.com/articles/s41598-017-16760-0>`_
390+
* Usamentiaga, Rubén, et al. "Nondestructive evaluation of carbon fiber bicycle frames using infrared thermography." Sensors 17.11 (2017): 2679. `<http://www.mdpi.com/1424-8220/17/11/2679/htm>`_
391+
368392

369393
Examples of beautiful visualizations:
370394
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -417,4 +441,3 @@ Indices and tables
417441
* :ref:`genindex`
418442
* :ref:`modindex`
419443
* :ref:`search`
420-

0 commit comments

Comments
 (0)