Tutorials

Tutorials#

This page collects executable quickstart notebooks for the three public member packages. Each is short, self-contained, and runs after a single pip install stringjax (no GPU, no external data). They are entry points – each member package’s own documentation covers its full surface in depth.

Choosing a path#

jaxvacua quickstart

Build a Type IIB flux effective theory from a bundled model, compute the flux superpotential and its derivatives, and find a vacuum.

jaxvacua quickstart
stringforge quickstart

Query the curated CY-database catalogue, load a model in mirror convention, and persist a small vacuum record to the vault.

stringforge quickstart
jaxpolylog quickstart

Evaluate \(\mathrm{Li}_s(z)\) with each of the four approx strategies, benchmark against mpmath, and differentiate to second order.

jaxpolylog quickstart

Notebook catalogue#

Notebook

Use it for

jaxvacua quickstart

The shortest end-to-end run through the Type IIB flux-vacuum engine: model construction, superpotential and F-terms, Newton refinement.

stringforge quickstart

Database catalogue queries, lazy model loading, and a vault round-trip.

jaxpolylog quickstart

The four approximation strategies, accuracy vs mpmath, and arbitrary-order automatic differentiation.

For each member package, the full tutorial library lives in that package’s own documentation:

  • jaxvacua: see the JAXVacua tutorials index (link added when the jaxvacua docs site is public).

  • stringforge: see the stringforge tutorials index (link added when the stringforge docs site is public).

  • jaxpolylog: see the jaxpolylog documentation, in particular the introduction page and the quickstart notebook.