3. Components

This chapter contains a description of all components (classes, functions, decorators) that can be used within ParAMS scripts. In each part you can find API specification of a particular component, an explanation of its role in the whole environment and examples of its usage.

• 3.1. Architecture Quick Reference
• 3.2. Collections
  • 3.2.1. Job Collection
    • 3.2.1.1. Adding Jobs
    • 3.2.1.2. Working with the Collection
    • 3.2.1.3. I/O
    • 3.2.1.4. Generating AMSJobs
    • 3.2.1.5. Running Collection Jobs
  • 3.2.2. Engine Collection
  • 3.2.3. Collections API
    • 3.2.3.1. JCEntry
    • 3.2.3.2. JobCollection
    • 3.2.3.3. Engine
    • 3.2.3.4. EngineCollection
    • 3.2.3.5. Collection Base Class
• 3.3. Data Set
  • 3.3.1. Adding Entries
  • 3.3.2. Accessing Entries
  • 3.3.3. Removing Entries
  • 3.3.4. Adding External Reference Data
  • 3.3.5. Calculating and Adding Reference Data with AMS
  • 3.3.6. Storage and I/O
  • 3.3.7. Calculating the Loss Function Value
  • 3.3.8. Checking for Consistency with a given Job Collection
  • 3.3.9. Splitting into Subsets
  • 3.3.10. Data Set Entry API
  • 3.3.11. Data Set API
• 3.4. Extractors and Comparators
  • 3.4.1. Supported Data Structures
  • 3.4.2. Custom Comparators
  • 3.4.3. Available Extractors
    • 3.4.3.1. Distance
    • 3.4.3.2. Angles
    • 3.4.3.3. Dihedral
    • 3.4.3.4. RMSD
    • 3.4.3.5. Energy
    • 3.4.3.6. Forces
    • 3.4.3.7. Cell Volume
    • 3.4.3.8. Lattice Parameters
    • 3.4.3.9. Hessian
    • 3.4.3.10. Stress Tensor
    • 3.4.3.11. Charges
    • 3.4.3.12. Vibrational Frequencies
    • 3.4.3.13. PES
    • 3.4.3.14. Compared PES
• 3.5. Parameter Interfaces
  • 3.5.1. Available Parameter Interfaces
    • 3.5.1.1. xTB
      • 3.5.1.1.1. List of parameter names
      • 3.5.1.1.2. XTBParams API
    • 3.5.1.2. ReaxFF
      • 3.5.1.2.1. Full List of Parameter Names
    • 3.5.1.3. SCC-DFTB repulsive potential
      • 3.5.1.3.1. DFTBSplineRepulsivePotentialParams API
      • 3.5.1.3.2. TaperedDoubleExponential API
    • 3.5.1.4. Lennard Jones
  • 3.5.2. Parameter Interface Basics
  • 3.5.3. Working with Parameters
  • 3.5.4. The Active Parameters Subset
  • 3.5.5. Storage
    • 3.5.5.1. Lossless Storage
  • 3.5.6. Relation to PLAMS Settings
  • 3.5.7. Parameter API
  • 3.5.8. Interface Base Class API
• 3.6. Optimizers
  • 3.6.1. CMA-ES
    • 3.6.1.1. List of valid cmasettings
    • 3.6.1.2. References
  • 3.6.2. Scipy
  • 3.6.3. Nevergrad
  • 3.6.4. Adaptive Rate MC
  • 3.6.5. Simple Grid Optimizer
  • 3.6.6. Optimizer Base Class
    • 3.6.6.1. BaseOptimizer API
    • 3.6.6.2. MinimizeResult API
• 3.7. Optimization
  • 3.7.1. Optimization Setup
  • 3.7.2. Optimization API
• 3.8. Parallelization
• 3.9. Constraints
• 3.10. Callbacks
  • 3.10.1. Logger
  • 3.10.2. Timeout
  • 3.10.3. Target Value
  • 3.10.4. Maximum Iterations
  • 3.10.5. Early Stopping
  • 3.10.6. Stopfile
  • 3.10.7. Time per Evaluation
  • 3.10.8. Load Average
  • 3.10.9. User-Defined Callbacks
  • 3.10.10. Callback API
• 3.11. Loss Functions
  • 3.11.1. Least Absolute Error
  • 3.11.2. Mean Absolute Error
  • 3.11.3. Root-Mean-Square Error
  • 3.11.4. Sum of Squares Error
  • 3.11.5. Loss Function API
• 3.12. Utilities
  • 3.12.1. Optimization History
  • 3.12.2. ReaxFF Conversion
  • 3.12.3. Plotting Funcitons
• 3.13. Experimental Features
  • 3.13.1. Active Parameter Search
  • 3.13.2. Data Set Sensitivity