batplot 1.7.28__py3-none-any.whl → 1.8.1__py3-none-any.whl

batplot/session.py

@@ -578,7 +578,10 @@ def dump_operando_session(
         # Use masked arrays to preserve NaNs if present
         data = _np.array(arr)  # preserves mask where possible
         extent = tuple(map(float, im.get_extent())) if hasattr(im, 'get_extent') else None
-        cmap_name = getattr(im.get_cmap(), 'name', None)
+        # Get colormap name: first check if we stored it explicitly, otherwise try to get from colormap object
+        cmap_name = getattr(im, '_operando_cmap_name', None)
+        if cmap_name is None:
+            cmap_name = getattr(im.get_cmap(), 'name', None)
         clim = tuple(map(float, im.get_clim())) if hasattr(im, 'get_clim') else None
         origin = getattr(im, 'origin', 'upper')
         interpolation = getattr(im, 'get_interpolation', lambda: None)() or 'nearest'
@@ -870,6 +873,8 @@ def load_operando_session(filename: str):
         cmap_name = 'viridis'
     im = ax.imshow(arr, aspect='auto', origin=op.get('origin', 'upper'), extent=extent,
                    cmap=cmap_name, interpolation=op.get('interpolation', 'nearest'))
+    # Store the colormap name explicitly so it can be retrieved reliably when saving
+    setattr(im, '_operando_cmap_name', cmap_name)
     if op.get('clim'):
         try:
             im.set_clim(*op['clim'])
@@ -1315,6 +1320,18 @@ def load_operando_session(filename: str):
         elif ec_h_offset is not None:
             # EC panel doesn't exist but offset was saved - ignore it
             pass
+        
+        # Apply layout with loaded offsets to ensure visual position matches saved position
+        # This must happen after all offsets and geometry parameters are set
+        try:
+            from .operando_ec_interactive import _apply_group_layout_inches, _ensure_fixed_params
+            # Get current geometry parameters (which should match what was just loaded)
+            cb_w_i, cb_gap_i, ec_gap_i, ec_w_i, ax_w_i, ax_h_i = _ensure_fixed_params(fig, ax, cbar_ax, ec_ax)
+            # Apply layout with loaded offsets (offsets are already set as attributes above)
+            _apply_group_layout_inches(fig, ax, cbar_ax, ec_ax, ax_w_i, ax_h_i, cb_w_i, cb_gap_i, ec_gap_i, ec_w_i)
+        except Exception:
+            # If layout application fails, continue - better to have a slightly wrong layout than crash
+            pass
     except Exception:
         pass
 

batplot/utils.py

@@ -540,6 +540,46 @@ def list_files_in_subdirectory(extensions: tuple, file_type: str, base_path: str
     return sorted(files, key=lambda x: x[0])
 
 
+def convert_label_shortcuts(text: str) -> str:
+    """Convert shortcut syntax to LaTeX format for labels.
+    
+    Converts {super(...)} and {sub(...)} shortcuts to LaTeX superscript/subscript format.
+    This allows easier input of mathematical notation without typing full LaTeX.
+    
+    Args:
+        text: Label text that may contain {super(...)} or {sub(...)} shortcuts
+        
+    Returns:
+        Text with shortcuts converted to LaTeX format (uses \\mathrm{} to prevent italic rendering).
+        
+    Examples:
+        >>> convert_label_shortcuts("g{super(-1)}")
+        "g$^{\\mathrm{-1}}$"
+        >>> convert_label_shortcuts("Li{sub(2)}FeSeO")
+        "Li$_{\\mathrm{2}}$FeSeO"
+        >>> convert_label_shortcuts("H{sub(2)}O")
+        "H$_{\\mathrm{2}}$O"
+    """
+    if not text:
+        return text
+    
+    import re
+    
+    # Convert {super(...)} to $^{\mathrm{...}}$ to prevent italic rendering
+    # Pattern matches {super(anything inside)}
+    # Use \mathrm{} to ensure non-italic rendering unless explicitly specified
+    # Need to escape backslashes in replacement string for LaTeX commands
+    text = re.sub(r'\{super\(([^)]+)\)\}', r'$^{\\mathrm{\1}}$', text)
+    
+    # Convert {sub(...)} to $_{\mathrm{...}}$ to prevent italic rendering
+    # Pattern matches {sub(anything inside)}
+    # Use \mathrm{} to ensure non-italic rendering unless explicitly specified
+    # Need to escape backslashes in replacement string for LaTeX commands
+    text = re.sub(r'\{sub\(([^)]+)\)\}', r'$_{\\mathrm{\1}}$', text)
+    
+    return text
+
+
 def normalize_label_text(text: str) -> str:
     """Normalize axis label text for proper matplotlib rendering.
     

batplot/version_check.py

@@ -53,6 +53,54 @@ import time
 from pathlib import Path
 from typing import Optional, Tuple
 
+# ====================================================================================
+# UPDATE INFO CONFIGURATION
+# ====================================================================================
+# Edit this section to customize update notification messages and add update info.
+# 
+# HOW TO USE:
+# ----------
+# When releasing a new version, edit the UPDATE_INFO dictionary below to include
+# information about what's new or important in the update. This information will
+# be displayed to users when they run batplot and a newer version is available.
+#
+# EXAMPLE:
+# --------
+# UPDATE_INFO = {
+#     'custom_message': "This update includes important bug fixes and new features.",
+#     'update_notes': [
+#         "- Fixed colormap preservation issue in session files",
+#         "- Improved legend positioning when toggling visibility",
+#         "- Added superscript/subscript shortcuts for labels",
+#         "- Enhanced version check notifications"
+#     ],
+#     'show_update_notes': True,
+# }
+#
+# To disable custom messages, set 'custom_message' to None.
+# To disable update notes, set 'update_notes' to None or an empty list [].
+# ====================================================================================
+
+UPDATE_INFO = {
+    # Custom message to include in update notification
+    # Set to None or empty string to disable
+    # This will be displayed as an additional line in the update message box
+    'custom_message': "This update includes important bug fixes",  # Example: "This update includes important bug fixes."
+    
+    # Additional notes about the update (list of strings)
+    # Set to None or empty list [] to disable
+    # Each item in the list will be displayed as a separate line
+    'update_notes': None,  # Example: ["- Fixed colormap preservation issue", "- Improved legend positioning"]
+    
+    # Whether to show update notes if provided
+    # Set to False to hide update notes even if they are defined
+    'show_update_notes': True,
+}
+
+# ====================================================================================
+# END OF UPDATE INFO CONFIGURATION
+# ====================================================================================
+
 
 def get_cache_file() -> Path:
     """Get the path to the version check cache file."""
@@ -160,12 +208,43 @@ def _print_update_message(current: str, latest: str) -> None:
         current: Current version
         latest: Latest available version
     """
-    print(f"\n\033[93m╭{'─' * 68}╮\033[0m")
-    print(f"\033[93m│\033[0m  \033[1mA new version of batplot is available!\033[0m" + " " * 31 + "\033[93m│\033[0m")
-    print(f"\033[93m│\033[0m  Current: \033[91m{current}\033[0m → Latest: \033[92m{latest}\033[0m" + " " * (42 - len(current) - len(latest)) + "\033[93m│\033[0m")
-    print(f"\033[93m│\033[0m  Update with: \033[96mpip install --upgrade batplot\033[0m" + " " * 20 + "\033[93m│\033[0m")
-    print(f"\033[93m│\033[0m  To disable this check: \033[96mexport BATPLOT_NO_VERSION_CHECK=1\033[0m" + " " * 7 + "\033[93m│\033[0m")
-    print(f"\033[93m╰{'─' * 68}╯\033[0m\n")
+    # Calculate box width (minimum 68, expand if needed for longer messages)
+    box_width = 68
+    custom_msg = UPDATE_INFO.get('custom_message')
+    update_notes = UPDATE_INFO.get('update_notes')
+    show_notes = UPDATE_INFO.get('show_update_notes', True)
+    
+    # Calculate required width based on content
+    max_line_len = 68  # Default minimum width
+    if custom_msg:
+        max_line_len = max(max_line_len, len(custom_msg) + 4)
+    if update_notes and show_notes:
+        for note in update_notes:
+            max_line_len = max(max_line_len, len(note) + 4)
+    # Ensure box width is at least the calculated width
+    box_width = max(68, min(max_line_len, 100))  # Cap at 100 for readability
+    
+    print(f"\n\033[93m╭{'─' * box_width}╮\033[0m")
+    print(f"\033[93m│\033[0m  \033[1mA new version of batplot is available!\033[0m" + " " * max(0, box_width - 34) + "\033[93m│\033[0m")
+    print(f"\033[93m│\033[0m  Current: \033[91m{current}\033[0m → Latest: \033[92m{latest}\033[0m" + " " * max(0, box_width - 20 - len(current) - len(latest)) + "\033[93m│\033[0m")
+    
+    # Add custom message if provided
+    if custom_msg and custom_msg.strip():
+        # Truncate if too long to fit in box
+        msg = custom_msg[:box_width - 6] if len(custom_msg) > box_width - 6 else custom_msg
+        print(f"\033[93m│\033[0m  {msg}" + " " * max(0, box_width - len(msg) - 4) + "\033[93m│\033[0m")
+    
+    # Add update notes if provided
+    if update_notes and show_notes and isinstance(update_notes, list):
+        for note in update_notes:
+            if note and note.strip():
+                # Truncate if too long to fit in box
+                note_text = note[:box_width - 6] if len(note) > box_width - 6 else note
+                print(f"\033[93m│\033[0m  {note_text}" + " " * max(0, box_width - len(note_text) - 4) + "\033[93m│\033[0m")
+    
+    print(f"\033[93m│\033[0m  Update with: \033[96mpip install --upgrade batplot\033[0m" + " " * max(0, box_width - 34) + "\033[93m│\033[0m")
+    print(f"\033[93m│\033[0m  To disable this check: \033[96mexport BATPLOT_NO_VERSION_CHECK=1\033[0m" + " " * max(0, box_width - 45) + "\033[93m│\033[0m")
+    print(f"\033[93m╰{'─' * box_width}╯\033[0m\n")
 
 
 if __name__ == '__main__':

{batplot-1.7.28.dist-info → batplot-1.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: batplot
-Version: 1.7.28
+Version: 1.8.1
 Summary: Interactive plotting tool for material science (1D plot) and electrochemistry (GC, CV, dQ/dV, CPC, operando) with batch processing
 Author-email: Tian Dai <tianda@uio.no>
 License: MIT License

{batplot-1.7.28.dist-info → batplot-1.8.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
-batplot/__init__.py,sha256=-ltjJXFlBiOKZsOOZXOESTkYH2FPtkDXmHBrbMWVfVc,119
-batplot/args.py,sha256=6g1eHVsycDSAenwrXuCTcyuXCy_-30zy1lWtdguBG2s,34983
+batplot/__init__.py,sha256=AjJgj7OxrIM-uNCR6JvGnRjpVNZgCUbmj0VE_BpFFF8,118
+batplot/args.py,sha256=GXOO5jfTSmd5y_MiGyabh-mgJsCrg3mKVfTwe1eKOYc,34961
 batplot/batch.py,sha256=YQ7obCIqLCObwDbM7TXpOBh7g7BO95wZNsa2Fy84c6o,53858
 batplot/batplot.py,sha256=40lU1nY1NqeAOpzNG_vLF_L34COKhiA19pMpbvA3SJc,171885
 batplot/cif.py,sha256=JfHwNf3SHrcpALc_F5NjJmQ3lg71MBRSaIUJjGYPTx8,30120
@@ -7,22 +7,22 @@ batplot/cli.py,sha256=ScDb2je8VQ0mz_z0SLCHEigiTuFPY5pb1snnzCouKms,5828
 batplot/color_utils.py,sha256=7InQLVo1XTg7sgAbltM2KeDSFJgr787YEaV9vJbIoWY,20460
 batplot/config.py,sha256=6nGY7fKN4T5KZUGQS2ArUBgEkLAL0j37XwG5SCVQgKA,6420
 batplot/converters.py,sha256=rR2WMPM0nR5E3eZI3gWbaJf_AfbdQx3urVSbJmZXNzo,8237
-batplot/cpc_interactive.py,sha256=7J_aj9fYXqjTWJWM7QqfyYrQcJCtFErH6mCsluXhzj4,232888
-batplot/electrochem_interactive.py,sha256=W1bWrA8sqpVvYyZC6T5Y8IWQcNGgjRoVJtBWHrMdIcY,218567
-batplot/interactive.py,sha256=cU7i6S2MRUjUA0DwCchIdk8vmnBgpcsZuBPBVsispUI,204281
+batplot/cpc_interactive.py,sha256=HrrjaB8-CNYUitgl5zWMNvWQLZfxyFAtpSm67qoi-nE,238235
+batplot/electrochem_interactive.py,sha256=ti7V8BoAxUk4BD_vDRKAu5ydlHMl75htLvdVYFUUVsw,221778
+batplot/interactive.py,sha256=uerVR-56g2Ur8qDZ-cXffPbpYMQXEXiMNXCxyWZZ8k0,206259
 batplot/manual.py,sha256=pbRI6G4Pm12pOW8LrOLWWu7IEOtqWN3tRHtgge50LlA,11556
-batplot/modes.py,sha256=qE2OsOQQKhwOWene5zxJeuuewTrZxubtahQuz5je7ok,37252
-batplot/operando.py,sha256=1i1kb6YKEVXFFKfLWKXr5MwA2hOOQQoVSnT3rgpnWG8,28176
-batplot/operando_ec_interactive.py,sha256=x-Q69AEtuTNYnDlHdgMeHsLeWSIVZ2KCR-hLNV4Kvj0,297027
+batplot/modes.py,sha256=Utfal5IaV8rfoNyNFziUZpqRlpZAWJdiTc45DY-FJE8,37300
+batplot/operando.py,sha256=p2Ug1mFUQxaU702cTBGgJKb3_v1C2p3LLUwfXaVBpPY,28311
+batplot/operando_ec_interactive.py,sha256=TMB6rDpeolX0CgE2V7tWC24ffJrnbJomQSnTsTd8CNQ,305121
 batplot/plotting.py,sha256=hG2_EdDhF1Qpn1XfZKdCQ5-w_m9gUYFbr804UQ5QjsU,10841
 batplot/readers.py,sha256=kAI0AvYrdfGRZkvADJ4riN96IWtrH24aAoZpBtONTbw,112960
-batplot/session.py,sha256=xwEcCM0r_gehJdNZdSUT4Kj5joN9rZ7WsAReetcNFiw,133244
+batplot/session.py,sha256=05JsVi0ygMzOxVRRZ4klhE5Eh6eE6QxKR8p7_j6slBI,134429
 batplot/style.py,sha256=ig1ozX4dhEsXf5JKaPZOvgVS3CWx-BTFSc3vfAH3Y-E,62274
 batplot/ui.py,sha256=ifpbK74juUzLMCt-sJGVaWtpDb1NMRJzs2YyiwwafzY,35302
-batplot/utils.py,sha256=VtCShOPD4Z_cVODBINclfFdD12pLdSe1av9ZAnE27zY,36043
-batplot/version_check.py,sha256=OG4LuHo5-rSqLLHQo5nWbX9lbNq6NyxRdvVUUcJRBqQ,6219
+batplot/utils.py,sha256=LY2-Axr3DsQMTxuXe48vSjrLJKEnkzkZjdSFdQizbpg,37599
+batplot/version_check.py,sha256=ztTHwqgWd8OlS9PLLY5A_TabWxBASDA_-5yyN15PZC8,9996
 batplot/data/USER_MANUAL.md,sha256=VYPvNZt3Fy8Z4Izr2FnQBw9vEaFTPkybhHDnF-OuKws,17694
-batplot-1.7.28.dist-info/licenses/LICENSE,sha256=2PAnHeCiTfgI7aKZLWr0G56HI9fGKQ0CEbQ02H-yExQ,1065
+batplot-1.8.1.dist-info/licenses/LICENSE,sha256=2PAnHeCiTfgI7aKZLWr0G56HI9fGKQ0CEbQ02H-yExQ,1065
 batplot_backup_20251121_223043/__init__.py,sha256=3s2DUQuTbWs65hoN9cQQ8IiJbaFJY8fNxiCpwRBYoOA,118
 batplot_backup_20251121_223043/args.py,sha256=OH-h84QhN-IhMS8sPAsSEqccHD3wpeMgmXa_fqv5xtg,21215
 batplot_backup_20251121_223043/batch.py,sha256=oI7PONJyciHDOqNPq-8fnOQMyn9CpAdVznKaEdsy0ig,48650
@@ -45,8 +45,8 @@ batplot_backup_20251121_223043/style.py,sha256=xg-tj6bEbFUVjjxYMokiLehS4tSfKanLI
 batplot_backup_20251121_223043/ui.py,sha256=K0XZWyiuBRNkFod9mgZyJ9CLN78GR1-hh6EznnIb5S8,31208
 batplot_backup_20251121_223043/utils.py,sha256=jydA0JxsCWWAudXEwSjlxTG17y2F8U6hIAukAzi1P0g,32526
 batplot_backup_20251121_223043/version_check.py,sha256=vlHkGkgUJcD_Z4KZmwonxZvKZh0MwHLaBSxaLPc66AQ,4555
-batplot-1.7.28.dist-info/METADATA,sha256=AkFH5c-g0mYy7P70j7k9pFdObNP4UIHmMendhUgDwoI,7407
-batplot-1.7.28.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-batplot-1.7.28.dist-info/entry_points.txt,sha256=73GgH3Zs-qGIvgiyQLgGsSW-ryOwPPKHveOW6TDIR5Q,82
-batplot-1.7.28.dist-info/top_level.txt,sha256=CgqK4RpsYnUFAcqO4bLOnEhCoPY4IPEGLPkiDlzLIxg,39
-batplot-1.7.28.dist-info/RECORD,,
+batplot-1.8.1.dist-info/METADATA,sha256=3n6IsXn-SgLaDVHF6t4HCMmzDpf0Tkkbp23Dva98oN8,7406
+batplot-1.8.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+batplot-1.8.1.dist-info/entry_points.txt,sha256=73GgH3Zs-qGIvgiyQLgGsSW-ryOwPPKHveOW6TDIR5Q,82
+batplot-1.8.1.dist-info/top_level.txt,sha256=CgqK4RpsYnUFAcqO4bLOnEhCoPY4IPEGLPkiDlzLIxg,39
+batplot-1.8.1.dist-info/RECORD,,