API

Contents

API#

Purpose#

ncvue is a minimal GUI for a quick view of netcdf files. It is aiming to be a drop-in replacement for ncview and panoply, being slightly more general than ncview targeting maps but providing animations, zooming and panning capabilities unlike panoply.

copyright:

Copyright 2020-2021 Matthias Cuntz - mc (at) macu (dot) de

license:

MIT License, see LICENSE for details.

Subpackages#

ncvcontour

Contour panel of ncvue.

ncvmain

Main ncvue window.

ncvmap

Map panel of ncvue.

ncvmethods

Common methods for panels of ncvue.

ncvscatter

Scatter/Line panel of ncvue.

ncvue([ncfile, miss])

The main function to start the data frame GUI.

ncvutils

Utility functions for ncvue.

ncvwidgets

Widget functions.

History
  • Written Nov 2020 by Matthias Cuntz (mc (at) macu (dot) de)

  • v1.0, initial PyPI commit, Nov 2020, Matthias Cuntz

  • v1.1, modularised, having utilities and panels in individual files, Dec 2020, Matthias Cuntz

  • v1.2, Make lists of spinbox labels and values, outsource common methods, Dec 2020, Matthias Cuntz

  • v1.3, fix colorbar and gridlines in contour, invert x in scatter, Dec 2020, Matthias Cuntz

  • v1.4, Read only slice from disk, respect unlimited dimension, visual colorbar chooser, Dec 2020, Matthias Cuntz

  • v2.0, Added map panel, Jan 2021, Matthias Cuntz

  • v3.0, First version to be tested elsewhere, documentation on Github Pages, allow spaces in variable names, bug fixes, Jan 2021, Matthias Cuntz

  • v3.1, Include png files in ncvue/images in PyPI wheel, Jan 2021, Matthias Cuntz

  • v3.2, Open netcdf files from within ncvue, Jan 2021, Matthias Cuntz

  • v3.3, Standalone apps for macOS and Windows, Feb 2021, Matthias Cuntz

  • v3.3.1, Better installation instructions, Feb 2021, Matthias Cuntz

  • v3.4, Print values, draw grid lines in contour, May 2021, Matthias Cuntz

  • v3.5, Uses different themes on different OS, Jun 2021, Matthias Cuntz

  • v3.5.1, Explicitly set labelling of second y-axis to the right, Jun 2021, Matthias Cuntz

  • v3.6, standalone with cx_Freeze, separate units with space, Jun 2021, Matthias Cuntz

  • v3.7, new themes from rdbende on Linux and Windows, Sep 2021, Matthias Cuntz

  • v3.8, Better detection of lon/lat and working without them, Oct 2021, Matthias Cuntz

  • v4.0, pyproject.toml, src layout, and Github actions, Oct 2021, Matthias Cuntz

  • v4.1, final add_cyclic and has_cyclic as committed to cartopy, Nov 2021, Matthias Cuntz

  • v4.1.2, ncvue is gui_script entry_point, Jun 2022, Matthias Cuntz

  • v4.2, allow groups in netcdf files, Jan 2024, Matthias Cuntz

  • v4.3, allow multiple netcdf files, Jan 2024, Matthias Cuntz

  • v4.4, Add borders, rivers, and lakes checkbuttons in map, Feb 2024, Matthias Cuntz

  • v4.4.1 Move themes and images back to src/ncvue, Feb 2024, Matthias Cuntz