SciTeX IO

Getting Started

  • Installation
    • Requirements
    • Basic Installation
    • With MCP Server
    • Full Installation
    • SciTeX Users
    • Development
  • Quickstart
    • Save and Load
    • List Available Formats
    • Custom Format Registration
    • Project Configuration
    • DotDict
    • Metadata Embedding
    • Auto Path Routing
    • Advanced Save Options
    • Glob and Pattern Matching
    • Caching

User Guide

  • Supported Formats
    • Format Table
    • Two-Tier Registry
    • Optional Dependencies
  • CLI Reference
    • Commands
    • Format Inspection
    • Configuration Inspection
    • API Introspection
    • Shell Completion
  • MCP Server
    • Installation
    • Starting the Server
    • MCP Client Configuration
    • Available Tools
    • Tool Details
    • Diagnostics

Advanced

  • Plugin Registry
    • Architecture
    • How Dispatch Works
    • Registering Handlers
    • Handler Contract
  • Interactive Explorers
    • H5Explorer
    • ZarrExplorer
    • Migration: HDF5 to Zarr
  • Examples
    • Example 1: Basic Save/Load
    • Example 2: Custom Format
    • Example 3: Project Configuration
    • Example 4: DotDict
    • Example 5: Metadata Embedding
    • Part of SciTeX

API Reference

  • scitex_io
    • register_saver()
    • register_loader()
    • get_saver()
    • get_loader()
    • list_formats()
    • unregister_saver()
    • unregister_loader()
    • save()
    • load()
    • load_configs()
    • glob()
    • parse_glob()
    • reload()
    • flush()
    • cache()
    • configure_cache()
    • get_cache_info()
    • clear_load_cache()
    • DotDict
      • DotDict.__init__()
      • DotDict.get()
      • DotDict.to_dict()
      • DotDict.keys()
      • DotDict.values()
      • DotDict.items()
      • DotDict.update()
      • DotDict.setdefault()
      • DotDict.pop()
      • DotDict.copy()
    • save_image()
    • save_text()
    • save_mp4()
    • save_listed_dfs_as_csv()
    • save_listed_scalars_as_csv()
    • save_optuna_study_as_csv_and_pngs()
    • json2md()
    • embed_metadata()
    • read_metadata()
    • has_metadata()
    • Core I/O
      • save()
      • load()
      • load_configs()
      • glob()
      • reload()
      • flush()
      • cache()
    • Registry
      • register_saver()
      • register_loader()
      • get_saver()
      • get_loader()
      • list_formats()
      • unregister_saver()
      • unregister_loader()
    • Cache Control
      • get_cache_info()
      • configure_cache()
      • clear_load_cache()
    • Dict Utilities
      • DotDict
        • DotDict.__init__()
        • DotDict.get()
        • DotDict.to_dict()
        • DotDict.keys()
        • DotDict.values()
        • DotDict.items()
        • DotDict.update()
        • DotDict.setdefault()
        • DotDict.pop()
        • DotDict.copy()
    • Metadata
      • embed_metadata()
      • read_metadata()
      • has_metadata()
    • Explorers
      • H5Explorer
      • ZarrExplorer
SciTeX IO
  • Overview: module code

All modules for which code is available

  • scitex_io._cache
  • scitex_io._flush
  • scitex_io._glob
  • scitex_io._json2md
  • scitex_io._loading._load
  • scitex_io._loading._load_cache
  • scitex_io._loading._load_configs
  • scitex_io._metadata_modules._embed
  • scitex_io._metadata_modules._read
  • scitex_io._metadata_modules._utils
  • scitex_io._registry
  • scitex_io._reload
  • scitex_io._save
  • scitex_io._save_modules._image
  • scitex_io._save_modules._optuna_study_as_csv_and_pngs
  • scitex_io._utils

© Copyright 2024-2026, Yusuke Watanabe.

Built with Sphinx using a theme provided by Read the Docs.