Skip to content

Setup

LST calculation setup functions for parsing, tracking, and spectra.

Functions

parsing_setup

1
2
3
from lst_tools import parsing_setup

parsing_setup(config)

Set up the parsing step (initial frequency/wavenumber sweep).

lst_tools.setup.parsing_setup 

parsing_setup(*, cfg: Mapping[str, Any] | None = None, out_dir: str | Path = '.', out_name: str = 'lst_input_parsing.dat', auto_fill: bool = False, force: bool = False, cfg_path: str | Path | None = None) -> Path

Create a minimal parsing case in out_dir.

Parameters:

Name Type Description Default
cfg Mapping[str, Any]

Already-loaded configuration dictionary.

 None
out_dir str | Path

Directory to write the input deck into. Created if missing.

 '.'
out_name str

File name for the input deck (default: "lst_input_parsing.dat").

 'lst_input_parsing.dat'
auto_fill bool

When True, derive x_s, x_e, and i_step from the meanflow binary for any fields that are still None.

 False
cfg_path str | Path

Path to the config file on disk. Used by --auto-fill to write the updated config back so the user can inspect it.

 None

Returns:

Name Type Description
Path Path

Path to the written input deck.

tracking_setup

1
2
3
from lst_tools import tracking_setup

tracking_setup(config)

Set up the tracking step (spatial marching along disturbance trajectories).

lst_tools.setup.tracking_setup 

tracking_setup(*, cfg: Mapping[str, Any] | None = None, fname_parsing: str | None = None, debug_path: Path | str | None = None, auto_fill: bool = False, force: bool = False, cfg_path: str | Path | None = None, finit: float | None = None, case_reporter: Callable[[str, float], None] | None = None) -> Path

Set up eigenvalue tracking cases for all requested beta values.

Pipeline
  • Resolve and validate configuration
  • Auto-fill unset sweep parameters (if requested)
  • Read parsing solution and baseflow data
  • Determine beta values to track
  • For each beta: scaffold directory, find initial guess, write input deck and HPC script
  • Write a launcher script to submit all jobs

spectra_setup

1
2
3
from lst_tools import spectra_setup

spectra_setup(config)

Set up spectra calculations at multiple streamwise locations.

lst_tools.setup.spectra_setup 

spectra_setup(*, cfg: Mapping[str, Any] | None = None) -> list[Path]

Set up spectral analysis calculations for LST solver.

Creates LST input decks configured for spectral analysis at streamwise locations specified in the configuration file with frequency and wavenumber ranges from [lst.params].

Parameters:

Name Type Description Default
cfg Mapping[str, Any]

Configuration dictionary. If None, will search for and load lst.cfg.

 None

Returns:

Type Description
list[Path]

list[Path]: Paths to the written input decks.