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
    • Caching

User Guide

  • Supported Formats
    • Format Table
    • Two-Tier Registry
    • Optional Dependencies
  • CLI Reference
    • Commands
    • Format 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
    • 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()
    • H5Explorer
      • H5Explorer.__enter__()
      • H5Explorer.__exit__()
      • H5Explorer.__init__()
      • H5Explorer.close()
      • H5Explorer.explore()
      • H5Explorer.find()
      • H5Explorer.get()
      • H5Explorer.get_dtype()
      • H5Explorer.get_info()
      • H5Explorer.get_shape()
      • H5Explorer.keys()
      • H5Explorer.load()
      • H5Explorer.show()
    • explore_h5()
    • has_h5_key()
    • ZarrExplorer
      • ZarrExplorer.__init__()
      • ZarrExplorer.explore()
      • ZarrExplorer.has_key()
      • ZarrExplorer.keys()
      • ZarrExplorer.load()
      • ZarrExplorer.show()
    • explore_zarr()
    • has_zarr_key()
    • get_cache_info()
    • configure_cache()
    • clear_load_cache()
    • save_image()
    • save_text()
    • save_mp4()
    • save_listed_dfs_as_csv()
    • save_listed_scalars_as_csv()
    • save_optuna_study_as_csv_and_pngs()
    • json2md()
    • migrate_h5_to_zarr()
    • migrate_h5_to_zarr_batch()
    • 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()
    • Explorers
      • H5Explorer
        • H5Explorer.__init__()
        • H5Explorer.__enter__()
        • H5Explorer.__exit__()
        • H5Explorer.close()
        • H5Explorer.explore()
        • H5Explorer.show()
        • H5Explorer.keys()
        • H5Explorer.load()
        • H5Explorer.get()
        • H5Explorer.get_info()
        • H5Explorer.find()
        • H5Explorer.get_shape()
        • H5Explorer.get_dtype()
      • ZarrExplorer
        • ZarrExplorer.__init__()
        • ZarrExplorer.explore()
        • ZarrExplorer.show()
        • ZarrExplorer.keys()
        • ZarrExplorer.load()
        • ZarrExplorer.has_key()
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._load
  • scitex_io._load_cache
  • scitex_io._load_configs
  • scitex_io._load_modules._H5Explorer
  • scitex_io._load_modules._ZarrExplorer
  • 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.h5_to_zarr

© Copyright 2024-2026, Yusuke Watanabe.

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