Getting Started
User Guide
Tutorials
Examples
API Reference
CrystalAnalyzer
CrystalAnalyzer.extraction_config
CrystalAnalyzer.csd_ops
CrystalAnalyzer.extractor
CrystalAnalyzer.data_dir
CrystalAnalyzer.__init__()
CrystalAnalyzer.extract_data()
ExtractionConfig
ExtractionConfig.from_json()
ExtractionConfig.data_directory
ExtractionConfig.data_prefix
ExtractionConfig.actions
ExtractionConfig.filters
ExtractionConfig.extraction_batch_size
ExtractionConfig.post_extraction_batch_size
ExtractionConfig.__init__()
load_config()
setup_logging()
parse_args()
run_extraction()
main()
SimilaritySettings
SimilaritySettings.distance_tolerance
SimilaritySettings.angle_tolerance
SimilaritySettings.ignore_bond_types
SimilaritySettings.ignore_hydrogen_counts
SimilaritySettings.ignore_hydrogen_positions
SimilaritySettings.packing_shell_size
SimilaritySettings.ignore_spacegroup
SimilaritySettings.normalise_unit_cell
SimilaritySettings.__init__()
CSDOperations
CSDOperations.data_directory
CSDOperations.data_prefix
CSDOperations.reader
CSDOperations.similarity_engine
CSDOperations.__init__()
CSDOperations.get_refcode_families_df()
CSDOperations.save_refcode_families_csv()
CSDOperations.filter_families_by_size()
CSDOperations.cluster_families()
CSDOperations.get_unique_structures()
CSDOperations._check_structure()
CSDOperations._save_unique_structures()
_process_single_family()
_representative_for_cluster()
StructureDataExtractor
StructureDataExtractor.hdf5_path
StructureDataExtractor.filters
StructureDataExtractor.batch_size
StructureDataExtractor.reader
StructureDataExtractor.__init__()
StructureDataExtractor.run()
_extract_one()
CrystalParams
CrystalParams.cell_lengths
CrystalParams.cell_angles
CrystalParams.count()
CrystalParams.index()
AtomParams
AtomParams.labels
AtomParams.symbols
AtomParams.coords
AtomParams.frac_coords
AtomParams.mask
AtomParams.weights
AtomParams.charges
AtomParams.count()
AtomParams.index()
BondParams
BondParams.atom1_idx
BondParams.atom2_idx
BondParams.bond_type
BondParams.is_rotatable_raw
BondParams.is_cyclic
BondParams.mask
BondParams.count()
BondParams.index()
InterCCParams
InterCCParams.central_atom
InterCCParams.contact_atom
InterCCParams.central_atom_idx
InterCCParams.contact_atom_idx
InterCCParams.central_atom_frac_coords
InterCCParams.contact_atom_frac_coords
InterCCParams.lengths
InterCCParams.strengths
InterCCParams.in_los
InterCCParams.symmetry_A
InterCCParams.symmetry_T
InterCCParams.symmetry_A_inv
InterCCParams.symmetry_T_inv
InterCCParams.count()
InterCCParams.index()
InterHBParams
InterHBParams.central_atom
InterHBParams.hydrogen_atom
InterHBParams.contact_atom
InterHBParams.central_atom_idx
InterHBParams.hydrogen_atom_idx
InterHBParams.contact_atom_idx
InterHBParams.central_atom_frac_coords
InterHBParams.hydrogen_atom_frac_coords
InterHBParams.contact_atom_frac_coords
InterHBParams.lengths
InterHBParams.angles
InterHBParams.in_los
InterHBParams.symmetry_A
InterHBParams.symmetry_T
InterHBParams.symmetry_A_inv
InterHBParams.symmetry_T_inv
InterHBParams.count()
InterHBParams.index()
StructurePostExtractionProcessor
StructurePostExtractionProcessor.__init__()
StructurePostExtractionProcessor.run()
StructurePostExtractionProcessor._compute_rigid_fragments()
StructurePostExtractionProcessor._compute_fragment_com_centroid()
StructurePostExtractionProcessor._expand_inter_contacts()
StructurePostExtractionProcessor._flag_hbond_contacts()
StructurePostExtractionProcessor._identify_contact_fragments()
StructurePostExtractionProcessor._compute_contact_com_vectors()
compute_distances_to_crystallographic_planes_frac_batch()
compute_angles_between_bonds_and_crystallographic_planes_frac_batch()
compute_atom_vectors_to_point_batch()
compute_bond_rotatability_batch()
compute_bond_angles_batch()
compute_torsion_angles_batch()
compute_quaternions_from_rotation_matrices()
compute_global_steinhardt_order_parameters_batch()
compute_best_fit_plane_batch()
compute_planarity_metrics_batch()
compute_fragment_pairwise_vectors_and_distances_batch()
identify_rigid_fragments_batch()
prepare_fragments_batch()
compute_center_of_mass_batch()
compute_centroid_batch()
compute_inertia_tensor_batch()
compute_quadrupole_tensor_batch()
compute_symmetric_contacts_batch()
compute_symmetric_hbonds_batch()
compute_contact_is_hbond()
compute_contact_fragment_indices_batch()
compute_contact_atom_to_central_fragment_com_batch()
compute_scaled_cell()
compute_cell_matrix_batch()
parse_sym_op()
invert_sym_op()
add_symmetry_matrices()
add_inter_cc_symmetry()
add_inter_hb_symmetry()
RawDataReader
RawDataReader.h5_in
RawDataReader.read_crystal_parameters()
RawDataReader.read_atoms()
RawDataReader.read_bonds()
RawDataReader.read_intermolecular_contacts()
RawDataReader.read_intermolecular_hbonds()
RawDataReader.read_intramolecular_contacts()
RawDataReader.read_intramolecular_hbonds()
RawDataReader.__init__()
RawDataWriter
RawDataWriter.h5_out
RawDataWriter.write_raw_crystal_data()
RawDataWriter.write_raw_atom_data()
RawDataWriter.write_raw_bond_data()
RawDataWriter.write_raw_intramolecular_contact_data()
RawDataWriter.write_raw_intramolecular_hbond_data()
RawDataWriter.__init__()
ComputedDataWriter
ComputedDataWriter.h5_out
ComputedDataWriter.write_computed_crystal_data()
ComputedDataWriter.write_computed_atom_data()
ComputedDataWriter.write_computed_bond_data()
ComputedDataWriter.write_computed_molecule_data()
ComputedDataWriter.write_computed_intermolecular_contact_data()
ComputedDataWriter.write_computed_intermolecular_hbond_data()
ComputedDataWriter.__init__()
ComputedDataWriter.write_computed_fragment_data()
initialize_hdf5_file()
write_structure_group()
scan_max_dimensions()
Technical Details