stilt.index.SimulationIndex.register

SimulationIndex.register(pairs, receptor=None, footprint_names=None, scene_id=None)

Register one or many simulations as known rows in the index.

Return type:

None

Parameters:

• pairs (str | tuple[str, Receptor] | list[tuple[str, Receptor]])

• receptor (Receptor | None)

• footprint_names (list[str] | None)

• scene_id (str | None)