WarpX Logo
  • Code of Conduct
  • Acknowledge WarpX
  • Science Highlights

INSTALLATION

  • Installation Methods
  • Build from Source
  • HPC Systems

USAGE

  • Run WarpX
  • Examples
  • Inputs: Parameter List
  • Inputs: PICMI Python Script
  • How-To Guides
    • Extend a Simulation with Python
    • Domain Decomposition
    • Visualizing a distribution mapping
    • Debugging the code
    • Generate QED lookup tables using the standalone tool
    • Plot timestep duration
    • Predicting the Number of Guard Cells for PSATD Simulations
    • Archiving
    • Training a Surrogate Model from WarpX Data
    • Optimizing with Optimas
  • FAQ

TUTORIALS

  • Step-by-step examples

DATA ANALYSIS

  • Output formats
  • Read openPMD Data
  • Read AMReX Plotfiles with yt
  • 3D Visualizations
  • In Situ Capabilities
  • How-To Guides

THEORY

  • Overview
  • Models & Algorithms
  • Grid & Geometries
  • Species Representations
  • Boundary Conditions
  • Multiphysics Processes
  • Advanced Modes of Running

DEVELOPMENT

  • Contribute to WarpX
  • Implementation Details
  • C++ Objects & Functions
  • GNUmake Build System (Legacy)
  • How-To Guides
  • FAQ

MAINTENANCE

  • Dependencies & Releases

EPILOGUE

  • Glossary
  • WarpX Governance
  • Funding and Acknowledgements
WarpX
  • How-To Guides
  • View page source

How-To Guides

This section collects typical user workflows and best practices for WarpX.

  • Extend a Simulation with Python
    • Overview
    • How to run a simulation with Python extensions
    • Callback Functions
    • pyAMReX
    • Data Access
    • Diagnostics
    • Modify Solvers
  • Domain Decomposition
    • 1. Simple Method
    • 2. More General Method
    • 3. Performance Considerations
    • 4. Mesh Refinement
  • Visualizing a distribution mapping
    • Generating the data
    • Loading and plotting the data
  • Debugging the code
    • Debugging Workflow
    • Debuggers
    • Typical Error Messages
  • Generate QED lookup tables using the standalone tool
  • Plot timestep duration
  • Predicting the Number of Guard Cells for PSATD Simulations
  • Archiving
    • HPC Systems: HPSS
    • Desktops/Laptops: Cloud Drives
    • Asynchronous File Copies: Globus
    • Scientific Data for Publications
  • Training a Surrogate Model from WarpX Data
    • Data Cleaning
    • Create Normalized Dataset
    • Neural Network Structure
    • Train and Save Neural Network
    • Evaluate
  • Optimizing with Optimas
Previous Next

© Copyright 2017-2021, WarpX collaboration.

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