Getting Started

To install NC², run the following command:

pip install nc2

After installation, you can run NC² from the command line as follows:

nc2 path/to/your/file.nc

You can also run NC² without a preloaded file:

nc2

Using NC²

Select NetCDF File

To select a file using your operating system's file explorer, use the 'Select NetCDF File' button.

Select Variable

Use the "Select Variable" dropdown to choose which variable in your NetCDF file you want to visualize.

Select Time Step

For three dimensional data, use the "Select Time Step" dropdown to select the specific time step for the variable you are viewing.

Select Depth Level

For four dimensional data, use the "Select Depth Level" dropdown to choose the depth level you want to visualize.

Plot Types and Colormaps

• Select Plot Type: Choose the type of plot (e.g., pcolormesh, contour).

• Dynamic Plot Option Settings: Pcolormesh is the standard plot type. When selecting a different plot type, the settings will update dynamically:

  

• Select Colormap: Choose the colormap for your plot.
• Reverse Colormap: Toggle to reverse the colormap.
• Colorbar Orientation: Choose the orientation of the colorbar (right, left, top, bottom).

• Colorbar Shrink: float, default: 1.0 (Fraction by which to multiply the size of the colorbar).

  

Adjust Plot Parameters

• V-Max and V-Min: float, optional (Define the data range that the colormap covers).
• Extents: Define the geographical extents of the plot as ‘xmin, xmax, ymin, ymax.’
• Projections: Specify the projection for the plot (e.g., PlateCarree).
• Gridlines and Alpha: Toggle gridlines and adjust transparency.

• Ocean/Land Toggle: Ocean/land Cfeature masking.

  

Time Plot and Depth Plot

Show Time Plot: Click to visualize a time series of your selected variable at a specific depth

Show Depth Plot: Click to visualize a depth series of your selected variable at a specific time step.

Vertical Section Plots

Input a longitude coordinate and press the slice button to produce a vertical section at a meridian line

Input a latitude coordinate and press the slice button to produce a vertical section at a parallel line

GIF Generation

• FPS: Specify the FPS (Frames Per Second) of the GIF file
• Range: Specify the indice that the GIF generation should stop at
• Loop: Produce a looping GIF file

• Delete/Save Images: Delete or save images after GIF generation

  

The “Make GIF” Checkbutton must be selected to generate a GIF. When it is selected, the user cannot select a specific timestep as well. The “Save GIF” Button opens up a file explorer where you must select a directory for the GIF to be generated. Press the “Plot Variable” Button to generate the GIF.

GIF Playback

• Play: Play the GIF at standard speed (10 FPS)
• Pause: Pause the GIF
• Reverse: Reverse the GIF at standard speed
• Stop: Restart the GIF playback and reset speed
• Slow («): Slow down by increments of 2 FPS

• Speed (»): Speed up by increments of 2 FPS

  

Navigation Toolbar

• Home, Forward and Back buttons: Forward/Back are used to navigate back and forth between previously defined views. Home always takes you to the default view of your data.
• Pan/Zoom: Press the left mouse button and hold it to pan the figure, dragging it to a new position. Press the right mouse button to zoom, dragging it to a new position.
• Zoom to Rectangle: Define a rectangular region by dragging the mouse while holding the button to a new location. When using the left mouse button, the axes view limits will be zoomed to the defined region.
• Configure Subplots: Use this tool to configure the appearance of the subplot (stretch/compress the left, right, top, or bottom side of the subplot.
• Save Figure: Click this button to launch a file save dialog. You can save files with the following extensions: png, ps, eps, svg and pdf.
• Forward (») Button: Advance the time step selection by one.
• Back («) Button: Reverse the time step selection by one.

Metadata and Statistics

• View detailed metadata about the loaded NetCDF file

• View basic statistics of your selected variable at a specific time and/or depth

• View lon, lat, I and J indices, and the data value where the mouse is currently hovering

Additional Features

• Show in Window: Toggle to display the plot in a separate window.

• Labels: Add labels for X-axis and Y-axis.
• Plot Title: Set a title for your plot.
• Themes: Select a theme for NC² from a a dropdown of light and dark options.

Contact Me

For any inquiries, suggestions, or feedback, feel free to reach out:

Email: rhettadambusiness@gmail.com

Rhett R. Adam

VU Undergrad EES