GUIBRUSHR.core.io package

Submodules

• GUIBRUSHR.core.io.retrieval_io module
  • Public API
  • RetrievalIOError
  • read_general_info()
  • read_general_info_df()
  • write_general_info()
  • read_parameters()
  • write_parameters()
  • ensure_yaml()

Module contents

I/O sub-package: typed readers/writers for retrieval folders.

The canonical persistence format is YAML. Legacy CSV files are still read transparently via lazy on-read conversion so existing retrievals on disk remain analyzable.

Public API (re-exported for convenience):

• read_general_info() / read_general_info_df() / write_general_info() — typed dict <-> df_general_info.yaml

• read_parameters() / write_parameters() — DataFrame <-> df_parameters.yaml

• ensure_yaml() — lazy converter (CSV -> YAML sibling, idempotent)

• RetrievalIOError — raised on schema/file errors