Source code for xpcsviewer

"""XPCS Viewer - X-ray Photon Correlation Spectroscopy data analysis tool.

This package provides both a graphical user interface (GUI) and command-line
interface (CLI) for analyzing XPCS data stored in HDF5/NeXus format.

Main Components:
    XpcsFile: Core data container for XPCS datasets with lazy loading
    XpcsViewer: PySide6-based GUI for interactive analysis
    ViewerKernel: Backend for data processing and plot management
    FileLocator: File discovery and management utilities

Entry Points:
    xpcsviewer-gui: Launch the graphical interface
    xpcsviewer: CLI for batch processing (e.g., twotime analysis)

Example:
    >>> from xpcsviewer import XpcsFile
    >>> xf = XpcsFile('data.h5')
    >>> print(f"Analysis type: {xf.atype}")
"""

# Handle imports gracefully for documentation builds
import os
from importlib.metadata import PackageNotFoundError, version
from typing import TYPE_CHECKING

if os.environ.get("BUILDING_DOCS") and not TYPE_CHECKING:
    # Provide placeholder classes for documentation builds
    class XpcsFile:
        """Placeholder XpcsFile class for documentation builds."""

    class FileLocator:
        """Placeholder FileLocator class for documentation builds."""

    class ViewerKernel:
        """Placeholder ViewerKernel class for documentation builds."""

    class ViewerUI:
        """Placeholder ViewerUI class for documentation builds."""

    class XpcsViewer:
        """Placeholder XpcsViewer class for documentation builds."""

    # Create module-like objects for subpackages (need __name__ for Sphinx autodoc)
    import types

    module = types.ModuleType("xpcsviewer.module")
    plothandler = types.ModuleType("xpcsviewer.plothandler")
    utils = types.ModuleType("xpcsviewer.utils")

else:
    try:
        from xpcsviewer import module, plothandler, utils
        from xpcsviewer.file_locator import FileLocator
        from xpcsviewer.viewer_kernel import ViewerKernel
        from xpcsviewer.viewer_ui import Ui_mainWindow as ViewerUI
        from xpcsviewer.xpcs_file import XpcsFile as XpcsFile  # Explicit re-export
        from xpcsviewer.xpcs_viewer import XpcsViewer
    except ImportError:
        # For documentation builds where dependencies may not be available
        if not TYPE_CHECKING:



            class XpcsFile:
                """Placeholder XpcsFile class for documentation builds."""




            class FileLocator:
                """Placeholder FileLocator class for documentation builds."""




            class ViewerKernel:
                """Placeholder ViewerKernel class for documentation builds."""




            class ViewerUI:
                """Placeholder ViewerUI class for documentation builds."""




            class XpcsViewer:
                """Placeholder XpcsViewer class for documentation builds."""



# Version handling
try:
    __version__ = version("xpcsviewer")
except PackageNotFoundError:
    __version__ = "0.1.8"  # Fallback if package is not installed

__author__ = "Miaoqi Chu & Wei Chen"
__credits__ = "Argonne National Laboratory"