Skip to main content

Library Reference

Welcome to the catalog of Aleph’s built-in and platform-provided functionality. This section complements the Language Reference by describing every module, type, function, and constant you can call from Aleph on the Kothar platform. Use it as your encyclopedia when you need exact signatures, detailed documentation, or examples for a specific API.

How this reference is organized​

  • Module landing pages provide an overview, key concepts, and navigation to detailed entries.
  • Nested directories group related topics: Constants/ for global variables, Functions/ for callable routines, Types/ for data structures, and Symbols/ for custom operator semantics.
  • Per-item pages follow a consistent template that lists signatures, arguments, return values, examples, and edge cases.

Every page is written so you can jump directly to it—links include relative paths that mirror Aleph’s module layout. If you are reading offline, follow the breadcrumbs in the sidebar to move between levels.

Where to start​

If you are new to the ecosystem, we recommend this path:

  1. Read the Standard Library overview to learn the foundational containers, math helpers, and language primitives that ship with Aleph.
  2. Explore domain packages that match your workload—scientific computing, quantum simulation, data ingestion, or performance tooling.
  3. Check the Forge Environment documentation when you integrate with the Kothar execution environment and need lifecycle or concurrency details.

Pair these docs with the tutorials in learning/ when you prefer step-by-step guidance, and with the Language Reference when you need syntax explanations or semantics.

Module map​

  • Core language support
    • Standard Library — Standard containers, control primitives, and error types.
    • Math — Built in math functions, helpers, and features in aleph.
  • Platform
    • Forge Environment — Execution environment hooks, concurrency primitives, and diagnostics.
  • Data handling
    • Data Files — Read, write, and modify output data files.
  • Numerics and simulation
    • Quantum Toolkit — Quantum many-body physcis framework with high-level algorithms.
    • Tensor — Multidimensional array library.
    • Scientific Library — Optimization routines for scientific and engineering workloads.
    • Linear Algebra — Linear algebra decompositions and functionality.

New modules join the reference as the platform grows. Each addition follows the same navigation pattern, so you can skim the index above to discover what is available today.