Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
NequIP documentation
Logo

Contents:

  • Welcome to NequIP
  • User Guide
    • Getting Started
      • Installation
      • The NequIP Workflow
      • File Types
    • Configuration
      • Config File
      • Data Configuration
      • Model Hyperparameters
      • Loss and Metrics
    • Training Techniques
      • Fine-Tuning
      • Multitask Training
      • Weights and Biases Sweeps
    • Accelerations
      • PyTorch 2.0 Compiled Training
      • Distributed Data Parallel Training
      • GPU Kernel Modifiers
        • OpenEquivariance Acceleration
        • CuEquivariance Acceleration
      • Precision Settings
    • Reference
      • Conventions
      • FAQs
      • PyTorch Version Compatibility
      • Troubleshooting
  • Python API
    • nequip.data
      • Data Fields
      • nequip.data.datamodule
      • nequip.data.dataset
      • nequip.data.transforms
      • Data Modifiers
      • Dataset Statistics
    • nequip.train
      • NequIPLightningModule
      • Loss Function and Error Metrics
      • nequip.train.callbacks
      • nequip.train.SimpleDDPStrategy
    • nequip.nn
    • nequip.model
      • NequIP Message Passing GNN Models
      • Saved Models
    • nequip.integrations.ase
    • nequip.integrations.torchsim
  • Integrations
    • LAMMPS
      • pair_nequip_allegro
      • ML-IAP
    • ASE
    • torch-sim
    • OpenMM
  • Developer Guide
    • Contributing to NequIP
    • Understanding the NequIP Framework
      • NequIP Workflows
        • Model Packaging
    • Extension Packages
      • Getting Started
      • Data Handling
      • Training Techniques
      • Custom Models
      • Inference
    • Building Docs Locally
Back to top
View this page

Getting StartedΒΆ

Framework-level information for using NequIP.

  • Installation
  • The NequIP Workflow
  • File Types
Next
Installation
Previous
User Guide
Copyright © 2025 The NequIP Developers
Made with Sphinx and @pradyunsg's Furo