Ensemble Analyzer

Scientific Background

  • Theoretical Background

User Guide

  • Installation and Setup
  • Analysis Workflow
  • CLI Tools Reference
  • Protocol Configuration Guide
  • CLI Tools Reference

Tutorial and Examples

  • Quickstart
  • Example 1: Multi-Level Ensemble Refinement
  • Example 2: VCD and ECD Spectra Simulation
  • Example 3: Singlet-Triplet Energy Gap (ΔE S→T)
  • Example 4: Transition State Ensemble Refinement

API Reference

  • API Reference
    • Core & Execution
    • Data Structures
    • Workflow Managers
    • Protocol Configuration
    • Quantum Chemistry Drivers
    • Algorithms & Physics
    • Input/Output & Utilities
    • Logging System
    • CLI Tools
Ensemble Analyzer
  • API Reference
  • View page source

API Reference

This section documents the full API of Ensemble Analyzer, organized by functionality.

Modules

  • Core & Execution
    • main()
  • Data Structures
  • Workflow Managers
  • Protocol Configuration
  • Quantum Chemistry Drivers
    • Calculators
    • Parsers
  • Algorithms & Physics
    • Clustering & PCA
    • Thermochemistry (qRRHO)
    • Spectroscopy & Plotting
  • Input/Output & Utilities
    • SerialiseEncoder
    • mkdir()
    • move_files()
    • tail()
    • write_json()
    • boltzmann_distribution()
    • compute_boltzmann_populations()
    • eV_to_nm()
    • get_models_dir()
    • ordinal()
  • Logging System
    • ColoredFormatter
  • CLI Tools
    • check_gaussian()
    • check_mlip()
    • check_models_dir()
    • check_nwchem()
    • check_orca()
    • check_python_dependencies()
    • check_tblite()
    • log_fail()
    • log_pass()
    • log_warn()
    • main()
    • calculate_population_vector()
    • calculate_weighted_average()
    • get_thermo_data()
    • main()
    • main()
    • parse_argument()
    • Graph Editor
Previous Next

© Copyright 2026, Andrea Pellegrini, Paolo Righi, Andrea Mazzanti, Michele Mancinelli.

Built with Sphinx using a theme provided by Read the Docs.