Tutorials#
This page collects the executable notebooks in one place. Use it as the main entry point once you want to run code rather than read background material.
Choosing a path#
Run the quickstart notebook before diving into the longer workflows.
Follow the overview notebook to see geometry input, model construction, sampling, refinement, and analysis in one narrative.
Start here for Newton refinement, ISD-biased sampling, and bounded flux searches.
Use these notebooks when you need moduli-space limits, coni-LCS expansions, or one-modulus model data.
Use these notebooks for performance comparisons and literature dataset validation after the core workflows are familiar.
Tutorial catalogue#
Quickstart and reference#
Notebook |
Use it for |
|---|---|
Minimal setup and first run through the package. |
|
Common notation used across the tutorials, including \(W_0\), \(z_{\rm cf}\), \(g_s\), PFV, AFV, ISD, and AISD. |
Basics#
Notebook |
Use it for |
|---|---|
A gentle JAX and automatic-differentiation warm-up in the string-vacua setting. |
|
The main end-to-end orientation notebook for the package. |
|
Moving from CYTools objects to JAXVacua model data. |
|
Moduli, axio-dilaton, flux, and initial-guess sampling. |
Vacuum finding#
Notebook |
Use it for |
|---|---|
Newton refinement and the main SUSY flux-vacuum workflow. |
|
The principle behind ISD-completed flux seeds. |
|
Practical ISD sampling and ensemble generation. |
|
Systematic bounded-flux searches and stochastic variants. |
Geometry and limits#
Notebook |
Use it for |
|---|---|
Large-complex-structure limits, custom period input, and validity checks. |
|
Conifold/LCS expansions and perturbatively flat vacuum pipelines. |
|
Hypergeometric one-modulus examples and closed-form prepotentials. |
Analysis and pipelines#
Notebook |
Use it for |
|---|---|
Reduced EFTs with heavy fields solved away. |
|
Plotting and inspecting vacuum data. |
|
Mass spectra, Hessians, and stability diagnostics. |
|
Distribution-level analysis of vacuum ensembles. |
Advanced and case studies#
Notebook |
Use it for |
|---|---|
Runtime, memory, solver, and sampler comparisons with expensive cells disabled by default. |
|
Local Dataset B and mirror-octic literature checks with full scans left opt-in. |
|
A compact custom-period example connecting attractor points and flux-vacuum notation. |
External workflow tutorials#
The database, vacua-vault, and cluster-parallelisation tutorials have moved to the StringForge umbrella package, which hosts the shared catalogue I/O and storage layer. See the StringForge database and infrastructure tutorials.