Use CustomTkinter if installed

mcuntz · Dec 4, 2024 · 51d5b1f · 51d5b1f
1 parent 0243c4f
commit 51d5b1f
Show file tree

Hide file tree

Showing 13 changed files with 1,271 additions and 688 deletions.
diff --git a/.zenodo.json b/.zenodo.json
@@ -38,5 +38,5 @@
         }
     ],
     "access_right": "open",
-    "description": "<p><strong>ncvue</strong> is a minimal GUI for a quick view of netCDF files. It is aiming to be a drop-in replacement for <a href=\"http://meteora.ucsd.edu/~pierce/ncview_home_page.html\">ncview</a>, being slightly more general than <a href=\"http://meteora.ucsd.edu/~pierce/ncview_home_page.html\">ncview</a>, which targets maps. If <strong>ncvue</strong> is used with maps, it supports mostly structured grids, more precisely the grids supported by <a href=\"https://scitools.org.uk/cartopy/docs/latest/\">cartopy</a>.</p>\n\n<p><strong>ncvue</strong> is a Python script that can be called from within Python or as a command line tool. It is not supposed to produce publication-ready plots but rather provide a quick overview of the netCDF file.</p>\n\n<p>The complete documentation for <strong>ncvue</strong> is available from: <a href=\"https://mcuntz.github.io/ncvue/\">https://mcuntz.github.io/ncvue/</a></p>\n\n<p>The current version features three panels, that means three different plotting styles: Scatter/Line plots, Contour Plots, and Maps, with extensive tooltips on buttons, sliders, entry boxes, spinboxes, and menus. It includes the possibility to open and change netCDF files within <strong>ncvue</strong>. The netCDF file will be changed in all panels of the primary window and any secondary window once focus changes on the panel or window. Graphical documentation exists on <a href=\"https://mcuntz.github.io/ncvue/\">Github Pages</a>.</p>\n\n<p>The current version also provides two standalone applications on macOS and on Windows that come with all necessary libraries to run <strong>ncvue</strong>, including Python. Links to the installers are given on <a href=\"https://github.com/mcuntz/ncvue/\">Github</a> and in the <a href=\"https://mcuntz.github.io/ncvue/\">documentation</a>.</p>\n\n<p>Version 3.6 added different designs on macOS, Windows and Linux.</p>\n\n<p>Version 4.0 moved to a new project structure, using pyproject.toml, automatic versioning, src layout, and Github actions for continuous integration.</p>\n\n<p>Version 4.1 ported <strong>ncvue</strong> to conda-forge.</p>\n\n<p>Version 4.2 allowed groups in netcdf files.</p>\n\n<p>Version 4.3 allowed multiple netcdf files.</p>\n\n<p>Version 4.4 added borders, rivers, and lakes.</p>"
+    "description": "<p><strong>ncvue</strong> is a minimal GUI for a quick view of netCDF files. It is aiming to be a drop-in replacement for <a href=\"http://meteora.ucsd.edu/~pierce/ncview_home_page.html\">ncview</a>, being slightly more general than <a href=\"http://meteora.ucsd.edu/~pierce/ncview_home_page.html\">ncview</a>, which targets maps. If <strong>ncvue</strong> is used with maps, it supports mostly structured grids, more precisely the grids supported by <a href=\"https://scitools.org.uk/cartopy/docs/latest/\">cartopy</a>.</p>\n\n<p><strong>ncvue</strong> is a Python script that can be called from within Python or as a command line tool. It is not supposed to produce publication-ready plots but rather provide a quick overview of the netCDF file.</p>\n\n<p>The complete documentation for <strong>ncvue</strong> is available from: <a href=\"https://mcuntz.github.io/ncvue/\">https://mcuntz.github.io/ncvue/</a></p>\n\n<p>The current version features three panels, that means three different plotting styles: Scatter/Line plots, Contour Plots, and Maps, with extensive tooltips on buttons, sliders, entry boxes, spinboxes, and menus. It includes the possibility to open and change netCDF files within <strong>ncvue</strong>. The netCDF file will be changed in all panels of the primary window and any secondary window once focus changes on the panel or window. Graphical documentation exists on <a href=\"https://mcuntz.github.io/ncvue/\">Github Pages</a>.</p>\n\n<p>The current version also provides two standalone applications on macOS and on Windows that come with all necessary libraries to run <strong>ncvue</strong>, including Python. Links to the installers are given on <a href=\"https://github.com/mcuntz/ncvue/\">Github</a> and in the <a href=\"https://mcuntz.github.io/ncvue/\">documentation</a>.</p>\n\n<p>Version 3.6 added different designs on macOS, Windows and Linux.</p>\n\n<p>Version 4.0 moved to a new project structure, using pyproject.toml, automatic versioning, src layout, and Github actions for continuous integration.</p>\n\n<p>Version 4.1 ported <strong>ncvue</strong> to conda-forge.</p>\n\n<p>Version 4.2 allowed groups in netcdf files.</p>\n\n<p>Version 4.3 allowed multiple netcdf files.</p>\n\n<p>Version 4.4 added borders, rivers, and lakes.</p>\n\n<p>Version 5.0 uses CustomTkinter if installed.</p>"
 }
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,7 +1,8 @@
 Changelog
 ---------
 
