API documentation
Submodules
- site_analysis.atom
- site_analysis.builders
TrajectoryBuilderTrajectoryBuilder.build()TrajectoryBuilder.reset()TrajectoryBuilder.with_commitment()TrajectoryBuilder.with_dynamic_voronoi_sites()TrajectoryBuilder.with_existing_atoms()TrajectoryBuilder.with_existing_sites()TrajectoryBuilder.with_min_atom_distance()TrajectoryBuilder.with_mobile_species()TrajectoryBuilder.with_polyhedral_sites()TrajectoryBuilder.with_reference_structure()TrajectoryBuilder.with_site_mapping()TrajectoryBuilder.with_spherical_sites()TrajectoryBuilder.with_structure()TrajectoryBuilder.with_structure_alignment()TrajectoryBuilder.with_voronoi_sites()
create_trajectory_with_dynamic_voronoi_sites()create_trajectory_with_polyhedral_sites()create_trajectory_with_spherical_sites()create_trajectory_with_voronoi_sites()
- site_analysis.distances
- site_analysis.dynamic_voronoi_site
DynamicVoronoiSiteDynamicVoronoiSite.reference_indicesDynamicVoronoiSite.centre_coordsDynamicVoronoiSite.reference_centerDynamicVoronoiSite.as_dict()DynamicVoronoiSite.calculate_centre()DynamicVoronoiSite.centreDynamicVoronoiSite.cnDynamicVoronoiSite.contains_point()DynamicVoronoiSite.coordination_numberDynamicVoronoiSite.from_dict()DynamicVoronoiSite.reset()DynamicVoronoiSite.sites_from_reference_indices()
- site_analysis.dynamic_voronoi_site_collection
- site_analysis.faces
- site_analysis.neighbour_search
- site_analysis.pbc_utils
- site_analysis.polyhedral_site
PolyhedralSitePolyhedralSite.vertex_indicesPolyhedralSite.reference_centerPolyhedralSite.as_dict()PolyhedralSite.assign_vertex_coords()PolyhedralSite.centrePolyhedralSite.cnPolyhedralSite.contains_atom()PolyhedralSite.contains_point()PolyhedralSite.coordination_numberPolyhedralSite.delaunayPolyhedralSite.fix_triangles()PolyhedralSite.from_dict()PolyhedralSite.get_vertex_species()PolyhedralSite.notify_structure_changed()PolyhedralSite.reset()PolyhedralSite.sites_from_vertex_indices()PolyhedralSite.vertex_coords
- site_analysis.polyhedral_site_collection
PolyhedralSiteCollectionPolyhedralSiteCollection.sitesPolyhedralSiteCollection.analyse_structure()PolyhedralSiteCollection.assign_site_occupations()PolyhedralSiteCollection.find_shared_faces()PolyhedralSiteCollection.neighbouring_sites()PolyhedralSiteCollection.shared_faces()PolyhedralSiteCollection.site_adjacency()PolyhedralSiteCollection.sites_contain_points()PolyhedralSiteCollection.validate_atom_count()
construct_neighbouring_sites()
- site_analysis.reference_workflow
ReferenceBasedSitesReferenceBasedSites.reference_structureReferenceBasedSites.target_structureReferenceBasedSites.aligned_structureReferenceBasedSites.translation_vectorReferenceBasedSites.alignment_metricsReferenceBasedSites.create_dynamic_voronoi_sites()ReferenceBasedSites.create_polyhedral_sites()ReferenceBasedSites.mapped_reference_frac_coords()
StructureAlignerCoordinationEnvironmentFinderIndexMapperSiteFactory
- site_analysis.site
SiteSite.indexSite.contains_atomsSite.trajectorySite.pointsSite.transitionsSite.as_dict()Site.average_occupationSite.centreSite.contains_atom()Site.contains_point()Site.coordination_numberSite.from_dict()Site.most_frequent_transitions()Site.reset()Site.reset_index()Site.residence_times()Site.summary()
- site_analysis.site_collection
PriorityAssignmentMixinSiteCollectionSiteCollection.sitesSiteCollection.analyse_structure()SiteCollection.assign_site_occupations()SiteCollection.neighbouring_sites()SiteCollection.reset()SiteCollection.reset_site_occupations()SiteCollection.site_by_index()SiteCollection.sites_contain_points()SiteCollection.summaries()SiteCollection.update_occupation()
- site_analysis.spherical_site
- site_analysis.spherical_site_collection
- site_analysis.tools
- site_analysis.trajectory
TrajectoryTrajectory.analyse_structure()Trajectory.append_timestep()Trajectory.assign_site_occupations()Trajectory.atTrajectory.atom_by_index()Trajectory.atom_sitesTrajectory.atoms_trajectoryTrajectory.commitment_radiusTrajectory.committed_sitesTrajectory.find_shared_faces()Trajectory.geometric_sitesTrajectory.geometric_trajectoryTrajectory.reset()Trajectory.shared_faces()Trajectory.site_adjacency()Trajectory.site_by_index()Trajectory.site_coordination_numbers()Trajectory.site_labels()Trajectory.site_occupationsTrajectory.site_summaries()Trajectory.sites_trajectoryTrajectory.stTrajectory.trajectory_from_structures()Trajectory.transition_counts_by_label()Trajectory.transition_counts_by_site()Trajectory.transition_events()Trajectory.transition_probabilities_by_label()Trajectory.transition_probabilities_by_site()Trajectory.write_site_summaries()
- site_analysis.transition_events
- site_analysis.transition_table
- site_analysis.voronoi_site
- site_analysis.voronoi_site_collection