seismicrna.renumct package

Submodules

seismicrna.renumct.main.run(*, ct_pos_5: Iterable[tuple[str, int]] = (), inplace: bool = False, out_dir: str | Path = './out', force: bool = False, max_procs: int = 4)

Renumber connectivity table (CT) files given a 5’ position.

Parameters:

• ct_pos_5 (Iterable) – Connectivity table (CT) file or directory of CT files and the 5’ position to assign to each file [keyword-only, default: ()]

• inplace (bool) – Modify files in-place instead of writing new files (CAUTION: you cannot recover the original files afterwards) [keyword-only, default: False]

• out_dir (str | pathlib._local.Path) – Write all output files to this directory [keyword-only, default: ‘./out’]

• force (bool) – Force all tasks to run, overwriting any existing output files [keyword-only, default: False]

• max_procs (int) – Run up to this many processes simultaneously [keyword-only, default: 4]