Getting Started
User Guide
Examples
API Reference
generate_biochar()
generate_surface()
generate_biochar_series()
GeneratorConfig
GeneratorConfig.target_num_carbons
GeneratorConfig.size_tolerance
GeneratorConfig.H_C_ratio
GeneratorConfig.H_C_tolerance
GeneratorConfig.O_C_ratio
GeneratorConfig.O_C_tolerance
GeneratorConfig.aromaticity_percent
GeneratorConfig.aromaticity_tolerance
GeneratorConfig.functional_groups
GeneratorConfig.periodic_box
GeneratorConfig.box_size
GeneratorConfig.molecule_name
GeneratorConfig.seed
GeneratorConfig.defect_fraction
GeneratorConfig.max_ether_span
BiocharGenerator
BiocharGenerator.generate()
BiocharGenerator.export_gromacs()
BiocharGenerator.print_summary()
properties()
VALID_FEEDSTOCKS
TemperatureModel
TemperatureModel.predict()
TemperatureModel.aromaticity_from_hc()
TemperatureModel.composition()
TemperatureModel.predict_all()
TemperatureModel.feedstocks
TemperatureModel.provenance
build_model()
compare_models()
SurfaceConfig
SurfaceConfig.target_num_carbons
SurfaceConfig.H_C_ratio
SurfaceConfig.O_C_ratio
SurfaceConfig.functional_groups
SurfaceConfig.aromaticity_percent
SurfaceConfig.pore_type
SurfaceConfig.num_sheets
SurfaceConfig.pore_diameter
SurfaceConfig.max_attempts
SurfaceConfig.min_separation
SurfaceConfig.sheet_overrides
SurfaceConfig.box_padding_xy
SurfaceConfig.box_padding_z
SurfaceConfig.system_name
SurfaceConfig.sheet_base_name
SurfaceConfig.seed
SurfaceConfig.defect_fraction
SheetResult
SheetResult.mol
SheetResult.coords
SheetResult.composition
SheetResult.atom_types
SheetResult.charges
SheetResult.molecule_name
SurfaceBuilder
SurfaceBuilder.build()
SurfaceBuilder.export_gromacs()
GromacsExporter
GromacsExporter.export()
GROFileWriter
GROFileWriter.write()
TOPFileWriter
TOPFileWriter.write()
ITPFileWriter
ITPFileWriter.write()
MultiSheetGROWriter
MultiSheetGROWriter.write()
SurfaceTopologyWriter
SurfaceTopologyWriter.write()
AtomTyper
AtomTyper.assign_atom_types()
AtomTyper.get_bond_parameters()
AtomTyper.get_angle_parameters()
ChargeAssigner
ChargeAssigner.assign_charges()
get_atom_mass()
get_vdw_radius()
get_covalent_radius()
Development
Bases: object
object
Assign OPLS-AA atom types based on chemical environment.
Assign OPLS-AA atom types to all atoms.
mol – RDKit molecule
Dict[int, str]
Dict
int
str
Dictionary of {atom_idx – opls_type}
mol (Mol)
Get bond parameters for atom type pair.
Optional[Tuple[float, float]]
Optional
Tuple
float
(force_constant_kcal_mol_A2, equilibrium_length_A)
atom_type_1 (str)
atom_type_2 (str)
Get angle parameters for atom type triple.
(force_constant_kcal_mol_rad2, equilibrium_angle_deg)
atom_type_3 (str)
Assign partial charges to atoms using OPLS-AA parameters.
Strategy: Use predefined OPLS charges, with adjustments for unusual groups.
Assign partial charges to all atoms.
atom_types – Dictionary of {atom_idx: opls_type}
Dict[int, float]
Dictionary of {atom_idx – charge}
atom_types (Dict[int, str])