Add links to macOS dmg and CustomTkinter examples

mcuntz · Dec 24, 2024 · 28376a9 · 28376a9
1 parent d9d90e4
commit 28376a9
Show file tree

Hide file tree

Showing 52 changed files with 762 additions and 926 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>\n\n<p>Version 5.0 uses CustomTkinter if installed.</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>\n\n<p>Version 5.1 provides disk images with standalone versions.</p>"
 }
diff --git a/README.rst b/README.rst
@@ -3,7 +3,8 @@ ncvue - A GUI to view netCDF files
 ..
   pandoc -f rst -o README.html -t html README.rst
   As docs/src/readme.rst:
-    replace _small.png with .png
+    replace _customtkinter_small with _customtkinter_screenshot
+    remove all _small in figures
     replace
       higher resolution images can be found in the documentation_
     with
@@ -47,7 +48,7 @@ precisely the grids supported by cartopy_.
 ``ncvue`` 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.
+netCDF file(s).
 
 The complete documentation for ``ncvue`` is available from:
 
@@ -83,24 +84,29 @@ cannot launch it from within `iPython` if it was launched with
 or using `ipython --gui tk`.
 
 ..
-   One can also install standalone macOS or Windows applications that
-   come with everything needed to run ``ncvue`` including Python:
+  One can also install standalone macOS or Windows applications that
+  come with everything needed to run ``ncvue`` including Python:
+
+We also provide standalone (Apple notarized) macOS applications that
+come with everything needed to run ``ncvue`` including Python:
+
+  - `ncvue 4.0`_ for macOS 10.x with Intel processor
+  - `ncvue 5.1 (Aqua, Intel)`_ for macOS 14+ [Sonoma] in Aqua look on
+    Intel processors
+  - `ncvue 5.1 (Aqua, ARM)`_ for macOS 14+ [Sonoma] in Aqua look on
+    ARM processors
+  - `ncvue 5.1 (CustomTkinter, Intel)`_ for macOS 14+ [Sonoma] in
+    CustomTkinter look on Intel processors
+  - `ncvue 5.1 (CustomTkinter, ARM)`_ for macOS 14+ [Sonoma] in
+    CustomTkinter look on ARM processors
 
-   - `macOS app`_ (macOS > 10.13 [High Sierra] on Intel)
-   - `Windows executable`_ (Windows 10)
-
-   The macOS app should work from macOS 10.13 (High Sierra) onward on
-   Intel processors. There is no standalone application for macOS on
-   Apple Silicon (M1) chips because I do not have a paid Apple
-   Developer ID. Other installation options work, though.
+..
+  - `Windows executable`_ (Windows 10)
 
-   A dialog box might pop up on macOS saying that the ``ncvue.app`` is
-   from an unidentified developer. This is because ``ncvue`` is an
-   open-source software.  Depending on the macOS version, it offers to
-   open it anyway. In later versions of macOS, this option is only given
-   if you right-click (or control-click) on the ``ncvue.app`` and choose
-   `Open`. You only have to do this once. It will open like any other
-   application the next times.
+`ncvue 4.0` should work from macOS 10.13 (High Sierra) onward on Intel
+processors. `ncvue > 5.0` is either for Intel processors or for Apple
+Silicon (ARM) chips. It comes in the standard Aqua look or uses the
+CustomTkinter_ UI-library.
 
 
 General layout
@@ -126,6 +132,16 @@ 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.
 
+If CustomTkinter_ is installed (`python -m pip install
+customtkinter`), then the general layout looks like this:
+
+.. image:: https://mcuntz.github.io/ncvue/images/scatter_panel_light_customtkinter_small.png
+   :width: 507 px
+   :align: left
+   :alt: ncvue layout with CustomTkinter
+
+CustomTkinter_ does not work well with Conda_.
+
 
 Map panel
 ^^^^^^^^^
@@ -163,14 +179,21 @@ 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.
 
+The mapping window looks like this with CustomTkinter_:
+
+.. image:: https://mcuntz.github.io/ncvue/images/map_panel_light_customtkinter_small.png
+   :width: 507 px
+   :align: left
+   :alt: Map panel with CustomTkinter
+
 
 Scatter/Line panel
 ^^^^^^^^^^^^^^^^^^
 
 If ``ncvue`` does not detect latitude and longitude variables with a
 size greater than 1, it opens the Scatter/Line panel by default. This
-is the Scatter/Line panel in macOS dark mode, describing all buttons,
-sliders, entry boxes, spinboxes, and menus:
+is the Scatter/Line panel in macOS dark mode (Aqua look), describing
+all buttons, sliders, entry boxes, spinboxes, and menus:
 
 .. image:: https://mcuntz.github.io/ncvue/images/scatter_panel_dark_small.png
    :width: 860 px
@@ -271,7 +294,6 @@ considerably since.
 Different netCDF test files were provided by `Juliane Mai`_.
 
 .. _Anaconda: https://www.anaconda.com/products/individual
-.. _macOS app: http://www.macu.de/extra/ncvue-4.0.dmg
 .. _Azure: https://github.com/rdbende/Azure-ttk-theme
 .. _cartopy: https://scitools.org.uk/cartopy/docs/latest/
 .. _Conda: https://docs.conda.io/projects/conda/en/latest/
@@ -294,3 +316,8 @@ Different netCDF test files were provided by `Juliane Mai`_.
 .. _rdbende: https://github.com/rdbende
 .. _template: https://github.com/MuellerSeb/template
 .. _CustomTkinter: https://customtkinter.tomschimansky.com/
+.. _ncvue 4.0: http://www.macu.de/extra/ncvue-4.0.dmg
+.. _ncvue 5.1 (Aqua, Intel): http://www.macu.de/extra/ncvue-5.1.aqua.intel.dmg
+.. _ncvue 5.1 (Aqua, ARM): http://www.macu.de/extra/ncvue-5.1.aqua.arm64.dmg
+.. _ncvue 5.1 (CustomTkinter, Intel): http://www.macu.de/extra/ncvue-5.1.ctkinter.intel.dmg
+.. _ncvue 5.1 (CustomTkinter, ARM): http://www.macu.de/extra/ncvue-5.1.ctkinter.arm64.dmg
diff --git a/docs/html/.buildinfo.bak b/docs/html/.buildinfo.bak
diff --git a/docs/html/_modules/index.html b/docs/html/_modules/index.html
@@ -39,7 +39,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
 
-    <script src="../_static/documentation_options.js?v=e04695b1"></script>
+    <script src="../_static/documentation_options.js?v=f6ea6760"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -48,7 +48,7 @@
     <link rel="search" title="Search" href="../search.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="5.1.dev1" />
+  <meta name="docsearch:version" content="5.2.dev0" />
   </head>