scitex 2.14.0__py3-none-any.whl → 2.15.3__py3-none-any.whl

scitex/template/_templates/capture.py

@@ -0,0 +1,268 @@
+#!/usr/bin/env python3
+# Timestamp: 2026-01-25
+# File: src/scitex/template/_templates/capture.py
+# ----------------------------------------
+
+"""Template for stx.capture screenshot module usage."""
+
+TEMPLATE = {
+    "name": "Capture Module",
+    "description": "stx.capture usage for screenshots, monitoring, and screen recording",
+    "filename": "capture_script.py",
+    "priority": 6,
+    "content": '''#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Timestamp: {timestamp}
+# File: {filepath}
+
+"""
+stx.capture - Screenshot & Screen Recording
+===========================================
+
+stx.capture provides:
+- Single and multi-monitor screenshots
+- Window-specific capture
+- Continuous monitoring with timestamps
+- Animated GIF creation from sequences
+- Error detection in screenshots
+
+Usage Patterns
+--------------
+1. MCP: capture_* tools for Claude Code integration
+2. Python API: stx.capture.* functions
+3. Useful for: debugging, documentation, testing
+"""
+
+import scitex as stx
+
+# ============================================================
+# Pattern 1: Basic Screenshots (via MCP)
+# ============================================================
+
+"""
+MCP Tools for Claude Code:
+--------------------------
+
+# Capture current monitor
+capture_capture_screenshot()
+
+# Capture specific monitor
+capture_capture_screenshot(monitor_id=1)
+
+# Capture all monitors
+capture_capture_screenshot(all=True)
+
+# Capture specific window by app name
+capture_capture_screenshot(app="Firefox")
+
+# Get screenshot as base64 (for analysis)
+capture_capture_screenshot(return_base64=True)
+
+# Capture with message annotation
+capture_capture_screenshot(message="Before fix")
+"""
+
+# ============================================================
+# Pattern 2: Window Capture
+# ============================================================
+
+"""
+Window-Specific Capture:
+------------------------
+
+# List all visible windows
+capture_list_windows()
+
+# Capture window by handle
+capture_capture_window(window_handle=12345)
+
+# Get system info (monitors, desktops)
+capture_get_info()
+"""
+
+# ============================================================
+# Pattern 3: Continuous Monitoring
+# ============================================================
+
+"""
+Screen Monitoring:
+------------------
+
+# Start continuous capture (1 screenshot/second)
+capture_start_monitoring(interval=1.0, monitor_id=0)
+
+# Start with all monitors
+capture_start_monitoring(capture_all=True, interval=0.5)
+
+# Get monitoring status
+capture_get_monitoring_status()
+
+# Stop monitoring
+capture_stop_monitoring()
+
+# List monitoring sessions
+capture_list_sessions(limit=10)
+"""
+
+# ============================================================
+# Pattern 4: GIF Creation
+# ============================================================
+
+"""
+Animated GIF Creation:
+----------------------
+
+# Create GIF from monitoring session
+capture_create_gif(session_id="xxx", duration=0.5)
+
+# Create GIF from specific images
+capture_create_gif(
+    image_paths=["/path/1.png", "/path/2.png"],
+    output_path="animation.gif",
+    duration=0.3
+)
+
+# Create GIF with frame limit
+capture_create_gif(
+    session_id="xxx",
+    max_frames=50,
+    optimize=True
+)
+"""
+
+# ============================================================
+# Pattern 5: Python API Usage
+# ============================================================
+
+def python_api_example():
+    """Direct Python API for screenshots."""
+    from scitex.capture import (
+        capture_screenshot,
+        start_monitoring,
+        stop_monitoring,
+        create_gif,
+        list_windows,
+    )
+
+    # Take a screenshot
+    result = capture_screenshot(
+        monitor_id=0,
+        quality=85
+    )
+    print(f"Saved to: {{result['path']}}")
+
+    # List windows
+    windows = list_windows()
+    for win in windows:
+        print(f"Window: {{win['title']}} (handle: {{win['handle']}})")
+
+    # Start monitoring
+    start_monitoring(interval=1.0)
+
+    # ... do something ...
+
+    # Stop and create GIF
+    stop_monitoring()
+    create_gif(duration=0.5, output_path="recording.gif")
+
+# ============================================================
+# Pattern 6: With @stx.session (Documentation)
+# ============================================================
+
+@stx.session
+def main(
+    interval=2.0,
+    duration=10,
+    CONFIG=stx.INJECTED,
+    logger=stx.INJECTED,
+):
+    """Capture session for documentation."""
+    from scitex.capture import (
+        capture_screenshot,
+        start_monitoring,
+        stop_monitoring,
+        create_gif,
+    )
+    import time
+
+    # Take initial screenshot
+    result = capture_screenshot(
+        message="Initial state"
+    )
+    stx.io.save(result, CONFIG.SDIR_OUT / "initial.json")
+
+    # Start monitoring
+    logger.info(f"Starting {{duration}}s monitoring...")
+    start_monitoring(
+        interval=interval,
+        output_dir=str(CONFIG.SDIR_OUT / "frames")
+    )
+
+    time.sleep(duration)
+
+    stop_monitoring()
+
+    # Create GIF
+    logger.info("Creating GIF...")
+    create_gif(
+        output_path=str(CONFIG.SDIR_OUT / "recording.gif"),
+        duration=0.5
+    )
+
+    logger.info(f"Recording saved to {{CONFIG.SDIR_OUT}}")
+    return 0
+
+# ============================================================
+# Pattern 7: Error Analysis
+# ============================================================
+
+"""
+Screenshot Analysis:
+--------------------
+
+# Analyze screenshot for errors
+capture_analyze_screenshot(path="/path/to/screenshot.png")
+
+# Returns error indicators like:
+# - Red error dialogs
+# - Error text patterns
+# - Warning indicators
+"""
+
+# ============================================================
+# MCP Tools Reference
+# ============================================================
+
+"""
+MCP Tools:
+----------
+
+Screenshots:
+- capture_capture_screenshot(monitor_id, all, app, url, quality, return_base64)
+- capture_capture_window(window_handle, output_path)
+- capture_list_windows()
+- capture_get_info()
+
+Monitoring:
+- capture_start_monitoring(interval, monitor_id, capture_all)
+- capture_stop_monitoring()
+- capture_get_monitoring_status()
+- capture_list_sessions(limit)
+
+Processing:
+- capture_create_gif(session_id, image_paths, duration, max_frames)
+- capture_analyze_screenshot(path)
+
+Cache:
+- capture_list_recent_screenshots(limit, category)
+- capture_clear_cache(max_size_gb)
+"""
+
+if __name__ == "__main__":
+    main()
+''',
+}
+
+__all__ = ["TEMPLATE"]
+
+# EOF

