bbprepared.Ensemble

class bbprepared.Ensemble(base_molecule)[source]

Bases: object

Methods

add_conformer

get_base_molecule

get_conformer

get_conformers

get_lowest_energy_conformer

Get the lowest energy conformer based on a calculator.

get_molecule_num_atoms

get_num_conformers

optimise_conformers

Get a new ensemble with optimised conformers.

yield_conformers

Parameters:

base_molecule (BuildingBlock)

add_conformer(conformer)[source]
Parameters:

conformer (Conformer)

Return type:

None

get_base_molecule()[source]
Return type:

BuildingBlock

get_conformer(idx)[source]
Parameters:

idx (int)

Return type:

Conformer

get_conformers()[source]
Return type:

dict[int, Conformer]

get_lowest_energy_conformer(calculator)[source]

Get the lowest energy conformer based on a calculator.

The calculator must be a callable that returns a value.

Parameters:

calculator (EnergyCalculator)

Return type:

Conformer

get_molecule_num_atoms()[source]
Return type:

int

get_num_conformers()[source]
Return type:

int

optimise_conformers(optimiser)[source]

Get a new ensemble with optimised conformers.

Parameters:

optimiser (Optimiser)

Return type:

Ensemble

yield_conformers()[source]
Return type:

Iterator[Conformer]