Public API¶

The names below are gmat-sweep's public API. The API reference renders the signature and docstring of each one.

Anything not listed here is internal: importable, but with no stability guarantee and subject to change between releases.

Top-level surface — `gmat_sweep`¶

Every name below is importable directly from gmat_sweep and appears in gmat_sweep.__all__.

Sweep entry points¶

sweep · monte_carlo · monte_carlo_extend · latin_hypercube · Sweep · parameter_spec_from_runs

Specs, outcomes, and status types¶

RunSpec · SweepSpec · RunOutcome · RunStatus · PostprocessStatus · DistSpec

Grid expansion¶

full_factorial · full_factorial_size · iter_grid_run_specs · expand_grid_to_run_specs · expand_samples_to_run_specs · expand_monte_carlo_to_run_specs · expand_monte_carlo_extension_to_run_specs · expand_latin_hypercube_to_run_specs · latin_hypercube_samples

Manifest¶

Manifest · ManifestEntry · canonical_script_sha256 · MANIFEST_SCHEMA_VERSION

Aggregation¶

sweep_summary · sweep_diff · mc_convergence · lazy_multiindex · lazy_ephemerides · lazy_contacts · lazy_fused_reports · lazy_extra_outputs · lazy_solver_runs · lazy_solver_convergence

Sensitivity¶

sobol_sample · sobol_analyze

Execution backends¶

Pool · LocalJoblibPool

Exceptions¶

GmatSweepError · SweepConfigError · RunFailed · BackendError · ManifestCorruptError

Package metadata¶

__version__

Namespaced surface¶

Two areas are public but reached through a submodule rather than the top-level namespace, so import gmat_sweep stays cheap and the top level stays focused on the core sweep API.

`gmat_sweep.backends` — execution backends¶

Pool and LocalJoblibPool are also re-exported at the top level. The remaining pools are imported from gmat_sweep.backends:

ProcessPoolExecutorPool, DebugPool — no extra required.
DaskPool, RayPool, MPIPool, KubernetesJobPool — each requires its optional extra ([dask], [ray], [mpi], [k8s]).

`gmat_sweep.plotting` — plotting helpers¶

Requires the [plot] extra:

sweep_band_plot · sweep_corner · sweep_heatmap · mc_convergence_plot

Internal modules¶

These modules are importable but carry no stability guarantee. Reach their behaviour through the public surface instead:

gmat_sweep.worker — the per-run worker entry point; backends call it.
gmat_sweep.archive — sweep-archive packing; use Sweep.archive().
gmat_sweep.cli — the command-line entry point; use the gmat-sweep command.
gmat_sweep.distributions — distribution helpers. Only DistSpec is public, and it is re-exported at the top level as gmat_sweep.DistSpec.
gmat_sweep.backends.base — the definition site of Pool. Import Pool from gmat_sweep or gmat_sweep.backends.
gmat_sweep._repr_html, gmat_sweep._run_subprocess, gmat_sweep.backends._subprocess — internal implementation modules.