scitex/template/_templates/config.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+"""YAML configuration file template."""
+
+TEMPLATE = {
+    "name": "Configuration YAML",
+    "description": "YAML configuration file for @stx.session scripts",
+    "filename": "config/config.yaml",
+    "usage": """
+Usage:
+  Place in ./config/ directory
+  Access via CONFIG parameter: CONFIG.config.data.input_dir
+""",
+    "content": """# Configuration file for SciTeX session
+# Place in ./config/ directory (auto-loaded by @stx.session)
+# Access via CONFIG parameter: CONFIG.<filename>.<key>
+# Example: CONFIG.config.data.input_dir (for this file named config.yaml)
+
+# Data paths
+data:
+  input_dir: ./data/raw
+  output_dir: ./data/processed
+
+# Analysis parameters
+analysis:
+  n_samples: 100
+  threshold: 0.05
+  seed: 42
+
+# Figure settings
+figure:
+  dpi: 300
+  format: png
+  width_mm: 180
+  height_mm: 120
+
+# Logging
+logging:
+  level: INFO
+  save_log: true
+""",
+}
+
+# EOF

scitex/template/_templates/diagram.py

@@ -0,0 +1,294 @@
+#!/usr/bin/env python3
+# Timestamp: 2026-01-25
+# File: src/scitex/template/_templates/diagram.py
+# ----------------------------------------
+
+"""Template for stx.diagram module usage."""
+
+TEMPLATE = {
+    "name": "Diagram Module",
+    "description": "stx.diagram usage for creating Mermaid and Graphviz diagrams from YAML specs",
+    "filename": "diagram_script.py",
+    "priority": 7,
+    "content": '''#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Timestamp: {timestamp}
+# File: {filepath}
+
+"""
+stx.diagram - Scientific Diagrams
+=================================
+
+stx.diagram provides:
+- YAML-based diagram specifications
+- Mermaid and Graphviz output
+- Paper-ready presets (workflow, decision, pipeline, scientific)
+- Large diagram splitting for multi-column layouts
+- PNG/SVG/PDF rendering
+
+Usage Patterns
+--------------
+1. MCP: diagram_* tools for Claude Code integration
+2. YAML spec files for reproducible diagrams
+3. Multiple rendering backends (mermaid-cli, graphviz, mermaid.ink)
+"""
+
+import scitex as stx
+
+# ============================================================
+# Pattern 1: YAML Specification
+# ============================================================
+
+"""
+YAML Diagram Specification Format:
+----------------------------------
+
+# diagram_spec.yaml
+metadata:
+  title: "Data Processing Pipeline"
+  paper_mode: single_column  # or double_column, full_page
+
+preset: workflow  # workflow, decision, pipeline, scientific
+
+nodes:
+  - id: input
+    label: "Raw Data"
+    shape: cylinder
+    group: data
+
+  - id: preprocess
+    label: "Preprocessing"
+    shape: box
+    group: processing
+
+edges:
+  - from: input
+    to: preprocess
+    label: "load"
+
+groups:
+  - id: data
+    label: "Data Layer"
+"""
+
+# ============================================================
+# Pattern 2: MCP Tools Usage
+# ============================================================
+
+"""
+MCP Tools for Claude Code:
+--------------------------
+
+# Create diagram from YAML file
+diagram_create(spec_path="/path/to/diagram.yaml")
+
+# Create from dict specification (see Pattern 5 for dict format)
+diagram_create(spec_dict=spec)
+
+# Compile to Mermaid format
+diagram_compile_mermaid(spec_path="diagram.yaml", output_path="diagram.mmd")
+
+# Compile to Graphviz DOT
+diagram_compile_graphviz(spec_path="diagram.yaml", output_path="diagram.dot")
+
+# Render to image
+diagram_render(
+    spec_path="diagram.yaml",
+    output_path="diagram.png",
+    format="png",      # png, svg, pdf
+    backend="auto",    # mermaid-cli, graphviz, mermaid.ink, auto
+    scale=2.0
+)
+
+# List available presets
+diagram_list_presets()
+
+# Get preset configuration
+diagram_get_preset(preset_name="workflow")
+
+# Get paper layout modes
+diagram_get_paper_modes()
+
+# Check rendering backends
+diagram_get_backends()
+"""
+
+# ============================================================
+# Pattern 3: Presets
+# ============================================================
+
+"""
+Available Presets:
+------------------
+
+workflow:
+  - Left-to-right flow
+  - Rounded boxes
+  - Good for process diagrams
+
+decision:
+  - Top-down flow
+  - Diamond decision nodes
+  - Good for flowcharts
+
+pipeline:
+  - Left-to-right flow
+  - Data cylinders
+  - Good for data pipelines
+
+scientific:
+  - Top-down flow
+  - Clean academic style
+  - Good for methods diagrams
+"""
+
+# ============================================================
+# Pattern 4: Large Diagram Splitting
+# ============================================================
+
+"""
+Split Large Diagrams:
+---------------------
+For multi-column layouts, split diagrams into parts:
+
+# Split by groups
+diagram_split(
+    spec_path="large_diagram.yaml",
+    max_nodes_per_part=10,
+    strategy="by_groups"
+)
+
+# Split by articulation points
+diagram_split(
+    spec_path="large_diagram.yaml",
+    strategy="by_articulation"
+)
+"""
+
+# ============================================================
+# Pattern 5: Python API Usage
+# ============================================================
+
+def python_api_example():
+    """Direct Python API for diagrams."""
+    from scitex.diagram import (
+        create_diagram,
+        compile_mermaid,
+        compile_graphviz,
+        render_diagram,
+    )
+
+    # Define specification as dict
+    # Keys: metadata, preset, nodes, edges
+    spec = dict(
+        metadata=dict(title="Simple Pipeline"),
+        preset="pipeline",
+        nodes=[
+            dict(id="a", label="Input"),
+            dict(id="b", label="Process"),
+            dict(id="c", label="Output"),
+        ],
+        edges=[
+            dict(from_="a", to="b"),
+            dict(from_="b", to="c"),
+        ],
+    )
+
+    # Create (returns mermaid and graphviz strings)
+    result = create_diagram(spec_dict=spec)
+    print("Mermaid:")
+    print(result["mermaid"])
+
+    # Compile to file
+    compile_mermaid(spec_dict=spec, output_path="pipeline.mmd")
+
+    # Render to PNG
+    render_diagram(
+        spec_dict=spec,
+        output_path="pipeline.png",
+        format="png",
+        scale=2.0
+    )
+
+# ============================================================
+# Pattern 6: With @stx.session
+# ============================================================
+
+@stx.session
+def main(
+    CONFIG=stx.INJECTED,
+    logger=stx.INJECTED,
+):
+    """Create research methodology diagram."""
+    from scitex.diagram import render_diagram
+
+    # Define methodology using dict() constructor
+    spec = dict(
+        metadata=dict(
+            title="Research Methodology",
+            paper_mode="single_column"
+        ),
+        preset="scientific",
+        nodes=[
+            dict(id="data", label="Data Collection", shape="cylinder"),
+            dict(id="preprocess", label="Preprocessing"),
+            dict(id="features", label="Feature Extraction"),
+            dict(id="model", label="Model Training"),
+            dict(id="eval", label="Evaluation"),
+            dict(id="results", label="Results", shape="cylinder"),
+        ],
+        edges=[
+            dict(from_="data", to="preprocess"),
+            dict(from_="preprocess", to="features"),
+            dict(from_="features", to="model"),
+            dict(from_="model", to="eval"),
+            dict(from_="eval", to="results"),
+        ],
+    )
+
+    # Render diagram
+    output_path = CONFIG.SDIR_OUT / "methodology.png"
+    render_diagram(
+        spec_dict=spec,
+        output_path=str(output_path),
+        format="png",
+        scale=2.0
+    )
+
+    logger.info("Diagram saved to output directory")
+    return 0
+
+# ============================================================
+# MCP Tools Reference
+# ============================================================
+
+"""
+MCP Tools:
+----------
+
+Creation:
+- diagram_create(spec_dict, spec_path)
+- diagram_compile_mermaid(spec_dict, spec_path, output_path)
+- diagram_compile_graphviz(spec_dict, spec_path, output_path)
+
+Rendering:
+- diagram_render(spec_dict, spec_path, output_path, format, backend, scale)
+- diagram_get_backends()
+
+Presets & Layout:
+- diagram_list_presets()
+- diagram_get_preset(preset_name)
+- diagram_get_paper_modes()
+
+Advanced:
+- diagram_split(spec_path, max_nodes_per_part, strategy)
+"""
+
+if __name__ == "__main__":
+    main()
+''',
+}
+
+__all__ = ["TEMPLATE"]
+
+# EOF

