Esc

    The API is under testing and may change before release.

    Load the desk sheets

    You'll make the examples on the reference and explanation pages run on your machine. Those examples read their quotes from the desk sheets, a small module of plain market data that every page shares, so you load it once and then copy any example as it stands.

    Before you start

    You need helixio installed (see Install helixio and check it runs) and a clone of this documentation repository. The desk sheets hold data only: dates, quote sheets, fixing prints, one trade confirmation and the roster of fictional banks the examples trade with. They don't depend on helixio, so loading them changes nothing about how the library behaves.

    The names you can import are:

    Name What it holds
    SOFR_CLOSE_DATE the close the examples mark their markets at
    USD_SOFR_CLOSE USD SOFR swap quotes at that close
    USD_SOFR_LADDER the same close across deposits, a policy meeting, futures and swaps
    USD_SOFR_PRINTS SOFR fixings before the close
    EUR_CLOSE €STR and EURIBOR 3M swap quotes at the close
    USD_CLOSE_MARCH, EUR_CLOSE_MARCH the same markets on an earlier date
    FPML_VANILLA_SWAP a five-year EUR swap confirmation between two fictional banks
    PARTIES the fictional banks the examples name

    Steps

    1. Find the module in your clone

    Both languages read the same values. Python's module is tools/desk_sheets.py at the root of your clone. Rust's crate, helixio-docs-sheets, is generated from it at lines/0.0/_examples/rust/sheets.

    2. Load it in your project

    === "Python"

    Copy the module next to your script, or put the clone's `tools/` folder on your path:
    
    ```bash
    cp ../helixio-docs/tools/desk_sheets.py .
    # or
    export PYTHONPATH="../helixio-docs/tools:$PYTHONPATH"
    ```
    
    An example then imports what it uses, for instance
    `from desk_sheets import EUR_CLOSE, SOFR_CLOSE_DATE`.

    === "Rust"

    Add the crate to your `Cargo.toml` as a path dependency, beside `helixrs`:
    
    ```toml
    [dependencies]
    helixio-docs-sheets = { path = "../helixio-docs/lines/0.0/_examples/rust/sheets" }
    ```
    
    An example then imports what it uses, for instance
    `use helixio_docs_sheets::{EUR_CLOSE, SOFR_CLOSE_DATE};`.

    Adjust ../helixio-docs to wherever your clone lives.

    3. Run an example

    Copy the quick example from any reference page, such as the forward-rate agreement, and run it as it stands.

    Check it worked

    • In Rust, cargo build finds helixio-docs-sheets, and the example prints the same output the page shows.
    • In Python, python -c "from desk_sheets import SOFR_CLOSE_DATE; print(SOFR_CLOSE_DATE)" prints 2026-10-01.

    If the import fails, the path points somewhere other than your clone. If the output differs from the page, your helixio build isn't the one these pages pin; see Install helixio and check it runs.

    • Forward-rate agreement, a reference page whose example uses the desk sheets.
    • Quote sheets and recipes, for what a quote sheet holds and how a market is built from one.
    • Tutorials and how-to guides state their quotes inline, so they don't need this step.

    From the 0.0 line at revision bf7f2e2. Every printed number is that revision's own output.