Skip to main content
Ctrl+K

graintrace

  • Getting started
  • Tutorials
  • Algorithms & theory
  • Guides
  • API reference
  • GitHub
  • Getting started
  • Tutorials
  • Algorithms & theory
  • Guides
  • API reference
  • GitHub

Section Navigation

  • Installation
  • Quickstart
  • Concepts & data formats
  • File formats
  • Getting started

Getting started#

Install graintrace, run a first pure-Python example, and learn the pipeline and data formats.

  • Installation
    • Requirements
    • Tier 1: Python only
    • Tier 2: NEML2 features without CPFE
    • Tier 3: Full CPFE
    • Checking what you actually have
    • External compiled stack (single PUMA submodule)
    • CUBIT/SCULPT (proprietary; bring your own license)
    • NEPER and gmsh
  • Quickstart
    • Load CPFE output
    • Plot a macroscopic stress-strain curve
    • Identify rare events
    • Next steps
  • Concepts & data formats
    • The pipeline
    • Data types
    • Orientations
    • Meshing
  • File formats
    • Experimental input
    • Reconstruction output
    • Mesh
    • Simulation output
    • Analysis output
    • Shipped datasets
    • See also

previous

graintrace

next

Installation

Show Source

© Copyright 2026, Argonne National Laboratory.

Built with the PyData Sphinx Theme 0.23.0.