VCS Allows scientists to produce highly customized plots. Everything can be precisely and logically controlled.
To download this Jupyter Notebook, right click on the link and choose "Download Linked File As..." or "Save Link as...". Remember where you saved the downloaded file, which should have an .ipynb extension. (You'll need to launch the Jupyter notebook or JupyterLab instance from the location where you store the notebook file.)
# VCS Object definitions
import vcs
import cdms2
import os
vcs.download_sample_data_files()
with cdms2.open(os.path.join(vcs.sample_data,"clt.nc")) as f:
clt = f("clt")
u = f("u")
v = f("v")
with cdms2.open(os.path.join(vcs.sample_data,"sampleCurveGrid4.nc")) as f:
curv = f("sample")
with cdms2.open(os.path.join(vcs.sample_data,"sampleGenGrid3.nc")) as f:
gen = f("sample")
x = vcs.init(geometry=(600,400),bg=True)
# Styling for the notebook
from IPython.core.display import HTML
HTML("""
<style>
.output_png {
display: table-cell;
text-align: center;
vertical-align: middle;
}
</style>
""")
Essentially a vcs plot can be broken down into three parts:
WHAT is plotted (e.g data and labels) HOW it is rendered (isolines, boxfill, isofill, vectors, etc...) and WHERE (the location on the page where each element is to be plotted)
This is the scientific piece of information that the user is trying to represent for others (or oneself) to understand. It can be as raw as a simple numpy object. It is recommended to use CDMS's transient variables. CDMS transient variables contain metadata such as name, units, and geospatial information that can be used by VCS to better represent the data.
The [tutorials] section has many CDMS examples. The CDMS documentation can be found here.
This describes the data representation. At the highest level it is a graphics method
i.e boxfill, isofill, vectors, streamlines, line plot, etc., but it also contains information to further control these plot types, e.g. which colors to use, which levels, line thickness, etc.
Graphic methods also describe how axes and labels should be represented (e.g. which axis values to show and which text to use for the values. The user might want to show the -20.
longitude represented as 20S
or the date 2020-01-15
shown as Jan 2020
.
Currently VCS supports the following graphic methods:
Boxfill is used to represent 2-dimensional arrays, filling each array cell with a color representing its value. In the case of rectilinear grids where x and y axes can be represented by a 1-dimensional array, we use the axes bounds to determine the extent of each cell. This is especially useful if an axis is not increasing constantly (e.g. a gaussian grid or pressure levels).
For more information on boxfill, please see the dedicated tutorial.
gm = vcs.createboxfill()
x.plot(clt, gm)
An isoline is a line on a map, chart, or graph that connects points of equal value.
gm = vcs.createisoline()
x.clear()
x.plot(clt,gm)
The isofill graphic method is similar to isolines (and usually plotted in conjounction with it) except that the area between two consecutive isolines is filled with a color representing the range of values in this area.
x.clear()
gm = vcs.createisofill()
x.plot(clt,gm)
Meshfill is very similar to boxfill, but is used to represent data on generic grids (a.k.a. native representation) based on the input data and a mesh.
x.clear()
gm = x.createmeshfill()
gm.mesh = True
x.plot(gen, gm)
x.clear()
gm = vcs.createstreamline()
x.plot(u,v,gm)
A vector plot is a collection of arrows with a given magnitude and direction, each attached to a point in the plane.
x.clear()
gm = vcs.createvector()
x.plot(u,v, gm)
A line plot is a graph that shows the frequency of data along a number line.
For more information on 1D or line plots please see the dedicated tutorial.
Also of interest is the EzPlot Example tutorial.
x.clear()
gm = vcs.create1d()
x.plot(clt[:,34,23]) # extract a time series at one point on the globe and plot it in 1D
Taylor diagrams are mathematical diagrams designed to graphically indicate which of several approximate representations (or models) of a system, process, or phenomenon is most realistic.
Please see the Taylor Diagrams tutorial for more information.
Where each element of a plot is located on the page is the most complicated part of VCS but also one of the most powerful. Templates precisely control the location of every component on the plot. For detailed information on templates, please see the VCS Templates tutorial.
Text objects allow you to insert text anywhere on the plot. Text objects are made by combining two different objects: text orientation objects and text table objects.
For more details on text in vcs see this dedicated tutorial.
x.clear()
txt = vcs.createtext()
txt.string="A Text Object"
txt.height=25
txt.x = [.5]
txt.y=[.5]
txt.list()
x.plot(txt)
Line objects allow you to draw lines on the plot. By closing the line you can draw a polygon.
x.clear()
line = vcs.createline()
line.x = [0.1, .5, 0.9]
line.y = [0.1, .2, 0.9]
x.plot(line)
The filled ploygon object allows you to draw a filled polygon on the plot.
x.clear()
filled = vcs.createfillarea()
filled.x = [0.1, .5, 0.9]
filled.y = [0.1, .2, 0.9]
x.plot(filled)
x.clear()
mrk = vcs.createmarker()
mrk.type = "hurricane"
mrk.x = [.5]
mrk.y = [.5]
mrk.size = 15
x.plot(mrk)
Colormap objects are used to control the colors on vcs plots. They can be attached to a secondary object, graphic methods, or canvases.
For more details on existing color maps in VCS see the Color Map tutorial. For information on creating your own colormap, see this tutorial.
When plotting latitude/longitude plots (2d graphic methods) you can specifiy and control the projection associated with the plot. Projection objects are then attached to the graphic method.
x.clear()
gm = vcs.createisofill()
proj = vcs.createprojection()
proj.type="lambert"
proj.list()
proj.originlatitude=30.
gm.projection = proj
x.plot(clt(latitude=(10,50),longitude=(-130,-70)), gm)
The CDAT software was developed by LLNL. This tutorial was written by Charles Doutriaux. This work was performed under the auspices of the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract DE-AC52-07NA27344.
If you have questions about this notebook, please email our CDAT Support address, cdat-support@llnl.gov.