Skip to main content
Ctrl+K
autoplex - Home autoplex - Home

User Guide

  • Overview
  • Quick-start
  • Tutorials
    • Installation guide
    • RSS workflow
      • Brief overview
      • Input YAML configuration file
      • Quick start
      • Examples
    • Phonon workflow
      • Out-of-the-box workflow
      • Generating reference data
      • Fitting phonon-accurate potentials
      • Benchmark of ML-based phonon structure
    • Executable tutorials
      • Iterative DFT vs MLIP benchmark workflow for phonons
      • RSS Workflow

Reference

  • API reference
    • autoplex.auto
      • autoplex.auto.phonons
        • autoplex.auto.phonons.flows
        • autoplex.auto.phonons.jobs
      • autoplex.auto.rss
        • autoplex.auto.rss.flows
        • autoplex.auto.rss.jobs
    • autoplex.benchmark
      • autoplex.benchmark.phonons
        • autoplex.benchmark.phonons.flows
        • autoplex.benchmark.phonons.jobs
        • autoplex.benchmark.phonons.utils
      • autoplex.benchmark.rss
    • autoplex.data
      • autoplex.data.common
        • autoplex.data.common.flows
        • autoplex.data.common.jobs
        • autoplex.data.common.utils
      • autoplex.data.phonons
        • autoplex.data.phonons.flows
        • autoplex.data.phonons.jobs
        • autoplex.data.phonons.utils
      • autoplex.data.rss
        • autoplex.data.rss.flows
        • autoplex.data.rss.jobs
        • autoplex.data.rss.utils
    • autoplex.fitting
      • autoplex.fitting.common
        • autoplex.fitting.common.flows
        • autoplex.fitting.common.jobs
        • autoplex.fitting.common.regularization
        • autoplex.fitting.common.utils
      • autoplex.fitting.phonons
      • autoplex.fitting.rss
    • autoplex.settings
      • AutoplexBaseModel
      • BcurParams
      • BuildcellOptions
      • CustomIncar
      • GAPGeneralSettings
      • GAPSettings
      • JACESettings
      • LossCoeff
      • M3GNETSettings
      • MACESettings
      • MLIPHypers
      • NEPSettings
      • NEQUIPSettings
      • Nonlinearity
      • ResumeFromPreviousState
      • RssConfig
      • SoapParas
      • SoapSettings
      • ThreebSettings
      • TwobSettings

Contributing Guide

  • Contributing to autoplex
  • Developer Installation

About

  • Changelog
  • Contributors
  • License
  • Repository
  • Open issue
  • .md

RSS workflow

RSS workflow#

This section provides tutorials for the random structure searching (RSS) workflow.

  • Brief overview
    • Features
  • Input YAML configuration file
    • General parameters
    • Buildcell parameters
    • Sampling parameters
    • DFT labelling parameters
    • Data preprocessing parameters
    • MLIP parameters
    • RSS Exploration Parameters
  • Quick start
    • Running the workflow with a RSSConfig object
    • Running the workflow with direct parameter specification
    • Building RSS models with various ML potentials
    • Resuming workflow from point of interruption
    • Expanding pre-existing dataset and refining MLIPs
      • Use case 1: combining an existing dataset with RSS to train a new MLIP
      • Use case 2: kicking off RSS using an existing MLIP and merging data for refinement
      • Use case 3: generating the whole RSS data from scratch and merging later
  • Examples
    • SiO2

previous

Installation guide

next

Brief overview

By Author name not set

© Copyright 2024, autoplex development team.