stringforge.vulcan.VulcanReader

Contents

stringforge.vulcan.VulcanReader#

class stringforge.vulcan.VulcanReader(*, source, cache_size=32, token=None)#

Bases: object

Read-side counterpart to stringforge.vulcan.Vulcan.

Builds a Vulcan-shard catalogue by scanning either a local synced/ tree or a HuggingFace dataset repo. Loaded shards are cached in a small in-memory LRU.

A typical local usage pattern:

reader = VulcanReader.from_local(forge.staging_dir)
cat    = reader.catalog()
susy   = reader.query(h12=2, solver_name="newton")

A HuggingFace usage pattern:

reader = VulcanReader.from_hf("user/vacua_forge")
run    = reader.fetch_run("2026-06-01-120000_fluxscan_...")
Parameters:

  • source (_Source) – Internal source tag (use the factories instead).

  • cache_size (int) – LRU capacity in shards.

  • token (Optional[str]) – HuggingFace read token; falls back to HF_TOKEN. Ignored for local sources.

See the module page for the curated public method index. The class page is kept as the canonical object target for cross-references and the general index.

Contents