mdsuite.calculators.coordination_number_calculation module¶
MDSuite: A Zincwarecode package.
License¶
This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html
SPDX-License-Identifier: EPL-2.0
Copyright Contributors to the Zincwarecode Project.
Contact Information¶
email: zincwarecode@gmail.com github: https://github.com/zincware web: https://zincwarecode.com/
Citation¶
If you use this module please cite us with:
Summary¶
Module to compute coodination numbers.
- class mdsuite.calculators.coordination_number_calculation.Args(savgol_order: int, savgol_window_length: int, number_of_bins: int, number_of_configurations: int, cutoff: float, number_of_shells: int)[source]¶
Bases:
object
Data class for the saved properties.
- class mdsuite.calculators.coordination_number_calculation.CoordinationNumbers(**kwargs)[source]¶
Bases:
Calculator
Class for the calculation of coordination numbers.
- experiment¶
Class object of the experiment.
- Type:
class object
- data_range¶
Range over which the property should be evaluated. This is not applicable to the current analysis as the full rdf will be calculated.
- Type:
int (default=500)
- rdf_data¶
RDF data from the user to use in the computation.
- Type:
Examples
experiment.run.CoordinationNumbers( savgol_order = 2, savgol_window_length = 17 )
- db_computation: db.Computation¶
- experiment: Experiment¶
- experiments: List[Experiment]¶
- rdf_data: Computation¶