Configuration¶
Pipeline behaviour is controlled by a config.toml file. User settings are deep-merged on top of the built-in defaults in src/larest/defaults.toml, so you only need to set values that differ from defaults.
A minimal starting point is config/example.config. The full reference is config/reference.toml.
[reaction]¶
The most important section — defines what to compute.
[reaction]
type = "RER" # "RER" (no initiator) or "ROR" (with initiator)
monomers = ["O=C1OCC1"] # list of monomer SMILES
lengths = [2, 3, 4] # polymer chain lengths to evaluate
initiator = "C1=CC=C(C=C1)CO" # initiator SMILES (required for ROR only)
RER (Ring Equilibrium Reaction) requires
lengths >= 2.ROR (Ring-Opening polymerization Reaction) requires
lengths >= 1and aninitiatorSMILES.
[parallelisation]¶
Set the core count once; it propagates to every stage automatically.
[parallelisation]
n_cores = 16
Stage |
Config key set |
CLI flag |
|---|---|---|
RDKit |
|
(internal) |
xTB |
|
|
CREST confgen |
|
|
CREST entropy |
|
|
CENSO |
|
|
Override a specific stage by setting its key directly:
[parallelisation]
n_cores = 16
[censo.cli]
maxcores = 8 # CENSO uses fewer cores (e.g. limited by ORCA memory)
[steps]¶
Toggle individual pipeline stages on or off.
[steps]
rdkit = true # RDKit conformer generation + xTB ranking
crest_confgen = true # CREST conformer ensemble
censo = true # CENSO DFT refinement
crest_entropy = true # CREST conformational entropy correction
xtb = true # xTB re-ranking after rdkit and crest_confgen
[rdkit]¶
Controls MMFF conformer generation.
Key |
Default |
Description |
|---|---|---|
|
|
Number of conformers to generate |
|
|
CPU cores for parallel embedding |
|
|
MMFF variant: |
|
|
Seed for reproducibility |
[xtb]¶
All keys (except etemp) are passed directly as CLI flags to the xtb binary.
Key |
Default |
Description |
|---|---|---|
|
|
Electronic temperature (K); used to derive S = (H − G) / T |
|
|
GFN-xTB method level (0, 1, 2) |
|
|
ALPB implicit solvent |
|
|
Hessian level after optimisation |
|
|
Number of CPU threads |
[crest.confgen] and [crest.entropy]¶
All keys are passed directly as CLI flags to the crest binary. Separate sections control conformer generation and entropy calculation.
Key |
Default |
Description |
|---|---|---|
|
|
Number of CPU threads |
|
Level of theory |
|
|
|
ALPB implicit solvent |
|
|
Energy window for ensemble (kcal/mol) |
|
|
RMSD threshold for deduplication (Å) |
[censo.*]¶
Controls the four CENSO DFT sub-stages. Each sub-stage (prescreening, screening, optimization, refinement) has its own section.
Key |
Description |
|---|---|
|
DFT functional |
|
Basis set |
|
Solvation model ( |
|
Energy window for ensemble pruning (kcal/mol) |
The [censo.general] section sets global CENSO settings:
Key |
Default |
Description |
|---|---|---|
|
|
Temperature (K) |
|
|
Solvent for implicit solvation |
Boolean flags¶
For [xtb] and [crest.*] sections, boolean values are translated to CLI flags:
true→--flagfalse→ flag is omitted entirelyscalar →
--key value