scitex/template/_templates/io.py

@@ -0,0 +1,107 @@
+#!/usr/bin/env python3
+"""I/O operations script template."""
+
+TEMPLATE = {
+    "name": "I/O Operations Script",
+    "description": "Demonstrates stx.io.save() and stx.io.load() for 30+ file formats",
+    "filename": "io_script.py",
+    "usage": """
+Usage:
+  python io_script.py
+
+Supported Formats (30+):
+  Data:    csv, json, yaml, pkl, npy, npz, mat, hdf5, parquet, feather
+  Figures: png, jpg, svg, pdf (with metadata embedding)
+  Text:    txt, md, html
+  Config:  yaml, toml, ini
+""",
+    "content": '''#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Timestamp: "{timestamp}"
+# File: {filepath}
+
+"""
+{docstring}
+
+stx.io Usage Guide
+------------------
+stx.io.save(obj, path, **kwargs)  # Universal save
+stx.io.load(path)                  # Universal load
+
+Supported Formats (30+):
+  Data:    csv, json, yaml, pkl, npy, npz, mat, hdf5, parquet, feather
+  Figures: png, jpg, svg, pdf (with metadata embedding)
+  Text:    txt, md, html
+  Config:  yaml, toml, ini
+
+Key Features:
+  - Auto-format detection from extension
+  - Metadata embedding in images
+  - Symlink support for centralized outputs
+  - Automatic CSV export for figures
+"""
+
+import numpy as np
+import pandas as pd
+import scitex as stx
+
+
+@stx.session
+def main(
+    CONFIG=stx.INJECTED,
+    plt=stx.INJECTED,
+    logger=stx.INJECTED,
+):
+    """Demonstrate stx.io save/load operations."""
+
+    # === DataFrame ===
+    df = pd.DataFrame({{"x": [1, 2, 3], "y": [4, 5, 6]}})
+    stx.io.save(df, "data.csv")       # -> CONFIG.SDIR_OUT/data.csv
+    stx.io.save(df, "data.json")
+    stx.io.save(df, "data.parquet")
+
+    # === NumPy Arrays ===
+    arr = np.random.randn(100, 10)
+    stx.io.save(arr, "array.npy")
+    stx.io.save(arr, "array.csv")
+
+    # === Dictionaries ===
+    config = {{"param1": 100, "param2": "value"}}
+    stx.io.save(config, "config.yaml")
+    stx.io.save(config, "config.json")
+
+    # === Figures with Metadata ===
+    fig, ax = plt.subplots()
+    ax.plot_line([1, 2, 3], [1, 4, 9])
+    ax.set_xyt("X", "Y", "Example")
+
+    stx.io.save(
+        fig,
+        "figure.png",
+        metadata={{"experiment": "demo"}},  # Embedded in image
+        symlink_to="./data",                # Create symlink
+        verbose=True,
+    )
+    # Auto-exports: figure.csv (plotted data)
+
+    # === Loading ===
+    df_loaded = stx.io.load(f"{{CONFIG.SDIR_OUT}}/data.csv")
+    arr_loaded = stx.io.load(f"{{CONFIG.SDIR_OUT}}/array.npy")
+    img, meta = stx.io.load(f"{{CONFIG.SDIR_OUT}}/figure.png")
+
+    logger.info(f"Output directory: {{CONFIG.SDIR_OUT}}")
+    logger.info(f"Loaded DataFrame shape: {{df_loaded.shape}}")
+    logger.info(f"Loaded array shape: {{arr_loaded.shape}}")
+    logger.info(f"Image metadata: {{meta}}")
+
+    return 0
+
+
+if __name__ == "__main__":
+    main()
+
+# EOF
+''',
+}
+
+# EOF