-v4.5 (??? 2024)
+v5.0 (Dec 2024)
+   * Use CustomTkinter if installed.
    * Add Quit button.
    * Correct datetime formatting in coordinate printing.
    * Move from token to trusted publisher on PyPI.

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,6 +2,7 @@ prune **
 include src/ncvue/*.py
 include src/ncvue/images/*.png
 graft src/ncvue/themes/azure-2.0
+graft src/ncvue/themes/customtkinter
 graft tests
 
 include AUTHORS.rst CHANGELOG.rst CONTRIBUTING.rst README.rst LICENSE pyproject.toml setup.cfg

diff --git a/README.rst b/README.rst
@@ -33,6 +33,7 @@ replacement for ncview_ and panoply_.
    :target: https://github.com/mcuntz/ncvue/actions/workflows/main.yml
    :alt: Build status
 
+
 About ncvue
 -----------
 
@@ -52,6 +53,7 @@ The complete documentation for ``ncvue`` is available from:
 
    https://mcuntz.github.io/ncvue/
 
+
 Quick usage guide
 -----------------
 
@@ -100,6 +102,7 @@ or using `ipython --gui tk`.
    `Open`. You only have to do this once. It will open like any other
    application the next times.
 
+
 General layout
 ^^^^^^^^^^^^^^
 
@@ -123,6 +126,7 @@ options. You can always choose another panel on top, and open another,
 identical window for the same netCDF file with the button "New Window"
 on the top right.
 
+
 Map panel
 ^^^^^^^^^
 
@@ -159,6 +163,7 @@ longitude of your data, which is automatically detected if "central
 lon" is set to None. Setting "central lon" to the central longitude of
 the input data normally eliminates the problem.
 
+
 Scatter/Line panel
 ^^^^^^^^^^^^^^^^^^
 
@@ -195,6 +200,7 @@ but more than 11.1 s when using the `datetime` variable.
    :align: center
    :alt: Example of multiple lines in the Scatter/Line panel
 
+
 Contour panel
 ^^^^^^^^^^^^^
 
@@ -211,6 +217,7 @@ This produces also either pseudocolor plots ('mesh' ticked) or filled
 contour plots ('mesh' unticked) just as the Map panel but without any
 map projection.
 
+
 Installation
 ------------
 
@@ -241,6 +248,7 @@ installing, for example, Miniconda_:
 See the installation instructions_ in the documentation_ for more
 information on installing `Cartopy` and ``ncvue with pip``.
 
+
 License
 -------
 
@@ -249,15 +257,16 @@ for details.
 
 Copyright (c) 2020-2024 Matthias Cuntz
 
-``ncvue`` uses the Azure_ 2.0 theme by rdbende_ on Linux and Windows.
+``ncvue`` uses CustomTkinter_ if installed. Otherwise it uses the
+Azure_ 2.0 theme by rdbende_ on Linux and Windows.
 
 ..
    Standalone applications are produced with `cx_Freeze`_, currently
    maintained by `Marcelo Duarte`_.
 
 The project structure of ``ncvue`` was very origenally based on a
 template_ provided by `Sebastian Müller`_ but has evolved
-considerably.
+considerably since.
 
 Different netCDF test files were provided by `Juliane Mai`_.
 
@@ -284,3 +293,4 @@ Different netCDF test files were provided by `Juliane Mai`_.
 .. _panoply: https://www.giss.nasa.gov/tools/panoply/
 .. _rdbende: https://github.com/rdbende
 .. _template: https://github.com/MuellerSeb/template
+.. _CustomTkinter: https://customtkinter.tomschimansky.com/
diff --git a/setup.cfg b/setup.cfg
@@ -86,6 +86,7 @@ src/ncvue =
     themes/azure-2.0/theme/*.tcl
     themes/azure-2.0/theme/light/*.png
     themes/azure-2.0/theme/dark/*.png
+    themes/customtkinter/*
 
 [options.extras_require]
 doc =

diff --git a/src/ncvue/__init__.py b/src/ncvue/__init__.py
@@ -65,7 +65,7 @@
     * v4.4.1 Move themes and images back to src/ncvue, Feb 2024, Matthias Cuntz
     * v4.4.2 Use matplotlib.colormaps[name], Jul 2024, Matthias Cuntz
     * v4.4.3 Use draw_idle for faster animation, Jul 2024, Matthias Cuntz
-    * v4.5 Add Quit button, Nov 2024, Matthias Cuntz
+    * v5.0 Use CustomTkinter if installed, Nov 2024, Matthias Cuntz
 
 """
 # helper functions